Catalog & inventory

Unavailability

Window in which a resource is NOT available.

Schemas: UnavailabilityDto

{
  "id": "id_8f2a1c",
  "resourceType": "string",
  "resourceId": "string",
  "resourceName": "Example",
  "startDate": "2026-09-01T08:00:00Z",
  "endDate": "2026-09-01T08:00:00Z",
  "state": "string",
  "absenceType": "string",
  "updatedAt": "2026-09-01T08:00:00Z"
}

Generated from the schema

A window in which a person, a vehicle or a space is not available. absenceType is published for vehicles and spaces, where it is operational, and not for people. The reason for the unavailability is never published. Only manual unavailabilities that have not started can be deleted.

Attributes

idstring

Unique identifier of the unavailability.

resourceTypestring

Which resource: staff, vehicle or space.

resourceIdstring

Identifier of that resource.

resourceNamestring | null

Resource name; null if not recorded.

startDatestring<date-time>

Start of the unavailability in ISO 8601 UTC.

endDatestring<date-time>

End of the unavailability in ISO 8601 UTC.

statestring

Declared state. This list only returns unavailable windows that have not ended yet, so it is always unavailable here; available and unknown exist as declarations but are not listed.

absenceTypestring | null

Absence type. Only emitted for vehicles and spaces, where it is operational; for staff it is health data and is returned as null.

updatedAtstring<date-time> | null

Last modification in ISO 8601 UTC; null if not recorded.

Returned by

GET /api/v1/availability/unavailabilities — List the unavailabilities of a resource

Modified by

No operation.

Was this page helpful?