Reference for https://api.silentpassenger.com/rest/v2/{APIKEY}/Alerts2/DestinationAlert
Set up one time arrival/departure alerts. Returns Wrapped response.
Url: https://api.silentpassenger.com/rest/v2/{APIKEY}/Alerts2/DestinationAlert
HTTP Method: POST
| Message direction | Format | Body |
|---|---|---|
| Request | Xml | Example,Schema |
| Request | Json | Example |
| Response | Xml | Example,Schema |
| Response | Json | Example |
The following is an example request Xml body:
<DestinationAlert xmlns="http://schemas.datacontract.org/2004/07/VTS.Business">
<AlertOn>1</AlertOn>
<Destination>
<IsAudited>true</IsAudited>
<AccountNo>String content</AccountNo>
<Category>
<CategoryName>String content</CategoryName>
<LandmarkCategoryID>2147483647</LandmarkCategoryID>
<MobileGroupID>2147483647</MobileGroupID>
<Notes>String content</Notes>
<SymbolNumber>2147483647</SymbolNumber>
</Category>
<City>String content</City>
<ID>2147483647</ID>
<IsRouteOrigin>true</IsRouteOrigin>
<IsVisible>true</IsVisible>
<Latitude>1.26743233E+15</Latitude>
<LocationName>String content</LocationName>
<Longitude>1.26743233E+15</Longitude>
<MobileGroupID>2147483647</MobileGroupID>
<Notes>String content</Notes>
<Radius>
<Feet>2147483647</Feet>
<MapPointDistance>1.26743233E+15</MapPointDistance>
<RadiusDescription>String content</RadiusDescription>
<RadiusID>2147483647</RadiusID>
</Radius>
<State>String content</State>
<Street>String content</Street>
<SubGroupID>2147483647</SubGroupID>
<TankNo>2147483647</TankNo>
<Zip>String content</Zip>
</Destination>
<Emails>String content</Emails>
<ID>1627aea5-8e0a-4371-9022-9b504344e724</ID>
<IsInteractive>true</IsInteractive>
<UserID>2147483647</UserID>
<UtcTimeThreshold>1999-05-31T11:20:00</UtcTimeThreshold>
<VehicleID>2147483647</VehicleID>
</DestinationAlert>
The following is an example request Json body:
{
"AlertOn":0,
"Destination":{
"IsAudited":true,
"AccountNo":"String content",
"Category":{
"CategoryName":"String content",
"LandmarkCategoryID":2147483647,
"MobileGroupID":2147483647,
"Notes":"String content",
"SymbolNumber":2147483647
},
"City":"String content",
"ID":2147483647,
"IsRouteOrigin":true,
"IsVisible":true,
"Latitude":1.26743233E+15,
"LocationName":"String content",
"Longitude":1.26743233E+15,
"MobileGroupID":2147483647,
"Notes":"String content",
"Radius":{
"Feet":2147483647,
"MapPointDistance":1.26743233E+15,
"RadiusDescription":"String content",
"RadiusID":2147483647
},
"State":"String content",
"Street":"String content",
"SubGroupID":2147483647,
"TankNo":2147483647,
"Zip":"String content"
},
"Emails":"String content",
"ID":"1627aea5-8e0a-4371-9022-9b504344e724",
"IsInteractive":true,
"UserID":2147483647,
"UtcTimeThreshold":"\/Date(928164000000-0400)\/",
"VehicleID":2147483647
}
The following is an example response Xml body:
<ResponseOfTypeDCBooleanResult xmlns="http://schemas.datacontract.org/2004/07/VTS.API.DataContracts">
<StatusCode>2147483647</StatusCode>
<Resources>
<DCBooleanResult>
<Result>true</Result>
</DCBooleanResult>
<DCBooleanResult>
<Result>true</Result>
</DCBooleanResult>
</Resources>
<ResourceCount>2147483647</ResourceCount>
<Status>String content</Status>
</ResponseOfTypeDCBooleanResult>
The following is an example response Json body:
{
"StatusCode":2147483647,
"Resources":[{
"Result":true
}],
"ResourceCount":2147483647,
"Status":"String content"
}
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/VTS.Business" xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VTS.Business" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
<xs:complexType name="DestinationAlert">
<xs:sequence>
<xs:element minOccurs="0" name="AlertOn" type="tns:DestinationAlert.Event" />
<xs:element minOccurs="0" name="Destination" nillable="true" type="tns:LandmarkItem" />
<xs:element minOccurs="0" name="Emails" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ID" type="ser:guid" />
<xs:element minOccurs="0" name="IsInteractive" type="xs:boolean" />
<xs:element minOccurs="0" name="UserID" type="xs:int" />
<xs:element minOccurs="0" name="UtcTimeThreshold" type="xs:dateTime" />
<xs:element minOccurs="0" name="VehicleID" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="DestinationAlert" nillable="true" type="tns:DestinationAlert" />
<xs:simpleType name="DestinationAlert.Event">
<xs:restriction base="xs:string">
<xs:enumeration value="1">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="2">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:element name="DestinationAlert.Event" nillable="true" type="tns:DestinationAlert.Event" />
<xs:complexType name="LandmarkItem">
<xs:complexContent mixed="false">
<xs:extension base="tns:BaseAuditableMappableItemOfLandmarkItemGzr685TD">
<xs:sequence>
<xs:element minOccurs="0" name="AccountNo" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Category" nillable="true" type="tns:LandmarkCategory" />
<xs:element minOccurs="0" name="City" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ID" type="xs:int" />
<xs:element minOccurs="0" name="IsRouteOrigin" type="xs:boolean" />
<xs:element minOccurs="0" name="IsVisible" type="xs:boolean" />
<xs:element minOccurs="0" name="Latitude" type="xs:double" />
<xs:element minOccurs="0" name="LocationName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Longitude" type="xs:double" />
<xs:element minOccurs="0" name="MobileGroupID" type="xs:int" />
<xs:element minOccurs="0" name="Notes" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Radius" nillable="true" type="tns:Radius" />
<xs:element minOccurs="0" name="State" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Street" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="SubGroupID" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="TankNo" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="Zip" nillable="true" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="LandmarkItem" nillable="true" type="tns:LandmarkItem" />
<xs:complexType name="BaseAuditableMappableItemOfLandmarkItemGzr685TD">
<xs:annotation>
<xs:appinfo>
<GenericType Name="BaseAuditableMappableItemOf{0}{#}" Namespace="http://schemas.datacontract.org/2004/07/VTS.Business" xmlns="http://schemas.microsoft.com/2003/10/Serialization/">
<GenericParameter Name="LandmarkItem" Namespace="http://schemas.datacontract.org/2004/07/VTS.Business" />
</GenericType>
</xs:appinfo>
</xs:annotation>
<xs:complexContent mixed="false">
<xs:extension base="tns:AuditableOfLandmarkItemGzr685TD">
<xs:sequence />
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="BaseAuditableMappableItemOfLandmarkItemGzr685TD" nillable="true" type="tns:BaseAuditableMappableItemOfLandmarkItemGzr685TD" />
<xs:complexType name="AuditableOfLandmarkItemGzr685TD">
<xs:annotation>
<xs:appinfo>
<GenericType Name="AuditableOf{0}{#}" Namespace="http://schemas.datacontract.org/2004/07/VTS.Business" xmlns="http://schemas.microsoft.com/2003/10/Serialization/">
<GenericParameter Name="LandmarkItem" Namespace="http://schemas.datacontract.org/2004/07/VTS.Business" />
</GenericType>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" name="IsAudited" type="xs:boolean" />
</xs:sequence>
</xs:complexType>
<xs:element name="AuditableOfLandmarkItemGzr685TD" nillable="true" type="tns:AuditableOfLandmarkItemGzr685TD" />
<xs:complexType name="LandmarkCategory">
<xs:sequence>
<xs:element minOccurs="0" name="CategoryName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="LandmarkCategoryID" type="xs:int" />
<xs:element minOccurs="0" name="MobileGroupID" type="xs:int" />
<xs:element minOccurs="0" name="Notes" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="SymbolNumber" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="LandmarkCategory" nillable="true" type="tns:LandmarkCategory" />
<xs:complexType name="Radius">
<xs:complexContent mixed="false">
<xs:extension base="tns:BaseMappableItemOfRadiusGzr685TD">
<xs:sequence>
<xs:element minOccurs="0" name="Feet" type="xs:int" />
<xs:element minOccurs="0" name="MapPointDistance" type="xs:double" />
<xs:element minOccurs="0" name="RadiusDescription" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="RadiusID" type="xs:int" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="Radius" nillable="true" type="tns:Radius" />
<xs:complexType name="BaseMappableItemOfRadiusGzr685TD">
<xs:annotation>
<xs:appinfo>
<GenericType Name="BaseMappableItemOf{0}{#}" Namespace="http://schemas.datacontract.org/2004/07/VTS.Business" xmlns="http://schemas.microsoft.com/2003/10/Serialization/">
<GenericParameter Name="Radius" Namespace="http://schemas.datacontract.org/2004/07/VTS.Business" />
</GenericType>
</xs:appinfo>
</xs:annotation>
<xs:sequence />
</xs:complexType>
<xs:element name="BaseMappableItemOfRadiusGzr685TD" nillable="true" type="tns:BaseMappableItemOfRadiusGzr685TD" />
</xs:schema>
Additional request Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/VTS.API.DataContracts" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VTS.API.DataContracts" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.datacontract.org/2004/07/VTS.API" />
<xs:complexType name="ResponseOfTypeDCBooleanResult">
<xs:annotation>
<xs:appinfo>
<GenericType Name="ResponseOfType{0}" Namespace="http://schemas.datacontract.org/2004/07/VTS.API.DataContracts" xmlns="http://schemas.microsoft.com/2003/10/Serialization/">
<GenericParameter Name="DCBooleanResult" Namespace="http://schemas.datacontract.org/2004/07/VTS.API.DataContracts" />
</GenericType>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" name="StatusCode" type="xs:int" />
<xs:element minOccurs="0" name="Resources" nillable="true" type="tns:ArrayOfDCBooleanResult" />
<xs:element minOccurs="0" name="ResourceCount" type="xs:int" />
<xs:element minOccurs="0" name="Status" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="ResponseOfTypeDCBooleanResult" nillable="true" type="tns:ResponseOfTypeDCBooleanResult" />
<xs:complexType name="ArrayOfDCBooleanResult">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="DCBooleanResult" nillable="true" type="tns:DCBooleanResult" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfDCBooleanResult" nillable="true" type="tns:ArrayOfDCBooleanResult" />
<xs:complexType name="DCBooleanResult">
<xs:complexContent mixed="false">
<xs:extension xmlns:q1="http://schemas.datacontract.org/2004/07/VTS.API" base="q1:DataContractBase">
<xs:sequence>
<xs:element minOccurs="0" name="Result" type="xs:boolean" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="DCBooleanResult" nillable="true" type="tns:DCBooleanResult" />
</xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/VTS.API" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VTS.API" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="DataContractBase">
<xs:sequence />
</xs:complexType>
<xs:element name="DataContractBase" nillable="true" type="tns:DataContractBase" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>