GET | /spytec/devices | Get the spytec device list |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ClientId | query | Guid | Yes | The Client id. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Result | form | DeviceListResult | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Success | form | bool | No | |
Message | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Items | form | List<DeviceSingleResult> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
Description | form | string | No | |
PictureUrl | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { result: { items: [ { imei: String, brand: String, clientId: 0, created: 0001-01-01, name: String, status: String, iccid: String, modified: 0001-01-01, 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: 0001-01-01, reportId: String, gpsUTCTime: String, batteryPercentage: String, created: 0001-01-01, sendTime: 0001-01-01, 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 }