[EXPERIMENTAL] Vehicle Stop Rules

Endpoints used for managing vehicle stop rule sets.

Operations

List the existing vehicle stop rule sets

Request

Retrieve vehicle stop rule sets using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal for more details).

Security

clientCredentials

Query

cursorstring

The cursor of the page to retrieve. No cursor is needed to retrieve the first page.

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

The maximum amount of vehicle stop rule sets that should be returned in the response

Default:100

Example:limit=100

Payload

// No request payload

Responses

Bodyapplication/json

dataArray of objects(VehicleStopRuleSetListSummary)required

Subset of vehicle stop rule sets matching the provided query, limited to the limit specified in the request.

cursorsobject(CursorsWithOnlyNext)required

Cursor that only supports next cursor navigation.

Response

{
  "data": [
    { … }
  ],
  "cursors": {
    "next": "bmV4dF9fcGFnZQ"
  }
}