Tracker's working status¶

This resource contains methods to read and assign working status of a particular tracker.

API actions¶

API base path: /status/tracker/.

assign¶

Assign a working status to the tracker.

Parameters¶

Examples¶

curl -X POST 'https://api.navixy.com/v2/status/tracker/assign' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "tracker_id": 123456, "new_status_id": 5}'

https://api.navixy.com/v2/status/tracker/assign?hash=a6aa75587e5c59c32d347da438505fc3&tracker_id=123456&new_status_id=5

Response¶

{
  "success": true,
  "last_change": {
    "id": 11,
    "old_status_id": null,
    "new_status_id": 2,
    "location": {
      "lat": 11.0,
      "lng": 22.0,
      "address": "Jones st, 4"
    },
    "changed": "2015-11-22 02:02:02",
    "origin": "supervisor"
  }
}

• last_change - object describing last change of the status. May be null.
  • old_status_id - int. Previous status ID. May be null.
  • new_status_id - int. Current status ID. May be null.
  • location - object. Location and address at which status change occurred.
  • lat - int. Latitude.
  • lng - int. Longitude.
  • address - string. Address of last change.
  • changed - date/time. Change date and time.
  • origin - enum. Origin – who changed the status ("employee" or "supervisor").

Errors¶

• 13 - Operation not permitted – if status list does not allow for a supervisor to change status.
• 201 - Not found in the database – if there is no tracker with such ID belonging to authorized user.
• 204 - Entity not found – if there is no status list assigned to this tracker containing with such ID.
• 208 - Device blocked – if tracker exists but was blocked due to tariff restrictions or some other reason.
• 219 - Not allowed for clones of the device – if specified tracker is a clone.
• 236 - Feature unavailable due to tariff restrictions – if there are no trackers with "statuses" tariff feature available.
• 263 - No change needed, old and new values are the same – if new status is equal to current status of tracker.

list¶

Gets current assigned statuses for the specified trackers.

Parameters¶

Examples¶

curl -X POST 'https://api.navixy.com/v2/status/tracker/list' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "trackers": [123456,234567]}'

Response¶

{
    "success": true,
    "value": {
        "5344": {
            "current_status": {
                "id": 66,
                "label": "Busy",
                "color": "FFC107"
            },
            "last_change": {
                "id": 441,
                "old_status_id": 65,
                "new_status_id": 66,
                "location": {
                    "lat": 35.365948,
                    "lng": -108.112104,
                    "address": "Navajo Nation Off-Reservation Trust Land, Chinle, NM, USA"
                },
                "changed": "2017-05-02 07:40:39",
                "origin": "supervisor"
            }
        },
        "15595": {
            "current_status": null,
            "last_change": {
                "id": 123,
                "old_status_id": 67,
                "new_status_id": null,
                "location": {
                    "lat": 34.178868, 
                    "lng": -118.599672,
                    "address": ""
                },
                "changed": "2016-03-14 04:58:32",
                "origin": "employee"
            }
        }
    }
}

• value - Map with a tracker's IDs as keys.
  • current_status - Status object showing current status of tracker. May be null.
  • last_change - Object describing last change of the status. May be null.
  • old_status_id - int. Previous status ID. May be null.
  • new_status_id - int. Current status ID. May be null.
  • location - Location and address at which status change occurred.
  • changed - date/time. Date and time of change.
  • origin - enum. Origin – who changed the status ("employee" or "supervisor").

Errors¶

• 217 - List contains nonexistent entities - if one or more of tracker IDs belong to nonexistent tracker (or to a tracker belonging to different user).
• 221 - Device limit exceeded – if device limit set for the user's dealer has been exceeded.
• 236 - Feature unavailable due to tariff restrictions – if there are no trackers with "statuses" tariff feature available.

read¶

Gets current assigned working status of the tracker.

Parameters¶

Examples¶

curl -X POST 'https://api.navixy.com/v2/status/tracker/read' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "tracker_id": 123456}'

https://api.navixy.com/v2/status/tracker/read?hash=a6aa75587e5c59c32d347da438505fc3&tracker_id=123456

Response¶

{
  "success": true,
  "current_status": {
    "id": 2,
    "label": "On duty",
    "color": "FFFF99"
  },
  "last_change": {
    "id": 11,
    "old_status_id": null,
    "new_status_id": 2,
    "location": {
      "lat": 11.0,
      "lng": 22.0,
      "address": "Jones st, 4"
    },
    "changed": "2015-11-22 02:02:02",
    "origin": "supervisor"
  }
}

• current_status - status object showing current status of tracker. May be null.
• last_change - object describing last change of the status. May be null.
  • old_status_id - int. Previous status ID. May be null.
  • new_status_id - int. Current status ID. May be null.
  • location - Location and address at which status change occurred.
  • changed - date/time. Date and time of change.
  • origin - enum. Origin – who changed the status ("employee" or "supervisor").

Errors¶

• 201 - Not found in the database – if there is no tracker with such ID belonging to authorized user.
• 208 - Device blocked – if tracker exists but was blocked due to tariff restrictions, or some other reason.
• 219 - Not allowed for clones of the device – if specified tracker is a clone.
• 236 - Feature unavailable due to tariff restrictions – if there are no trackers with "statuses" tariff feature available.