Waypoint

Operations on the waypoint level

Pin waypoint timeframe

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.

SecurityApiKeyAuth
Request
path Parameters
tourId
required
string <uuid>

Unique tour identifier (generated by Better Route backend)

waypointId
required
string <uuid>

Unique waypoint identifier (generated by Better Route backend)

Request Body schema: application/json
object or null

Time window with earliest and latest possible time

Responses
200

Timeframe has been successfully pinned

400

Error response returned when the request is invalid. In most cases this implies that some data in the request is either missing or has incorrect format.

401

Error response returned when the provided API key is missing or invalid

404

Error response returned in cases the requested endpoint or data can't be found

500

Error response returned whenever the server fails to process the request

put/v1/tours/{tourId}/waypoints/{waypointId}/time-frame
Request samples
application/json
{
  • "timeFrame": {
    }
}
Response samples
application/json
{
  • "data": { }
}

Pin waypoint stop time

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

SecurityApiKeyAuth
Request
path Parameters
tourId
required
string <uuid>

Unique tour identifier (generated by Better Route backend)

waypointId
required
string <uuid>

Unique waypoint identifier (generated by Better Route backend)

Request Body schema: application/json
stopTime
number <int64> [ 1 .. 10800 ]

Stop time in seconds

Responses
200

Stop time has been successfully pinned

400

Error response returned when the request is invalid. In most cases this implies that some data in the request is either missing or has incorrect format.

401

Error response returned when the provided API key is missing or invalid

404

Error response returned in cases the requested endpoint or data can't be found

500

Error response returned whenever the server fails to process the request

put/v1/tours/{tourId}/waypoints/{waypointId}/stop-time
Request samples
application/json
{
  • "stopTime": 1
}
Response samples
application/json
{
  • "data": { }
}

Unpin waypoint stop time

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.

SecurityApiKeyAuth
Request
path Parameters
tourId
required
string <uuid>

Unique tour identifier (generated by Better Route backend)

waypointId
required
string <uuid>

Unique waypoint identifier (generated by Better Route backend)

Responses
200

Stop time has been successfully unpinned

400

Error response returned when the request is invalid. In most cases this implies that some data in the request is either missing or has incorrect format.

401

Error response returned when the provided API key is missing or invalid

404

Error response returned in cases the requested endpoint or data can't be found

500

Error response returned whenever the server fails to process the request

delete/v1/tours/{tourId}/waypoints/{waypointId}/stop-time
Request samples 
Response samples 
application/json
{
  • "data": { }
}