v3

OpenAPI 3.0.42026-07-312008682.1 MB

Services

Get service availability (ver 2024-01-22)

Returns selected availability and occupancy metrics of a bookable service for a specified time interval, similar to the availability & occupancy report. Availability will be returned for all service time units that the specified time interval intersects. So, for example, an interval 1st Jan 23:00 UTC - 1st Jan 23:00 UTC will result in one time unit for 2nd Jan, while Interval 1st Jan 23:00 UTC - 2nd Jan 23:00 UTC will result in two time units for 2nd Jan and 3rd Jan (assuming a time unit period of "Day"). UTC timestamps must correspond to the start boundary of a time unit, e.g. 00:00 converted to UTC for a time unit of "Day". Other timestamps are not permitted. The maximum size of time interval depends on the service's time unit: 367 hours if hours, 367 days if days, or 60 months if months. For more information about time units, see Time unit.

post/api/connector/v1/services/getAvailability/2024-01-22

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

ServiceIdstring uuid required

Unique identifier of the Service whose availability should be returned.

FirstTimeUnitStartUtcstring date-time required

Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format.

LastTimeUnitStartUtcstring date-time required

End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format. The maximum size of time interval depends on the service's time unit: 367 hours if hours, 367 days if days, or 60 months if months.

MetricsResourceAvailabilityMetricTypeEnum[] required

Set of Service availability metrics to be returned.

Response

TimeUnitStartsUtcstring[] required

Set of all time units covered by the time interval; expressed in UTC timezone ISO 8601 format.