Task schedule checkpoints

Delete or convert a checkpoint on a scheduled route.

These operations work on the checkpoints of a scheduled route, the same way checkpoints work on an ordinary one.

A route schedule must keep at least two checkpoints. When only two remain, convert the other checkpoint with transmute rather than deleting this one.

API actions

API base path: /task/schedule/checkpoint.

Operations that list no errors of their own return only the general error codes.

A route schedule must keep at least two checkpoints. If the route has only two left, use transmute on the other checkpoint rather than deleting this one.

---

Required sub-user rights: task_update.

Delete schedule checkpoint

post

/task/schedule/checkpoint/delete

Delete one checkpoint from a route schedule and reorder the rest.

A route schedule must keep at least 2 checkpoints. When only two are left, use task/schedule/checkpoint/transmute on the other one instead of deleting this one.

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

Requires the task_update right.

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

checkpoint_idinteger · min: 1Required

ID of the checkpoint schedule.

Responses

200

Checkpoint schedule deleted

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

default

Error response object

application/json

post/task/schedule/checkpoint/delete

POST /v2/task/schedule/checkpoint/delete HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "checkpoint_id": 1
}

{
  "success": true
}

---

Required sub-user rights: task_update.

Convert schedule checkpoint to task

post

/task/schedule/checkpoint/transmute

Convert a checkpoint schedule into a task schedule, deleting its route schedule and every other checkpoint on it.

This is the way out when a route schedule is down to two checkpoints and one is no longer wanted.

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

Requires the task_update right.

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

checkpoint_idinteger · min: 1Required

ID of the checkpoint schedule.

Responses

200

Checkpoint schedule converted

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

default

Error response object

application/json

post/task/schedule/checkpoint/transmute

POST /v2/task/schedule/checkpoint/transmute HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "checkpoint_id": 1
}

{
  "success": true
}