Skip to content

Routes

Routes basically named and ordered set of checkpoints. Each checkpoint is essentially a task with an additional link to the parent route.

Route completed if all the checkpoints completed and visited in the specified order. Otherwise, it is considered completed with warnings or failed.


Route object

{
    "id": 111,
    "user_id": 3,
    "tracker_id": 222653,
    "label": "Deliver parcels",
    "description": "Quickly",
    "creation_date": "2014-01-02 03:04:05",
    "from": "2014-02-03 04:05:06",
    "to": "2014-03-04 05:06:07",
    "external_id": null,
    "status": "assigned",
    "status_change_date": "2014-01-02 03:04:05",
    "origin": "imported",
    "tags": [1, 2],
    "checkpoint_ids": [2977,2978],
    "type": "route"
}
  • id - int. Primary key used in route/update, IGNORED in route/create.
  • user_id - int. User id. IGNORED in route/create and route/update.
  • tracker_id - int. An id of the tracker to which route assigned. Can be null. IGNORED in route/update.
  • creation_date - date/time. When route created. IGNORED in route/create, route/update.
  • from - date/time. Date AFTER which first checkpoint zone must be visited, depends on first checkpoint from, IGNORED in route/create, route/update.
  • to - date/time. Date BEFORE which last checkpoint zone must be visited, depends on last checkpoint to, IGNORED in route/create, route/update.
  • external_id - string. Used if route imported from external system. arbitrary text string. Can be null.
  • status - string. A route status. IGNORED in route/create, route/update.
  • status_change_date - date/time. When route status changed. IGNORED in route/create, route/update.
  • origin - string. A route origin. IGNORED in route/create, route/update.
  • tags - int array. List of tag ids.
  • checkpoint_ids - int array. List of route checkpoint ids in order of execution. IGNORED in route/create.

API actions

API base path: /task/route.

assign

(Re)assigns route to a new tracker (or make it unassigned).

required sub-user rights: task_update.

parameters

name description type
route_id ID of the route to assign. int
tracker_id ID of the tracker. Tracker must belong to authorized user and not be blocked. If null, task will be assigned to none. int

examples

curl -X POST 'https://api.navixy.com/v2/task/route/assign' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "route_id": 11231, "tracker_id": 223465}'
https://api.navixy.com/v2/task/route/assign?hash=a6aa75587e5c59c32d347da438505fc3&route_id=11231&tracker_id=223465

response

{
    "success": true
}

errors

  • 201 – Not found in the database - if there is no task with such an id.
  • 204 – Entity not found - 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.
  • 255 – Invalid task state - if current task state is not "unassigned" or "assigned".
  • 236 – Feature unavailable due to tariff restrictions - if device's tariff does not allow usage of tasks.

create

Creates a new route. One of checkpoints can have id (in this case it must be a task) - it will be transmuted from task to checkpoint.

required sub-user rights: task_update.

parameters

name description type
route Route object without fields which are IGNORED. JSON object
checkpoints Array of checkpoint objects without fields which are IGNORED. array of JSON objects
create_form If true then check additional form_template_id field in every checkpoint object and create form if it is not null. Default value is false for backward compatibility. boolean

Minimal route object to create a new route must contain:

{
"tracker_id": 223652,
"label": "Name",
"description": "Description example"
}

Also, need checkpoints list in order of execution, checkpoints from and to must be agreed with each other i.e. checkpoint to cannot be before 'from' of preceding items.

