Get service availability (ver 2024-01-22)
POST /api/connector/v1/services/getAvailability/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.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Unique identifier of the Service whose availability should be returned.
Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format.
Set of Service availability metrics to be returned.
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "FirstTimeUnitStartUtc": "2024-02-01T23:00:00.000Z", "LastTimeUnitStartUtc": "2024-02-05T23:00:00.000Z", "Metrics": [ "OutOfOrderBlocks", "PublicAvailabilityAdjustment", "OtherServiceReservationCount", "Occupied", "ConfirmedReservations", "OptionalReservations", "BlockAvailability", "AllocatedBlockAvailability", "UsableResources", "ActiveResources" ]}Responses
Section titled “ Responses ”OK
object
Set of all time units covered by the time interval; expressed in UTC timezone ISO 8601 format.
Resource category availabilities. Can be empty if no resource categories are assigned to the service.
object
Unique identifier of the Resource category.
Dictionary keys are names of Service availability metrics, values are arrays of integers with metric values for corresponding time unit in TimeUnitStartsUtc.
object
Example
{ "TimeUnitStartsUtc": [ "2024-01-31T23:00:00Z", "2024-02-01T23:00:00Z", "2024-02-02T23:00:00Z", "2024-02-03T23:00:00Z", "2024-02-04T23:00:00Z" ], "ResourceCategoryAvailabilities": [ { "ResourceCategoryId": "d1801d11-fe8d-404b-a26f-af170189605a", "Metrics": { "OutOfOrderBlocks": [ 0, 1, 0, 0, 1 ], "PublicAvailabilityAdjustment": [ 7, 5, 4, 3, 4 ], "OtherServiceReservationCount": [ 0, 0, 1, 0, 0 ], "Occupied": [ 7, 5, 4, 3, 4 ], "ConfirmedReservations": [ 7, 5, 4, 3, 4 ], "OptionalReservations": [ 0, 2, 0, 0, 1 ], "BlockAvailability": [ 0, 0, 1, 0, 0 ], "AllocatedBlockAvailability": [ 0, 0, 0, 1, 0 ], "UsableResources": [ 8, 8, 8, 8, 8 ], "ActiveResources": [ 8, 8, 8, 8, 8 ] } } ]}Server has successfully fulfilled the request and there is no additional information to send back.
object
Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
object
Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts
object
Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.
object
Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.