BootView WebApi

<back to all web services

GetDeviceStatus

The following routes are available for this service:
GET/spytec/device/statusGet the spytec device status based on the imei.
GetDeviceStatus Parameters:
NameParameterData TypeRequiredDescription
ImeiquerystringYesThe Imei of the GPS device.
SpytecDeviceStatusResult Parameters:
NameParameterData TypeRequiredDescription
ResultformDeviceStatusResultNo
SpytecBaseResult Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
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 .xml suffix or ?format=xml

HTTP + XML

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

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

<SpytecDeviceStatusResult 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>
    <Address>String</Address>
    <Altitude>0</Altitude>
    <Azimuth>String</Azimuth>
    <BatteryAlertInAlarm>0</BatteryAlertInAlarm>
    <BatteryPercentage>String</BatteryPercentage>
    <CellId>String</CellId>
    <ClientId>0</ClientId>
    <Created>0001-01-01T00:00:00</Created>
    <GpsAccuracy>0</GpsAccuracy>
    <GpsUTCTime>String</GpsUTCTime>
    <Imei>String</Imei>
    <Lac>String</Lac>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
    <Mcc>String</Mcc>
    <MessageId>String</MessageId>
    <Mnc>String</Mnc>
    <OdoMileage>String</OdoMileage>
    <ProtocolVersion>String</ProtocolVersion>
    <ReportId>String</ReportId>
    <ReportType>String</ReportType>
    <SendTime>0001-01-01T00:00:00</SendTime>
    <Speed>String</Speed>
    <SpeedAlertInAlarm>String</SpeedAlertInAlarm>
    <TripDistanceInAlarm>0</TripDistanceInAlarm>
    <TripDurationInAlarm>String</TripDurationInAlarm>
    <TripGenerator>0001-01-01T00:00:00</TripGenerator>
    <TripId>0</TripId>
    <TripStopDurationInAlarm>String</TripStopDurationInAlarm>
  </Result>
</SpytecDeviceStatusResult>