Cancellation policies
Get all cancellation policies
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
[PlatformAddress]/api/connector/v1/cancellationPolicies/getAll
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | optional, max 1000 items | Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. |
| array of string | required, max 100 items | Unique identifiers of the Service. |
| array of string | optional, max 1000 items | Unique identifiers of the Cancellation Policy. Required if no other filter is provided. |
| array of string | optional, max 1000 items | Unique identifiers of the Rate group. Required if no other filter is provided. |
| optional, max length 3 months | Interval in which the Cancellation Policy was updated. Required if no other filter is provided. | |
| array of Activity state | optional | Whether to return only active, only deleted, or both types of record. If not specified, only active records will be returned. |
| required | Limitation on the quantity of data returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Cancellation Policy | required, max 1000 items | The filtered cancellation policies. |
| string | optional | 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. |
Cancellation Policy
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the cancellation policy. |
| string | required | Unique identifier of the rate group the cancellation policy belongs to. |
| string | required | Date and time of the cancellation policy creation in UTC timezone in ISO 8601 format. |
| string | required | Date and time of the cancellation policy update in UTC timezone in ISO 8601 format. |
| required | Applicability mode of the cancellation policy. | |
| array of Cancellation Fee Extent | required | Extent for the cancellation fee, i.e. what should be in scope for the automatic payment. |
| string | required | Offset for order start (assuming Applicability is set to Start) from which the fee is applied. |
| integer | optional | Maximum number of time units the cancellation fee is applicable to. |
| required | Absolute value of the fee. | |
| number | required | Relative value of the fee, as a percentage of the reservation price. |
| boolean | required | Whether the cancellation policy is still active. |
Cancellation Policy Applicability
Creation
Start
StartDate
Cancellation Fee Extent
TimeUnits
Products
Last updated