Skip to content

Working status

Contains status object and API calls to interact with them. Working statuses used to track current activity for employees (in fact, of tracking devices owned by employees). The simplest example is "busy" | "not busy". This is a status listing consisting of two elements. Different trackers can be assigned different status lists.


Status object structure

{
    "id": 5,
    "label": "Busy",
    "color": "E57373"
}
  • id - int. A unique identifier of the working status. Read-only.
  • label - string. Human-readable label for the working status.
  • color - string. Hex-representation of RGB color used to display this working status.

API actions

API base path: /status/.

create

Creates new possible working status for the specified working status list.

required sub-user rights: tracker_update.

parameters

name description type
listing_id ID of the list for this working status to attach to. int
status Status object without ID field. JSON object

example

curl -X POST 'https://api.navixy.com/v2/status/create' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "listing_id": 12345, "status": {"label": "Busy", "color": "E57373"}}'

response

{
    "success": true,
    "id": 111
}
  • id - int. ID of the created working status.

errors

  • 201 - Not found in the database – if listing with the specified ID does not exist.
  • 236 - Feature unavailable due to tariff restrictions – if there are no trackers with "statuses" tariff feature available.
  • 268 - Over quota – if the user's quota for working statuses exceeded.

delete

Deletes working status entry.

required sub-user rights: tracker_update.

parameters

name description type
status_id ID of the working status belonging to authorized user. int

examples

curl -X POST 'https://api.navixy.com/v2/status/delete' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "status_id": 123}'
https://api.navixy.com/v2/status/delete?hash=a6aa75587e5c59c32d347da438505fc3&status_id=123

response

{ "success": true }

errors

  • 201 - Not found in the database – if working status with the specified ID does not exist.
  • 236 - Feature unavailable due to tariff restrictions – if there are no trackers with "statuses" tariff feature available.

list

Gets working statuses belonging to the specified status list.

parameters

name description type
listing_id ID of the list for this working status to attach to. int

examples

curl -X POST 'https://api.navixy.com/v2/status/list' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "listing_id": 12345}'
https://api.navixy.com/v2/status/list?hash=a6aa75587e5c59c32d347da438505fc3&listing_id=12345

response

{
    "success": true,
    "list":[{
      "id": 5,
      "label": "Busy",
      "color": "E57373"
    },{
      "id": 6,
      "label": "Free",
      "color": "A27373"
    }]
}
  • list - ordered array of objects.

errors

  • 236 - Feature unavailable due to tariff restrictions – if there are no trackers with "statuses" tariff feature available.

update

Updates working status properties.

required sub-user rights: tracker_update.

parameters

name description type
status Status object with ID field. JSON object

example

curl -X POST 'https://api.navixy.com/v2/status/update' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "status": {"id": 5, "label": "Busy", "color": "E57373"}}'

response

{ "success": true }

errors

  • 201 - Not found in the database – if working status with the specified ID does not exist.
  • 236 - Feature unavailable due to tariff restrictions – if there are no trackers with "statuses" tariff feature available.

Last update: July 22, 2021