Device

Operations

GET/devicesGET/devices/countGET/devices/findOneGET/devices/{id}GET/devices/{id}/deviceSensorGET/devices/{id}/divisionGET/devices/{id}/employeeGET/devices/{id}/existsGET/devices/{id}/plantGET/devices/{id}/settingsDivisionGET/devices/{id}/truck

---

GET /devices

GET

/devices

Find all instances of the model matched by filter from the data source.

Parameters

Query Parameters

filter

Filter defining fields, where, include, order, offset, and limit

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

"uniqueId": "string",

"pushId": "string",

"name": "string",

"type": "string",

"model": "string",

"appVersion": "string",

"phoneNumber": "string",

"active": true,

"features": {

},

"location": "string",

"locationData": {

},

"speed": 0,

"course": 0,

"metricsDate": "string",

"lastAccess": "string",

"id": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string",

"divisionId": "string",

"settingsDivisionId": "string",

"truckId": "string",

"plantId": "string",

"employeeId": "string",

"sensor": "string"

}

]

GET

/devices

Playground

Variables

Key

Value

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /devices/count

GET

/devices/count

Count instances of the model matched by where from the data source.

Parameters

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/devices/count

Playground

Variables

Key

Value

where

Samples

cURL

JavaScript

PHP

Python

---

GET /devices/findOne

GET

/devices/findOne

Find first instance of the model matched by filter from the data source.

Parameters

Query Parameters

filter

Filter defining fields, where, include, order, offset, and limit

Typestring

Responses

Request was successful

Content-Type

application/json

{

"uniqueId": "string",

"pushId": "string",

"name": "string",

"type": "string",

"model": "string",

"appVersion": "string",

"phoneNumber": "string",

"active": true,

"features": {

},

"location": "string",

"locationData": {

},

"speed": 0,

"course": 0,

"metricsDate": "string",

"lastAccess": "string",

"id": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string",

"divisionId": "string",

"settingsDivisionId": "string",

"truckId": "string",

"plantId": "string",

"employeeId": "string",

"sensor": "string"

}

GET

/devices/findOne

Playground

Variables

Key

Value

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /devices/{id}

GET

/devices/{id}

Find a model instance by {{id}} from the data source.

Parameters

Path Parameters

id*

Model id

Typestring

Required

Query Parameters

filter

Filter defining fields and include

Typestring

Responses

Request was successful

Content-Type

application/json

{

"uniqueId": "string",

"pushId": "string",

"name": "string",

"type": "string",

"model": "string",

"appVersion": "string",

"phoneNumber": "string",

"active": true,

"features": {

},

"location": "string",

"locationData": {

},

"speed": 0,

"course": 0,

"metricsDate": "string",

"lastAccess": "string",

"id": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string",

"divisionId": "string",

"settingsDivisionId": "string",

"truckId": "string",

"plantId": "string",

"employeeId": "string",

"sensor": "string"

}

GET

/devices/{id}

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /devices/{id}/deviceSensor

GET

/devices/{id}/deviceSensor

Fetches hasOne relation deviceSensor.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

refresh

Typeboolean

Responses

Request was successful

Content-Type

application/json

{

"name": "string",

"lastAccess": "string",

"firmwareVersion": "string",

"id": "string",

"companyId": "string",

"truckId": "string",

"sensorFirmwareId": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/devices/{id}/deviceSensor

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---

GET /devices/{id}/division

GET

/devices/{id}/division

Fetches belongsTo relation division.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

refresh

Typeboolean

Responses

Request was successful

Content-Type

application/json

{

"name": "string",

"code": "string",

"externalId": "string",

"id": "string",

"parentId": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/devices/{id}/division

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---

GET /devices/{id}/employee

GET

/devices/{id}/employee

Fetches belongsTo relation employee.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

refresh

Typeboolean

Responses

Request was successful

Content-Type

application/json

{

"name": "string",

"number": "string",

"email": "string",

"phoneNumber": "string",

"type": "regular",

"clockInAllowedAt": "string",

"hireDate": "string",

"active": true,

"externalId": "string",

"receivesLateClockInNotifications": true,

"id": "string",

"companyId": "string",

"divisionId": "string",

"plantId": "string",

"truckId": "string",

"createdAt": "string",

"updatedAt": "string",

"typeId": "string",

"timeCategoryIds": [

"string"

],

"defaultTimeCategoryId": "string"

}

GET

/devices/{id}/employee

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---

GET /devices/{id}/exists

GET

/devices/{id}/exists

Check whether a model instance exists in the data source.

Parameters

Path Parameters

id*

Model id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"exists": true

}

GET

/devices/{id}/exists

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /devices/{id}/plant

GET

/devices/{id}/plant

Fetches belongsTo relation plant.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

refresh

Typeboolean

Responses

Request was successful

Content-Type

application/json

{

"number": "string",

"description": "string",

"address": "string",

"region": {

},

"location": "string",

"radius": 100,

"dvirEmails": [

"string"

],

"timeZone": "string",

"id": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string",

"plantRegionId": "string",

"addressDetails": "string"

}

GET

/devices/{id}/plant

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---

GET /devices/{id}/settingsDivision

GET

/devices/{id}/settingsDivision

Fetches belongsTo relation settingsDivision.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

refresh

Typeboolean

Responses

Request was successful

Content-Type

application/json

{

"name": "string",

"code": "string",

"externalId": "string",

"id": "string",

"parentId": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/devices/{id}/settingsDivision

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---

GET /devices/{id}/truck

GET

/devices/{id}/truck

Fetches belongsTo relation truck.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

refresh

Typeboolean

Responses

Request was successful

Content-Type

application/json

{

"number": "string",

"description": "string",

"location": "string",

"locationData": {

},

"inService": false,

"inYard": false,

"deadhead": "string",

"endOfDay": false,

"lastAccess": "string",

"externalId": "string",

"id": "string",

"companyId": "string",

"divisionId": "string",

"createdAt": "string",

"updatedAt": "string",

"plantId": "string",

"currentPlantId": "string",

"metrics": "string"

}

GET

/devices/{id}/truck

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---