Home Base [EXPERIMENTAL]

A Home Base is a reusable address that is used to specify the location of Employees or Transport Resources. Instead of specifying a full address for each of these, the user can create a single reusable HomeBase and assign it to all.

Updates to an assigned HomeBase are propagated to all future resources using it.

Operations

Get cursor-based home bases

Request

Retrieve home bases in bulk using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal).

Security

clientCredentials

Query

cursorstring

The cursor of the page to return. No cursor is expected for the initial request. The cursors returned by this endpoint can be used for subsequent requests.

limitinteger, [ 1 .. 1000 ]

Number of results to return per page.

Default:100

Payload

// No request payload

Responses

The results for the current paged request and optional pointers to related result pages.

Bodyapplication/json

dataArray of objects(HomeBase)

The set of results for the current page.

cursorsobject(Cursors)

The cursors represent pointers to pages of results in relation to the page that was retrieved by the current request. These pointers are nullable. For more information on these pointers, view the Developer Portal.

Response

{
  "data": [
    { … }
  ],
  "cursors": {
    "previous": "string",
    "self": "string",
    "next": "string"
  }
}