List Device

Production reader

https://api.exati.com.br/tracking/read

POST

/device/list

This method is responsible for reading devices. Specific request body parameters can be applied to filter the results.

Request

Body Params application/json

idDevice

number

optional

Optional, used only for searching operations

>= 1

idTracker

integer

required

The Tracker entity ID

>= 1

idWorksite

integer

required

The worksite this device belongs to

>= 1

idTeam

integer

required

The team this device is assigned to

>= 1

deviceName

string

required

The name of the Device

>= 150 characters

idType

integer

required

The Device Type ID

>= 1

deviceCode

string

optional

Usually the vehicles license plate, can repeat between devices

>= 50 characters

deviceUuid

string

optional

Usually the vehicle chassis, this field must be unique across devices.

>= 50 characters

status

string

optional

The device status

>= 20 characters

Example

{
    "idTracker": 2,
    "idWorksite": 6,
    "idTeam": 6,
    "deviceName": "testing device",
    "idType": 1,
    "deviceCode": "ABC-1234",
    "deviceUuid": "vehicle-chassis",
    "status": "active"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.exati.com.br/tracking/read/device/list' \
--header 'Content-Type: application/json' \
--data-raw '{
    "idTracker": 2,
    "idWorksite": 6,
    "idTeam": 6,
    "deviceName": "testing device",
    "idType": 1,
    "deviceCode": "ABC-1234",
    "deviceUuid": "vehicle-chassis",
    "status": "active"
}'

Responses

🟢200OK

application/json

Example of a Device List response

Body

array of:

id_device

integer

optional

The Device ID

id_instance

integer

optional

The Client Instance ID

id_client_vendor

integer

optional

The Client-Vendor Link Identifier

id_tracker

integer

optional

The tracker ID

id_worksite

integer

optional

The worksite ID this device belongs to

id_team

integer

optional

The worksite ID this device is assigned to

device_name

string

optional

The Device name

id_device_type

integer

optional

The Device Type ID

device_code

string | null

optional

The Device Code

device_uuid

string | null

optional

The Device unique identifier

status

string

optional

The Device status

Example

{
    "id_device": 2,
    "id_instance": 123,
    "id_client_vendor": 1,
    "id_tracker": 3,
    "id_worksite": 6,
    "id_team": 6,
    "device_name": "testing device",
    "id_device_type": 3,
    "device_code": "testing",
    "device_uuid": "fef6b5dd-e53b-479d-86a5-4f155a9b65ba",
    "status": "active"
}

Modified at 2025-02-25 19:51:15

Create Device

Device