Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-08-06130577659.7 KB
Disposition|Tour

Set the status of the tour.

This endpoint allows you to set the status of a tour in geoCapture with the ID of the tour and the new status. The NEW status describes new tours that have not yet been calculated or tours that have been changed. The FIXED status of the tour alerts the user if they want to change the tour details. The CALCULATED status is designated for calculated tours. Tours with the status READY are displayed to drivers in their app.

get/tour/set_status

Query parameters

idinteger required

The internal id of the tour. This Parameter is required.

statusstring required

The status to be set. This Parameter is required.

Values
NEW
CALCULATED
FIXED
READY
STARTED
FINISHED

Response

Success Response:

Example response

{
  "data": {
    "startDate": "2015-02-20",
    "stops": [
      {
        "latLng": [
          52.38127828631681,
          7.594243214018696
        ],
        "eta": "2015-02-20T12:59:21+01:00",
        "etd": "2015-02-20T12:59:21+01:00",
        "ata": "2015-02-20T12:59:21+01:00",
        "atd": "2015-02-20T12:59:21+01:00",
        "orders": [
          {
            "createdAt": "2015-02-20T12:59:21+01:00"
          }
        ]
      }
    ],
    "startTime": "2015-02-20T12:59:21+01:00",
    "endTime": "2015-02-20T12:59:21+01:00"
  }
}