Availability
List the unavailabilities of a resource
Returns the windows in which a person, a vehicle or a space is NOT available.
Request examples
curl 'https://app.filmo.io/api/v1/availability/unavailabilities?resourceType=staff' \
--header "Authorization: Bearer $FILMO_API_KEY"Generated from the schema
absenceType is emitted for vehicles and spaces, where it is operational, and NOT for people, where it would be health data. The reason for the unavailability is never emitted. Only declarations with state: unavailable that have not ended yet (current or future) are returned: an unavailability disappears from the list once its end date has passed, and available or unknown windows are never listed.
Authorizations
Bearer API key with the scope below. availability:read
Query parameters
Which resources to query.
Available options: staff, vehicle, space
Limit to a specific resource.
Limits: min length 1
Start of the window, in ISO 8601 with offset.
End of the window, in ISO 8601 with offset.
Page size (1-500). Defaults to 50.
Limits: min 1, max 500
Opaque cursor of the page to return. Pass the value of pagination. from the previous response; treat it as opaque.
Limits: max length 200
Response
Successful response.
Response schema: UnavailabilityDto
Envelope: UnavailabilityList. meta. is present only when the operation is deprecated.
Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Show child attributesHide child attributes
Unique identifier of the unavailability.
Which resource: staff, vehicle or space.
Identifier of that resource.
Resource name; null if not recorded.
Start of the unavailability in ISO 8601 UTC.
End of the unavailability in ISO 8601 UTC.
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.
Absence type. Only emitted for vehicles and spaces, where it is operational; for staff it is health data and is returned as null.
Last modification in ISO 8601 UTC; null if not recorded.
Opaque-cursor pagination metadata.
Show child attributesHide child attributes
Opaque cursor of the next page; null when there are no more results. Pass it as cursor in the next request.
Whether more results exist beyond this page.
Number of results matching the filters across all pages. Present only when the request sets includeTotal=true.
Limits: min 0
Additional information about the response.
Show child attributesHide child attributes
Lifecycle warnings; present only when the operation is deprecated.
Show child attributesHide child attributes
Stable warning code.
Available options: deprecated
For people: what is deprecated, until when, and what to use.
Day (YYYY-MM-DD) the operation stops being served.
operationId of the operation to use instead, or null if there is none.
Where the deprecation is documented (the changelog).
Invalid request (validation_error): malformed query or body. errors[] lists every offending field with its stable code.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin).
Headers: X-Request-Id · Content-Language
Not allowed (insufficient_scope: the API key does not have the required scope, named in requiredScope; forbidden: the owner of the key lacks the permission the operation requires). insufficient_scope is answered before the request counts against the rate limit, so it carries no RateLimit-* headers; forbidden does.
Headers: X-Request-Id · Content-Language
Rate limit exceeded (rate_limited): retry after Retry-After seconds; RateLimit-* says which quota ran out.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Retry-After
Internal error (internal_error).
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Errors
| Status | Codes | Meaning |
|---|---|---|
| 400 | validation_error | Malformed query or body. errors[] lists every offending field with its stable code. |
401, 403, 429, 500 can be returned by any operation. Errors
Deprecation
This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy
Related pages
Link to this section: Related pagesCatalog & inventory
Unavailability
Window in which a resource is NOT available.
Was this page helpful?