Products
/
Better Route
/
Better Route Deep Integration
/
Tour Commander API
/
Job

Tour Commander API (1.0.0)

Part of Bettermile Route API responsible for tour management

Download OpenAPI description
tour-commander-api.json
tour-commander-api.yaml
Overview
E-mail

route-api@bettermile.com

License

Proprietary

Languages
Servers
Dev API

https://dev.routes.bettermile.com/

Tour

Operations on the tour level

Operations

Sequence

Operations on the sequence level

Operations

Waypoint

Operations on the waypoint level

Operations

Job

Operations on the job level

Operations

Apply changes to statuses of jobs

Request

Updates the status of one of more jobs, so that these changes can be reflected upon the tour instantly. This is only an auxiliary way for providing Bettermile with job updates, while the main job updates are still to be transmitted over the connector.

Path
tourIdstring(uuid)required

Unique tour identifier (generated by Better Route backend)

Bodyapplication/jsonrequired
statusChangesArray of objects(JobStatusChange)[ 1 .. 150 ] items

List of job status changes to be applied (only 1 status change per job is allowed)

curl -i -X POST \
  'https://dev.routes.bettermile.com/v1/tours/{tourId}/jobs/statuses' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{}'

Responses

Changes to statuses of jobs have been successfully applied

Bodyapplication/json
dataobject
Example: {}
Response
application/json
{
  "data": {}
}

Custom Job

Operations on custom jobs

Operations

Custom Waypoint

Operations on custom waypoints

Operations