Products
/
Better Route
/
Better Route Deep Integration
/
Tour Commander API
/
Custom 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

Custom Job

Operations on custom jobs

Operations

Create a custom job

Request

Creates a custom job

Path
tourIdstring(uuid)required

Unique tour identifier (generated by Better Route backend)

Bodyapplication/json
rawAddressstring[ 1 .. 500 ] characters

Address in a format suitable for geocoding

countryCodestring= 2 characters

Two letter country code defined in ISO 3166-1

Example: "US"
externalIdstring or null<= 200 characters

Optional ID that can used to identify the job. If provided, this value must not collide with externalId on any other job.

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

Responses

Successfully created a custom job

Bodyapplication/json
jobIdstring(uuid)

Internal ID assigned to this job by the backend

waypointIdstring(uuid)

Internal ID of (potentially new) waypoint to which the job has been assigned

Response
application/json
{
  "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  "waypointId": "6eeaf5f6-415c-49ff-97fc-2d3cc3a134f5"
}

Deletes a custom job

Request

Deletes a custom job

Path
tourIdstring(uuid)required

Unique tour identifier (generated by Better Route backend)

jobIdstring(uuid)required

Unique job identifier (generated by Better Route backend)

curl -i -X DELETE \
  'https://dev.routes.bettermile.com/v1/tours/{tourId}/custom-jobs/{jobId}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully deleted the custom job

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

Custom Waypoint

Operations on custom waypoints

Operations