Get all cancellation policies
POST /api/connector/v1/cancellationPolicies/getAll
Restricted!
This operation is currently in beta-test and as such it is subject to change. Returns all cancellation policies, filtered by services, rate groups and other filters. 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 Service.
Unique identifiers of the Cancellation Policy. Required if no other filter is provided.
Unique identifiers of the Rate group. Required if no other filter is provided.
Interval in which the Cancellation Policy was updated. Required if no other filter is provided.
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", "EnterpriseIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6", "4d0201db-36f5-428b-8d11-4f0a65e960cc" ], "ServiceIds": [ "e654f217-d1b5-46be-a820-e93ba568dfac" ], "CancellationPolicyIds": [ "fe795f96-0b64-445b-89ed-c032563f2bac" ], "RateGroupIds": [ "deb9444e-6897-4f2a-86b4-aff100c2896e" ], "UpdatedUtc": { "StartUtc": "2023-04-27T11:48:57Z", "EndUtc": "2023-04-27T11:48:57Z" }, "Limitation": { "Count": 10 }}Responses
Section titled “ Responses ”OK
object
The filtered cancellation policies.
object
Unique identifier of the cancellation policy.
Unique identifier of the rate group the cancellation policy belongs to.
Date and time of the cancellation policy creation in UTC timezone in ISO 8601 format.
Date and time of the cancellation policy update in UTC timezone in ISO 8601 format.
Applicability mode of the cancellation policy.
Extent for the cancellation fee, i.e. what should be in scope for the automatic payment.
Offset for order start (assuming Applicability is set to Start) from which the fee is applied.
Maximum number of time units the cancellation fee is applicable to.
Absolute value of the fee.
object
Relative value of the fee, as a percentage of the reservation price.
Whether the cancellation policy is still active.
Unique identifier of the last and hence oldest cancellation policy returned. This can be used in Limitation in a subsequent request to fetch the next batch of older cancellation policies.
Example
{ "CancellationPolicies": [ { "Id": "769fc613-838f-41a7-ac2a-aff100c3189f", "RateGroupId": "deb9444e-6897-4f2a-86b4-aff100c2896e", "CreatedUtc": "2023-04-27T11:48:57Z", "UpdatedUtc": "2023-04-27T11:48:57Z", "Applicability": "Creation", "FeeExtent": [ "TimeUnits", "Products" ], "ApplicabilityOffset": "0M0D0:0:0.0", "FeeMaximumTimeUnits": 0, "AbsoluteFee": { "Currency": "EUR", "Value": 15 }, "RelativeFee": 0 } ], "Cursor": "769fc613-838f-41a7-ac2a-aff100c3189f"}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.