BootView WebApi

<back to all web services

GetDeviceMessages

The following routes are available for this service:
GET/spytec/device/messagesGet list of device messages.
GetDeviceMessages 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.
SpytecMessagesResult Parameters:
NameParameterData TypeRequiredDescription
ResultformMessagesResultNo
SpytecBaseResult Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
MessagesResult Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<SpytecMessages>No
SpytecMessages Parameters:
NameParameterData TypeRequiredDescription
TypeformstringNo
GpsUTCTimeformstringNo
ImeiformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
OdoMileageformintNo
SendTimeformDateTimeNo
Message_idformstringNo
SpeedformdoubleNo

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/messages HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SpytecMessagesResult 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>
      <SpytecMessages>
        <GpsUTCTime>String</GpsUTCTime>
        <Imei>String</Imei>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
        <Message_id>String</Message_id>
        <OdoMileage>0</OdoMileage>
        <SendTime>0001-01-01T00:00:00</SendTime>
        <Speed>0</Speed>
        <Type>String</Type>
      </SpytecMessages>
    </Items>
  </Result>
</SpytecMessagesResult>