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

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

Pin waypoint timeframe

Request

Pins the provided timeframe to the waypoint. If the provided timeframe is NULL, the current waypoint timeframe will be removed if present. Calling this endpoint, even with the NULL timeframe, prevents the automatic timeframe resolution logic from running for the affected waypoint.

Path
tourIdstring(uuid)required

Unique tour identifier (generated by Better Route backend)

waypointIdstring(uuid)required

Unique waypoint identifier (generated by Better Route backend)

Bodyapplication/jsonrequired
timeFrameobject or null

Time window with earliest and latest possible time

curl -i -X PUT \
  'https://dev.routes.bettermile.com/v1/tours/{tourId}/waypoints/{waypointId}/time-frame' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{}'

Responses

Timeframe has been successfully pinned

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

Pin waypoint stop time

Request

Pins the provided stop time value to the waypoint. Calling this endpoint "freezes" the stop time of the waypoint at provided value.

Path
tourIdstring(uuid)required

Unique tour identifier (generated by Better Route backend)

waypointIdstring(uuid)required

Unique waypoint identifier (generated by Better Route backend)

Bodyapplication/jsonrequired
stopTimenumber(int64)[ 1 .. 10800 ]

Stop time in seconds

curl -i -X PUT \
  'https://dev.routes.bettermile.com/v1/tours/{tourId}/waypoints/{waypointId}/stop-time' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{}'

Responses

Stop time has been successfully pinned

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

Unpin waypoint stop time

Request

Removes the previously pinned stop time value from the waypoint. Calling this endpoint "unfreezes" the stop time of the waypoint, allowing for the stop time value to be to dynamically calculated.

Path
tourIdstring(uuid)required

Unique tour identifier (generated by Better Route backend)

waypointIdstring(uuid)required

Unique waypoint identifier (generated by Better Route backend)

curl -i -X DELETE \
  'https://dev.routes.bettermile.com/v1/tours/{tourId}/waypoints/{waypointId}/stop-time' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Stop time has been successfully unpinned

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

Job

Operations on the job level

Operations

Custom Job

Operations on custom jobs

Operations

Custom Waypoint

Operations on custom waypoints

Operations