API referenceEndpoints
Search permits approaching or past expiry
Returns a cross-fleet worklist in station time, including the expiry watch's durable announcement history.
GET
/referential/v1/vehicle-permits/expiringReturns a cross-fleet worklist in station time, including the expiry watch's durable announcement history.
Authorization
oauth2 AuthorizationBearer <token>
In: header
Query Parameters
search?string
Matches part of a permit number or vehicle plate.
Default
nullstate?string
Restrict to permits approaching expiry or already expired.
Default
nullValue in
- "ALL"
- "EXPIRING"
- "EXPIRED"
horizonDays?integer
Future window in days, from station today.
Format
int32Range
1 <= value <= 365Default
nullpage?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/vehicle-permits/expiring"{ "data": [ { "id": "string", "vehicleId": "string", "plateNumber": "string", "number": "string", "validFrom": "2019-08-24", "validUntil": "2019-08-24", "source": "string", "daysRemaining": 0, "announcements": [ { "permitId": "string", "kind": "string", "horizonDays": 0, "announcedOn": "2019-08-24", "createdAt": "2019-08-24T14:15:22Z" } ] } ], "page": 0, "size": 0, "total": 0}