Reference for https://api.silentpassenger.com/rest/v2/{APIKEY}/Alerts?type=Landmark&pagesize={PAGESIZE}
Get the list of all landmark alerts for the mobile group's vehicles. This requires Landmark Alert to first be defined in Silent Passenger.
Url: https://api.silentpassenger.com/rest/v2/{APIKEY}/Alerts?type=Landmark&pagesize={PAGESIZE}
HTTP Method: GET
| Message direction | Format | Body |
|---|---|---|
| Request | N/A | The Request body is empty. |
| Response | Xml | Example,Schema |
| Response | Json | Example |
The following is an example response Xml body:
<ArrayOfAlert xmlns="http://schemas.datacontract.org/2004/07/VTS.Business">
<Alert>
<AccountNo>String content</AccountNo>
<Event>None</Event>
<EventTime>1999-05-31T11:20:00</EventTime>
<GeoFenceCategoryID>2147483647</GeoFenceCategoryID>
<GeoFenceID>2147483647</GeoFenceID>
<LandmarkAlertID>2147483647</LandmarkAlertID>
<LandmarkCategoryID>2147483647</LandmarkCategoryID>
<LandmarkID>2147483647</LandmarkID>
<LocationName>String content</LocationName>
<MobileGroupID>2147483647</MobileGroupID>
<VehicleID>2147483647</VehicleID>
<VehicleLocationID>9223372036854775807</VehicleLocationID>
<VehicleName>String content</VehicleName>
</Alert>
<Alert>
<AccountNo>String content</AccountNo>
<Event>None</Event>
<EventTime>1999-05-31T11:20:00</EventTime>
<GeoFenceCategoryID>2147483647</GeoFenceCategoryID>
<GeoFenceID>2147483647</GeoFenceID>
<LandmarkAlertID>2147483647</LandmarkAlertID>
<LandmarkCategoryID>2147483647</LandmarkCategoryID>
<LandmarkID>2147483647</LandmarkID>
<LocationName>String content</LocationName>
<MobileGroupID>2147483647</MobileGroupID>
<VehicleID>2147483647</VehicleID>
<VehicleLocationID>9223372036854775807</VehicleLocationID>
<VehicleName>String content</VehicleName>
</Alert>
</ArrayOfAlert>
The following is an example response Json body:
[{
"AccountNo":"String content",
"Event":0,
"EventTime":"\/Date(928164000000-0400)\/",
"GeoFenceCategoryID":2147483647,
"GeoFenceID":2147483647,
"LandmarkAlertID":2147483647,
"LandmarkCategoryID":2147483647,
"LandmarkID":2147483647,
"LocationName":"String content",
"MobileGroupID":2147483647,
"VehicleID":2147483647,
"VehicleLocationID":9223372036854775807,
"VehicleName":"String content"
}]
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/VTS.Business" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VTS.Business" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="ArrayOfAlert">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Alert" nillable="true" type="tns:Alert" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfAlert" nillable="true" type="tns:ArrayOfAlert" />
<xs:complexType name="Alert">
<xs:sequence>
<xs:element minOccurs="0" name="AccountNo" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Event" type="tns:EventEnum" />
<xs:element minOccurs="0" name="EventTime" type="xs:dateTime" />
<xs:element minOccurs="0" name="GeoFenceCategoryID" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="GeoFenceID" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="LandmarkAlertID" type="xs:int" />
<xs:element minOccurs="0" name="LandmarkCategoryID" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="LandmarkID" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="LocationName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="MobileGroupID" type="xs:int" />
<xs:element minOccurs="0" name="VehicleID" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="VehicleLocationID" type="xs:long" />
<xs:element minOccurs="0" name="VehicleName" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="Alert" nillable="true" type="tns:Alert" />
<xs:simpleType name="EventEnum">
<xs:restriction base="xs:string">
<xs:enumeration value="None" />
<xs:enumeration value="Enter" />
<xs:enumeration value="Within" />
<xs:enumeration value="Exit" />
</xs:restriction>
</xs:simpleType>
<xs:element name="EventEnum" nillable="true" type="tns:EventEnum" />
</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>
<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>