| GET | /spytec/device/alerts | Get list of device alerts. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Imei | query | string | Yes | The Imei of the GPS device. |
| StartDate | query | DateTime | Yes | Start date to get the message list. |
| EndDate | query | DateTime | Yes | End date to get the message list. |
| Limit | query | int | No | Maximum number in one page of results. |
| NextToken | query | string | No | Pagination token received from previous query. |
| Types | query | string | Yes | Available alert types: Speeding, SOS, LowBattery, GeofenceEntry, GeofenceExit, Movement, TripExceedsDistance, TripExceedsDuration, TripStarted, TripFinished, StopExceedsDuration, Tow, IgnitionOn, IgnitionOff, StartedCharging, StoppedCharging, PluggedExternalPowerSource, UnpluggedExternalPowerSource. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | AlertResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Items | form | List<SpytecAlert> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| alertType | form | string | No | |
| imei | form | string | No | |
| created | form | DateTime | No | |
| sendTime | form | DateTime | No | |
| userId | form | string | No | |
| coordinates | form | Coordinate | No | |
| address | form | string | No | |
| clientId | form | double | No | |
| alertId | form | double | No | |
| value | form | string | No | |
| isBuffer | form | bool | No | |
| isNotification | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| latitude | form | double | No | |
| longitude | form | double | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /spytec/device/alerts HTTP/1.1 Host: api.paylock.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SpytecAlertResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
<Message>String</Message>
<Success>false</Success>
<Result>
<Items>
<SpytecAlert>
<address>String</address>
<alertId>0</alertId>
<alertType>String</alertType>
<clientId>0</clientId>
<coordinates>
<latitude>0</latitude>
<longitude>0</longitude>
</coordinates>
<created>0001-01-01T00:00:00</created>
<imei>String</imei>
<isBuffer>false</isBuffer>
<isNotification>false</isNotification>
<sendTime>0001-01-01T00:00:00</sendTime>
<userId>String</userId>
<value>String</value>
</SpytecAlert>
</Items>
</Result>
</SpytecAlertResult>