Ctrlk
Log inGet startedAsk Navixy AI
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Status

The individual activity states, such as busy or not busy, that a tracker can be set to.

A working status records what an employee is currently doing, tracked through the device they carry. The simplest case is a pair, "busy" and "not busy", and an employee's device is set to one of them at any moment.

Statuses do not stand alone. Each belongs to a working status list, and a tracker can only be set to a status from the list assigned to it. Different trackers can carry different lists, so create the list first and add statuses to it with the operations here.

Working statuses are a tariff feature. An account with no tracker whose plan includes statuses gets error 236 from every operation on this page. For the task-management side of the same feature, see how statuses change task states.

Working status object

API actions

API base path: /status.

Required sub-user rights: tracker_update.

Create working status

post
/status/create

Add a working status to a status list.

Pass the status object without id. An id that is sent anyway is ignored rather than rejected.

Requires the tracker_update right. Requires the statuses tariff feature on at least one tracker. Without it the call returns error 236.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
listing_idinteger · min: 1Required

ID of the status list to add to.

Responses
200

The created working status

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
idintegerOptional

ID of the new working status.

post/status/create
POST /v2/status/create HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "listing_id": 1,
  "status": {
    "id": 1,
    "label": "text",
    "color": "text"
  }
}
{
  "success": true,
  "id": 1
}

Errors

These errors come in addition to the general error codes:

  • 201 - Not found in the database, when no list has the given ID.

  • 236 - Feature unavailable due to tariff restrictions, when no tracker on the account has the statuses tariff feature.

  • 268 - Over quota, when the user's quota for working statuses is exceeded.

Required sub-user rights: tracker_update.

Delete working status

post
/status/delete

Delete a working status.

Requires the tracker_update right. Requires the statuses tariff feature on at least one tracker. Without it the call returns error 236.

Also accepts GET with the same parameters as query-string values.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
status_idinteger · min: 1Required

ID of the working status. Must belong to the current account.

Responses
200

Working status deleted

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/status/delete
POST /v2/status/delete HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "status_id": 1
}
{
  "success": true
}

Errors

These errors come in addition to the general error codes:

  • 201 - Not found in the database, when no working status has the given ID.

  • 236 - Feature unavailable due to tariff restrictions, when no tracker on the account has the statuses tariff feature.

List working statuses

post
/status/list

Return the working statuses of one status list, in display order.

A list ID belonging to another account returns an empty array rather than an error.

Requires the statuses tariff feature on at least one tracker. Without it the call returns error 236.

Also accepts GET with the same parameters as query-string values.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
listing_idinteger · min: 1Required

ID of the status list.

Responses
200

The working statuses

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/status/list
POST /v2/status/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "listing_id": 1
}
{
  "success": true,
  "list": [
    {
      "id": 1,
      "label": "text",
      "color": "text"
    }
  ]
}

Errors

These errors come in addition to the general error codes:

  • 236 - Feature unavailable due to tariff restrictions, when no tracker on the account has the statuses tariff feature.

Required sub-user rights: tracker_update.

Update working status

post
/status/update

Change a working status's label or colour.

id is required inside the object. Omitting it currently returns error 6 rather than a validation error.

A working status cannot be moved between lists; delete it and create it again.

Requires the tracker_update right. Requires the statuses tariff feature on at least one tracker. Without it the call returns error 236.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
Responses
200

Working status updated

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/status/update
POST /v2/status/update HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "status": {
    "id": 1,
    "label": "text",
    "color": "text"
  }
}
{
  "success": true
}

Errors

These errors come in addition to the general error codes:

  • 201 - Not found in the database, when no working status has the given ID.

  • 236 - Feature unavailable due to tariff restrictions, when no tracker on the account has the statuses tariff feature.

More in this section

Tracker's working status

Endpoint
Method
What it does

/status/tracker/assign

POST

Assign working status to tracker

/status/tracker/list

POST

List trackers' working statuses

/status/tracker/read

POST

Read tracker's working status

Listing

Endpoint
Method
What it does

/status/listing/create

POST

Create working status list

/status/listing/delete

POST

Delete working status list

/status/listing/list

POST

List working status lists

/status/listing/update

POST

Update working status list

Tracker's working status list

Endpoint
Method
What it does

/status/listing/tracker/assign

POST

Assign working status list to tracker

PreviousRoute with Progorod
NextTracker's working status

Last updated

Was this helpful?