BootView WebApi

<back to all web services

GetDeviceAlerts

The following routes are available for this service:
GET/spytec/device/alertsGet list of device alerts.
GetDeviceAlerts Parameters:
NameParameterData TypeRequiredDescription
ImeiquerystringYesThe Imei of the GPS device.
StartDatequeryDateTimeYesStart date to get the message list.
EndDatequeryDateTimeYesEnd date to get the message list.
LimitqueryintNoMaximum number in one page of results.
NextTokenquerystringNoPagination token received from previous query.
TypesquerystringYesAvailable alert types: Speeding, SOS, LowBattery, GeofenceEntry, GeofenceExit, Movement, TripExceedsDistance, TripExceedsDuration, TripStarted, TripFinished, StopExceedsDuration, Tow, IgnitionOn, IgnitionOff, StartedCharging, StoppedCharging, PluggedExternalPowerSource, UnpluggedExternalPowerSource.
SpytecAlertResult Parameters:
NameParameterData TypeRequiredDescription
ResultformAlertResultNo
SpytecBaseResult Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
AlertResult Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<SpytecAlert>No
SpytecAlert Parameters:
NameParameterData TypeRequiredDescription
alertTypeformstringNo
imeiformstringNo
createdformDateTimeNo
sendTimeformDateTimeNo
userIdformstringNo
coordinatesformCoordinateNo
addressformstringNo
clientIdformdoubleNo
alertIdformdoubleNo
valueformstringNo
isBufferformboolNo
isNotificationformboolNo
Coordinate Parameters:
NameParameterData TypeRequiredDescription
latitudeformdoubleNo
longitudeformdoubleNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		items: 
		[
			{
				alertType: String,
				imei: String,
				created: 0001-01-01,
				sendTime: 0001-01-01,
				userId: String,
				coordinates: 
				{
					latitude: 0,
					longitude: 0
				},
				address: String,
				clientId: 0,
				alertId: 0,
				value: String,
				isBuffer: False,
				isNotification: False
			}
		]
	},
	success: False,
	message: String
}