Partial Routes [EXPERIMENTAL]

[EXPERIMENTAL] [UNDER DEVELOPMENT] Endpoints for managing preplanned PartialRoutes.

Operations

[EXPERIMENTAL] Get a cursor-paged list of preplanned partial routes

Request

[EXPERIMENTAL] Retrieve a cursor-paged list of all preplanned partial routes.

You can find out more about how to use cursors in our developer portal.

Security

clientCredentials

Query

cursorstring

Cursor of the page to retrieve. Can be left blank initially to retrieve the first page. Paging through the results requires passing in the cursor from a previous response.

limitinteger, (int32), [ 1 .. 1000 ]

Number of results per page.

Default:100

Payload

// No request payload

Responses

A cursor-based paged set of preplanned partial routes. The set might be empty if no routes are present.

Bodyapplication/json

dataArray of objects(PreplannedPartialRouteSummary)required

Subset of preplanned partial routes matching the provided query, limited to the size specified in the request.

cursorobject(Cursor)required

Response

{
  "data": [
    { … }
  ],
  "cursor": {
    "self": "c2VsZl9fcGFnZQ",
    "prev": "cHJldmlvdXNfX3BhZ2U",
    "next": "bmV4dF9fcGFnZQ"
  }
}