Drivers: license expiring
1 operation at https://api.zaitrack.app. Request and response bodies are JSON with camelCase keys; ids are UUIDs; times are RFC 3339 in UTC.
Every operation needs an API key, a personal access token or an OAuth access token unless it says otherwise. An Idempotency-Key is replayed for 24 hours; see Idempotency. Errors are application/problem+json; see Errors.
Drivers whose licence expires soon
GET /v1/drivers/license-expiring
- Scope:
drivers:readordrivers:* - Rate class:
read(100 per second and 360,000 per hour) - Idempotency-Key: not used
- Audited: no
- Step-up MFA: no
| Query parameter | Type | Notes |
|---|---|---|
days | string |
Request
No body.
Response
200: fields the handler writes, taken from its source.
| Field | Type | Notes |
|---|---|---|
items | array of object | |
items[].id | string | |
items[].tenantId | string | |
items[].subOrgId | string | omitted when empty |
items[].employeeNumber | string | |
items[].firstName | string | |
items[].lastName | string | |
items[].dateOfBirth | string | |
items[].nationalIdMasked | string | omitted when empty |
items[].email | string | omitted when empty |
items[].phone | string | omitted when empty |
items[].status | string | |
items[].hireDate | string | |
items[].terminationDate | string | omitted when empty |
items[].license | object | |
items[].license.number | string | |
items[].license.country | string | |
items[].license.classes | array of string | |
items[].license.issuedAt | string | omitted when empty |
items[].license.expiresAt | string | |
items[].license.endorsements | array of string | omitted when empty |
items[].license.LocalClass | — | |
items[].license.authority | string | omitted when empty |
items[].license.localClass | string | omitted when empty |
items[].licenseValid | boolean | |
items[].qualifications | array of object | |
items[].qualifications[].code | string | |
items[].qualifications[].issuedAt | string | |
items[].qualifications[].expiresAt | string | omitted when empty |
items[].qualifications[].issuingBody | string | omitted when empty |
items[].homeRegion | string | omitted when empty |
items[].languages | array of string | |
items[].assignable | boolean | |
items[].nationality | string | omitted when empty |
items[].employment | string | |
items[].contractorCompany | string | omitted when empty |
items[].photo | object | may be null |
items[].photo.contentType | string | |
items[].photo.size | integer | |
items[].photo.updatedAt | string | |
items[].photo.updatedBy | string | omitted when empty |
items[].createdAt | string | |
items[].updatedAt | string | |
items[].version | integer | |
days | — |
Example
curl "https://api.zaitrack.app/v1/drivers/license-expiring" \
-H "Authorization: Bearer zk_test_…"