API referenceEndpoints
Search bays
Returns bays matching optional text, station area and status filters.
GET
/referential/v1/baysReturns bays matching optional text, station area and status filters.
Authorization
oauth2 AuthorizationBearer <token>
In: header
Query Parameters
search?string
Matches part of a bay code.
Default
nullstationAreaId.value?string
status?string
Restrict to one lifecycle status; defaults to ACTIVE.
Default
nullValue in
- "ACTIVE"
- "DECOMMISSIONED"
- "ACTIVE"
- "DECOMMISSIONED"
sort?string
Result ordering.
Default
nullValue in
- "codeAsc"
- "codeDesc"
- "newest"
- "oldest"
- "codeAsc"
- "codeDesc"
- "newest"
- "oldest"
- "codeAsc"
- "codeDesc"
- "newest"
- "oldest"
page?integer
Zero-based page index.
Format
int32Range
0 <= valueDefault
nullsize?integer
Page size, at most 200.
Format
int32Range
0 <= value <= 200Default
nullResponse Body
*/*
curl -X GET "https://example.com/referential/v1/bays"{ "data": [ { "id": "string", "stationAreaId": "string", "code": "string", "position": 0, "lengthM": 0, "heightM": 0, "status": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "page": 0, "size": 0, "total": 0}