For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tracker's working status

Read and set the working status a particular tracker is currently in.

These operations work on the current status of a tracker, rather than on the statuses and lists that define what it can be set to.

A tracker can only be set to a status from the list assigned to it, and only when that list is supervisor-controlled. A list that only its own employee may change returns error 13 to a supervisor attempting the change.

Setting a tracker to the status it already holds returns error 263 rather than succeeding silently.

API actions

API base path: /status/tracker.


Assign working status to tracker

post
/status/tracker/assign

Set a tracker's current working status, and return the change that resulted.

The status must belong to the list assigned to that tracker, and the list must be supervisor-controlled: a list only its employee may change returns error 13.

The change is recorded with origin supervisor and the tracker's last known location. Assigning the status the tracker already holds returns error 263.

Not allowed for clones. 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
tracker_idinteger · min: 1Required

ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked.

new_status_idinteger · min: 1Required

ID of the working status to assign. Must belong to the status list assigned to this tracker.

Responses
200

The resulting change

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

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

{
  "tracker_id": 1,
  "new_status_id": 1
}
{
  "success": true,
  "last_change": {
    "id": 1,
    "old_status_id": null,
    "new_status_id": null,
    "location": {
      "lat": 1,
      "lng": 1,
      "address": "text"
    },
    "changed": "text",
    "origin": "supervisor"
  }
}

Errors

These errors come in addition to the general error codes:

  • 13 - Operation not permitted, when the status list does not allow a supervisor to change the status.

  • 201 - Not found in the database, when the authorized user has no tracker with the given ID.

  • 204 - Entity not found, when the list assigned to the tracker holds no status with the given ID.

  • 208 - Device blocked, when the tracker exists but is blocked, whether by tariff restrictions or for another reason.

  • 219 - Not allowed for clones of the device, when the given tracker is a clone.

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

  • 263 - No change needed, old and new values are the same, when the new status matches the tracker's current one.


List trackers' working statuses

post
/status/tracker/list

Return the current working status and last change for each of the given trackers.

The result is keyed by tracker ID. trackers is required here, unlike the beacon calls: an empty body is rejected.

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
trackersinteger[]Required

Tracker IDs belonging to the current account. Cannot be an empty array.

Responses
200

Current statuses by tracker

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

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

{
  "trackers": [
    1
  ]
}
{
  "success": true,
  "value": {
    "ANY_ADDITIONAL_PROPERTY": {
      "current_status": {
        "id": 1,
        "label": "text",
        "color": "text"
      },
      "last_change": {
        "id": 1,
        "old_status_id": null,
        "new_status_id": null,
        "location": {
          "lat": 1,
          "lng": 1,
          "address": "text"
        },
        "changed": "text",
        "origin": "supervisor"
      }
    }
  }
}

Errors

These errors come in addition to the general error codes:

  • 217 - List contains nonexistent entities, when one of the given tracker IDs belongs to no tracker, or to a tracker owned by another user.

  • 221 - Device limit exceeded, when the device limit set for the user's telematics service provider (TSP) has been exceeded.

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


Read tracker's working status

post
/status/tracker/read

Return one tracker's current working status and the last change to it.

Both may be null: current_status is null when no status is set now, and last_change is null when the status has never changed.

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
tracker_idinteger · min: 1Required

ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked.

Responses
200

The tracker's working status

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

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

{
  "tracker_id": 1
}
{
  "success": true,
  "current_status": {
    "id": 1,
    "label": "text",
    "color": "text"
  },
  "last_change": {
    "id": 1,
    "old_status_id": null,
    "new_status_id": null,
    "location": {
      "lat": 1,
      "lng": 1,
      "address": "text"
    },
    "changed": "text",
    "origin": "supervisor"
  }
}

Errors

These errors come in addition to the general error codes:

  • 201 - Not found in the database, when the authorized user has no tracker with the given ID.

  • 208 - Device blocked, when the tracker exists but is blocked, whether by tariff restrictions or for another reason.

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

Last updated

Was this helpful?