BootView WebApi

<back to all web services

GetDevices

The following routes are available for this service:
GET/spytec/devicesGet the spytec device list
GetDevices Parameters:
NameParameterData TypeRequiredDescription
ClientIdqueryGuidYesThe Client id.
SpytecDeviceListResult Parameters:
NameParameterData TypeRequiredDescription
ResultformDeviceListResultNo
SpytecBaseResult Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
DeviceListResult Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<DeviceSingleResult>No
DeviceSingleResult Parameters:
NameParameterData TypeRequiredDescription
ImeiformstringNo
BrandformstringNo
ClientIdformintNo
CreatedformDateTimeNo
NameformstringNo
StatusformstringNo
IccidformstringNo
ModifiedformDateTimeNo
CreatedByformstringNo
ModifiedByformstringNo
DeviceIdformintNo
ColorformstringNo
IconformstringNo
DescriptionformstringNo
connectivityProviderformstringNo
ModelformModelElementNo
DeviceStatusformDeviceStatusResultNo
ModelElement Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DescriptionformstringNo
PictureUrlformstringNo
DeviceStatusResult Parameters:
NameParameterData TypeRequiredDescription
BatteryAlertInAlarmformintNo
GpsAccuracyformintNo
TripDurationInAlarmformstringNo
CellIdformstringNo
MessageIdformstringNo
ReportTypeformstringNo
AzimuthformstringNo
OdoMileageformstringNo
SpeedformstringNo
AltitudeformdoubleNo
LatitudeformdoubleNo
LongitudeformdoubleNo
TripGeneratorformDateTimeNo
ReportIdformstringNo
GpsUTCTimeformstringNo
BatteryPercentageformstringNo
CreatedformDateTimeNo
SendTimeformDateTimeNo
AddressformstringNo
ClientIdformintNo
TripDistanceInAlarmformintNo
TripIdformintNo
ImeiformstringNo
SpeedAlertInAlarmformstringNo
TripStopDurationInAlarmformstringNo
MncformstringNo
MccformstringNo
LacformstringNo
ProtocolVersionformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /spytec/devices HTTP/1.1 
Host: api.paylock.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"result":{"items":[{"imei":"String","brand":"String","clientId":0,"created":"\/Date(-62135596800000-0000)\/","name":"String","status":"String","iccid":"String","modified":"\/Date(-62135596800000-0000)\/","createdBy":"String","modifiedBy":"String","deviceId":0,"color":"String","icon":"String","description":"String","connectivityProvider":"String","model":{"name":"String","description":"String","pictureUrl":"String"},"deviceStatus":{"batteryAlertInAlarm":0,"gpsAccuracy":0,"tripDurationInAlarm":"String","cellId":"String","messageId":"String","reportType":"String","azimuth":"String","odoMileage":"String","speed":"String","altitude":0,"latitude":0,"longitude":0,"tripGenerator":"\/Date(-62135596800000-0000)\/","reportId":"String","gpsUTCTime":"String","batteryPercentage":"String","created":"\/Date(-62135596800000-0000)\/","sendTime":"\/Date(-62135596800000-0000)\/","address":"String","clientId":0,"tripDistanceInAlarm":0,"tripId":0,"imei":"String","speedAlertInAlarm":"String","tripStopDurationInAlarm":"String","mnc":"String","mcc":"String","lac":"String","protocolVersion":"String"}}]},"success":false,"message":"String"}