BootView WebApi

GetDevices

The following routes are available for this service:
GET	/spytec/devices	Get the spytec device list

**GetDevices** Parameters:
Name	Parameter	Data Type	Required	Description
ClientId	query	Guid	Yes	The Client id.

**SpytecDeviceListResult** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	DeviceListResult	No

**SpytecBaseResult** Parameters:
Name	Parameter	Data Type	Required	Description
Success	form	bool	No
Message	form	string	No

**DeviceListResult** Parameters:
Name	Parameter	Data Type	Required	Description
Items	form	List<DeviceSingleResult>	No

**DeviceSingleResult** Parameters:
Name	Parameter	Data Type	Required
Imei	form	string	No
Brand	form	string	No
ClientId	form	int	No
Created	form	DateTime	No
Name	form	string	No
Status	form	string	No
Iccid	form	string	No
Modified	form	DateTime	No
CreatedBy	form	string	No
ModifiedBy	form	string	No
DeviceId	form	int	No
Color	form	string	No
Icon	form	string	No
Description	form	string	No
connectivityProvider	form	string	No
Model	form	ModelElement	No
DeviceStatus	form	DeviceStatusResult	No

**ModelElement** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Description	form	string	No
PictureUrl	form	string	No

**DeviceStatusResult** Parameters:
Name	Parameter	Data Type	Required
BatteryAlertInAlarm	form	int	No
GpsAccuracy	form	int	No
TripDurationInAlarm	form	string	No
CellId	form	string	No
MessageId	form	string	No
ReportType	form	string	No
Azimuth	form	string	No
OdoMileage	form	string	No
Speed	form	string	No
Altitude	form	double	No
Latitude	form	double	No
Longitude	form	double	No
TripGenerator	form	DateTime	No
ReportId	form	string	No
GpsUTCTime	form	string	No
BatteryPercentage	form	string	No
Created	form	DateTime	No
SendTime	form	DateTime	No
Address	form	string	No
ClientId	form	int	No
TripDistanceInAlarm	form	int	No
TripId	form	int	No
Imei	form	string	No
SpeedAlertInAlarm	form	string	No
TripStopDurationInAlarm	form	string	No
Mnc	form	string	No
Mcc	form	string	No
Lac	form	string	No
ProtocolVersion	form	string	No

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/devices 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>