Get all availability adjustments
POST /api/connector/v1/availabilityAdjustments/getAll
Returns all availability adjustments. Note this operation uses Pagination and supports Portfolio Access Tokens.
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.
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
object
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
Unique identifiers of the requested Availability adjustments.
Interval in which the availability adjustments were updated.
object
Whether to return only active, only deleted, or both types of record. If not specified, only active records will be returned.
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "AvailabilityAdjustmentIds": [ "e19297af-373e-4701-b4ea-afae0129bded", "7413724a-6c48-46d4-ab3a-afae01280999" ], "UpdatedUtc": { "StartUtc": "2023-02-18T18:00:10.155Z", "EndUtc": "2023-02-20T18:00:10.155Z" }, "ActivityStates": [ "Active", "Deleted" ], "EnterpriseIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6", "4d0201db-36f5-428b-8d11-4f0a65e960cc" ], "Limitation": { "Count": 100 }}Responses
Section titled “ Responses ”OK
object
Availability adjustments.
object
Unique identifier of the Availability adjustment.
Unique identifier of the Availability block which the availability adjustment belongs to.
Unique identifier of the Resource category whose availability is updated.
Start of the interval in UTC timezone in ISO 8601 format.
End of the interval in UTC timezone in ISO 8601 format.
Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format.
End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format.
Adjustment value applied on the interval.
Shows whether the availability adjustment is active or deleted.
Deleted
Active
Exact moment the availability adjustment is released if set; overrides the release strategy of the associated availability block.
Last update date and time of the adjustment in UTC timezone in ISO 8601 format.
Whether the availability adjustment is still active.
Collection of predicted occupancy of availability adjustments. Relates to how many adjustments are assigned to each count of guests.
object
Predicted guest count that will be assigned to the Resource. The guest count must fit within the Resource Category maximum capacity.
Positive number of adjustments that are assigned to PersonCount. The sum of all UnitCount in PaxCounts should match the adjustment value applied to the interval.
Exact moment the first time unit of the availability adjustment is released based on ReleaseOverrideUtc or the ReleaseStrategy of the associated availability block, or the OperationalEditableHistoryInterval of the associated enterprise if not set, or null if AvailabilityBlockId is null.
Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
Example
{ "AvailabilityAdjustments": [ { "Id": "e19297af-373e-4701-b4ea-afae0129bded", "AvailabilityBlockId": "5ee074b1-6c86-48e8-915f-c7aa4702086f", "ResourceCategoryId": "773d5e42-de1e-43a0-9ce6-f940faf2303f", "StartUtc": null, "EndUtc": null, "FirstTimeUnitStartUtc": "2021-10-14T00:00:00Z", "LastTimeUnitStartUtc": "2021-10-17T00:00:00Z", "UnitCount": 6, "ActivityState": "Active", "ReleaseOverrideUtc": "2021-10-13T00:00:00Z", "UpdatedUtc": "2021-10-21T13:32:32Z", "IsActive": false, "PaxCounts": null, "FirstTimeUnitReleaseUtc": "2021-10-13T00:00:00Z" }, { "Id": "7413724a-6c48-46d4-ab3a-afae01280999", "AvailabilityBlockId": null, "ResourceCategoryId": "773d5e42-de1e-43a0-9ce6-f940faf2303f", "StartUtc": null, "EndUtc": null, "FirstTimeUnitStartUtc": "2023-02-19T23:00:00Z", "LastTimeUnitStartUtc": "2023-02-23T23:00:00Z", "UnitCount": 5, "ActivityState": "Deleted", "ReleaseOverrideUtc": null, "UpdatedUtc": "2023-02-28T23:00:00Z", "IsActive": false, "PaxCounts": null, "FirstTimeUnitReleaseUtc": null } ], "Cursor": "7413724a-6c48-46d4-ab3a-afae01280999"}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.