BootView WebApi

<back to all web services

GetDevice

The following routes are available for this service:
GET/spytec/deviceGet the spytec device based on the imei.
GetDevice Parameters:
NameParameterData TypeRequiredDescription
ImeiquerystringYesThe Imei of the GPS device.
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 .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 HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SpytecDeviceListResult 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>
      <DeviceSingleResult>
        <Brand>String</Brand>
        <ClientId>0</ClientId>
        <Color>String</Color>
        <Created>0001-01-01T00:00:00</Created>
        <CreatedBy>String</CreatedBy>
        <Description>String</Description>
        <DeviceId>0</DeviceId>
        <DeviceStatus>
          <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>
        </DeviceStatus>
        <Iccid>String</Iccid>
        <Icon>String</Icon>
        <Imei>String</Imei>
        <Model>
          <Description>String</Description>
          <Name>String</Name>
          <PictureUrl>String</PictureUrl>
        </Model>
        <Modified>0001-01-01T00:00:00</Modified>
        <ModifiedBy>String</ModifiedBy>
        <Name>String</Name>
        <Status>String</Status>
        <connectivityProvider>String</connectivityProvider>
      </DeviceSingleResult>
    </Items>
  </Result>
</SpytecDeviceListResult>