Vehicle status listing¶
Deprecated
This API action deprecated and should not be used.
Contains vehicle status listing object and API calls to interact with it.
Vehicle status listing object¶
{
"id": 1,
"order": 0,
"label": "label123",
"color": "FFFFFF"
}
id
- int. An ID of the status.order
- int. Position of the status. Ignored when update because statuses already have position in an array.label
- string. Status name (description).color
- string. RGB-color.
API actions¶
API path: /vehicle/status/listing
.
read
¶
Gets all of user's vehicle statuses.
Examples¶
curl -X POST 'https://api.navixy.com/v2/vehicle/status/listing/read' \
-H 'Content-Type: application/json' \
-d '{"hash": "a6aa75587e5c59c32d347da438505fc3"}'
https://api.navixy.com/v2/vehicle/status/listing/read?hash=a6aa75587e5c59c32d347da438505fc3
Response¶
{
"success": true,
"list": [{
"id": 1,
"order": 0,
"label": "label123",
"color": "FFFFFF"
}]
}
Errors¶
General types only.
update
¶
Updates user's vehicle statuses.
Parameters¶
name | description | type |
---|---|---|
statuses | List of vehicle_status_entry objects. If status ID is not null, then update, else create new vehicle status. | array of objects |
Old vehicle statuses, which are not present in statuses
array, will be deleted.
Example¶
curl -X POST 'https://api.navixy.com/v2/vehicle/status/listing/update' \
-H 'Content-Type: application/json' \
-d '{"hash": "a6aa75587e5c59c32d347da438505fc3", "statuses": [{"id": 1, "order": 0, "label": "label123", "color": "FFFFFF"}]}'
Response¶
{ "success": true }
Errors¶
General types only.
Last update: August 4, 2024