{
    "tracker_id": 223652,
    "location": {
        "lat": 56.83717295,
        "lng": 60.59761920,
        "radius": 150
    },
    "label": "Name",
    "description": "Description example",
    "from": "2014-02-03 04:05:06",
    "to": "2014-03-04 05:06:07"
}
  • tracker_id - int. Optional. If the field specified then the task will be assigned to the employee associated with the tracker, otherwise it won't be assigned to anybody.
  • location - area (circle geofence), entering and leaving of geofence will be controlled.
    • lat - float. Latitude.
    • lng - float. Longitude.
    • radius - int. Radius in meters.
  • label - string. Task name, length 1-200 characters.
  • description - string. Task description, length 0-1024 characters.
  • from - date/time. Start date of the interval - when the specified location has to be visited (in the user's time zone).
  • to - date/time. End date of the interval - when the specified location has to be visited (in the user's time zone).

example

curl -X POST 'https://api.navixy.com/v2/task/route/create' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "tracker_id": 223652, "label": "Name", "description": "Description example", "checkpoints": [{"tracker_id": 223652, "location": { "lat": 56.83717295, "lng": 60.59761920, "radius": 150}, "label": "Name", "description": "Description example", "from": "2014-02-03 04:05:06", "to": "2014-03-04 05:06:07"}], "create_form": false}'

response

Call returns JSON object of the created route. In response there will be external ids which have count greater than zero. There can be multiple external ids in response because you can specify different external ids in a task's checkpoint. If there is nothing to return, then parameter "external_id_counts" will not be present in response.

{
    "success": true,
    "result": {
        "id": 111,
        "user_id": 3,
        "tracker_id": 22,
        "label": "Deliver parcels",
        "description": "Quickly",
        "creation_date": "2014-01-02 03:04:05",
        "from": "2014-02-03 04:05:06",
        "to": "2014-03-04 05:06:07",
        "external_id": null,
        "status": "assigned",
        "status_change_date": "2014-01-02 03:04:05",
        "origin": "manual",
        "checkpoint_ids": [2977,2978],
        "type": "route"
    },
    "external_id_counts": [{"external_id": "456", "count": 2}]
}
  • checkpoint_ids - int array. A list of route checkpoint ids in order of execution.
  • external_id_counts - optional object. Count of external ids.

errors

  • 201 – Not found in the database - if task.tracker_id is not null and belongs to nonexistent tracker.
  • 236 – Feature unavailable due to tariff restrictions - if device's tariff does not allow usage of tasks.

delete

Deletes route (and its checkpoints) with the specified id.

required sub-user rights: task_update.

parameters

name description type
route_id ID of the route to delete. int

examples

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

response

{
    "success": true
}

errors

  • 201 – Not found in the database - if there is no route with such an id.

list

Get all routes belonging to user with optional filtering.

parameters

name description type
statuses Optional. List of task statuses, e.g. ["unassigned","failed"]. Default all. enum array
trackers Optional. List of tracker_id to which task assigned. int array
from Optional. Show tasks which are actual AFTER this date, e.g. "2020-06-01 00:00:00". date/time
to Optional. Show tasks which are actual BEFORE this date, e.g. "2020-07-01 00:00:00". date/time
filter Optional. Filter for task label and description. If trackers, filter, from or to is not passed or null then appropriate condition not used to filter results. string

examples

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

response

{
    "success": true,
    "list": [{
         "id": 111,
         "user_id": 3,
         "tracker_id": 222653,
         "label": "Deliver parcels",
         "description": "Quickly",
         "creation_date": "2014-01-02 03:04:05",
         "from": "2014-02-03 04:05:06",
         "to": "2014-03-04 05:06:07",
         "external_id": null,
         "status": "assigned",
         "status_change_date": "2014-01-02 03:04:05",
         "origin": "imported",
         "tags": [1, 2],
         "checkpoint_ids": [2977,2978],
         "type": "route"
    }]
}

errors

General types only.


read

Gets route by specified id.

parameters

name description type
route_id ID of the route. int

response

{
    "success": true,
    "value":  {
          "id": 111,
          "user_id": 3,
          "tracker_id": 222653,
          "label": "Deliver parcels",
          "description": "Quickly",
          "creation_date": "2014-01-02 03:04:05",
          "from": "2014-02-03 04:05:06",
          "to": "2014-03-04 05:06:07",
          "external_id": null,
          "status": "assigned",
          "status_change_date": "2014-01-02 03:04:05",
          "origin": "imported",
          "tags": [1, 2],
          "checkpoint_ids": [2977,2978],
          "type": "route"
    }
}
  • value - route object described here.

errors

  • 201 – Not found in the database - if there is no route with such an id.

update

Updates existing route. Note that you cannot change task owner using this method.
Reordering checkpoint IDs in the checkpoint_ids array changes order of execution.

required sub-user rights: task_update.

parameters

name description type
route Route object without fields which are IGNORED. JSON object
checkpoints List of checkpoint objects objects. Should be null if route's field checkpoint_ids is null, otherwise should be not null. If entry contains id, then update existing checkpoint, else create a new one. Present route's checkpoints, which are not included in this array, will be deleted. array of objects
create_form If true then check additional form_template_id field in every checkpoint object and create, replace or delete checkpoint's form. Default value is false for backward compatibility. boolean

response

JSON object of the updated route with checkpoint_ids

{
        "success": true,
        "result": {
            "id": 111,
            "user_id": 3,
            "tracker_id": 22,
            "label": "Deliver parcels",
            "description": "Quickly",
            "creation_date": "2014-01-02 03:04:05",
            "from": "2014-02-03 04:05:06",
            "to": "2014-03-04 05:06:07",
            "external_id": null,
            "status": "assigned",
            "status_change_date": "2014-01-02 03:04:05",
            "origin": "manual",
            "checkpoint_ids": [2977,2978],
            "type": "route"
        }
}

errors

  • 201 – Not found in the database - if there is no task with such an id.
  • 255 – Invalid task state - if current task state is not "unassigned" or "assigned".

Last update: May 27, 2021