Availability blocks
Get all availability blocks
This feature is being actively developed, features and behavior of this operation may change at short notice.
Returns all availability blocks filtered by services, unique identifiers and other filters. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/availabilityBlocks/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. |
| string | optional, max 1000 items | Unique identifiers of the requested Availability blocks. |
| string | optional, max 1000 items | Unique identifiers of the Services to which Availability blocks are assigned. |
| optional, max length 3 months | Interval in which the Availability blocks were created. | |
| optional, max length 3 months | Interval in which the Availability blocks were updated. | |
| optional, max length 3 months | Interval in which the Availability blocks are active. | |
| optional, max length 3 months | Interval in which the Availability blocks are released. | |
| array of string Availability block state | optional | States the availability blocks should be in. |
| string | optional, max 1000 items | Identifiers of Availability blocks from external systems. |
| array of string Activity state | optional | Whether to return only active, only deleted or both records. |
| required | Extent of data to be returned, e.g. it is possible to specify that related service orders (for example reservations) are returned. |
Availability block state
Confirmed
- The block deducts availability and can have reservations assigned.Optional
- The block deducts availability and cannot have reservations assigned.Inquired
- The block does not deduct availability and cannot have reservations assigned (waitlist).Released
- The block deducts availability, but only for reservations assigned to the block before release. Remaining availability is returned back to general availability (waitlist).Canceled
- The block does not deduct availability and cannot have reservations assigned (waitlist).
Availability block extent
Property | Type | Contract | Description |
---|---|---|---|
| bool | optional | Whether the response should contain the general availability blocks. |
| bool | optional | Whether the response should contain individual availability adjustments related to availability blocks. |
| bool | optional | Whether the response should contain reservations related to availability blocks. |
| bool | optional | Whether the response should contain rates related to availability blocks. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Availability block | optional | Availability blocks. |
| array of Reservation | optional | Service orders (for example reservations) linked to availability blocks. |
| array of Availability adjustment | optional | Availability adjustments of availability blocks. |
| string | optional | 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. |
Availability block
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the availability block. |
| string | required | Unique identifier of the Service the block is assigned to. |
| string | required | Unique identifier of the Rate the block is assigned to. |
| string | optional | |
| string | optional | Unique identifier of the Customer on whose behalf the block was made. |
| string | optional | Unique identifier of the Company linked to the block. |
| optional | The tentative budget for the total price of reservations in the block. | |
| string Availability block state | required | State of the availability block. |
| string Reservation purpose | optional | The purpose of the block. |
| string | required | Creation date and time of the block in UTC timezone in ISO 8601 format. |
| string | required | Last update date and time of the block in UTC timezone in ISO 8601 format. |
| string | required | Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format. See Time units. |
| string | required | End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format. See Time units. |
| string | required | The moment when the block and its availability is released in UTC timezone in ISO 8601 format. |
| string | optional, max 255 characters | Identifier of the block from external system. |
| string | optional | The name of the block in Mews. |
| string | optional | Additional notes of the block. |
Add availability blocks
This feature is being actively developed, features and behavior of this operation might change on short notice.
Adds availability blocks which are used to group related Availability updates. This makes limiting public availability easier and more organized. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/availabilityBlocks/add
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. |
| string | optional | Unique identifier of the Enterprise. Required when using a Portfolio Access Token, ignored otherwise. |
| array of Availability block parameters | required, max 1000 items | Availability blocks to be added. |
Availability block parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the Service to assign block to. |
| string | required | Unique identifier of the Rate to assign block to. |
| string | optional | Voucher code providing access to specified private Rate. |
| string | optional | The name of the block. |
| string | required | Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format. See Time units. |
| string | required | End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format. See Time units. |
| string | required | The moment when the block and its availability is released. |
| string | optional, max 255 characters | Identifier of the block from external system. |
| optional | The tentative budget for the total price of reservations. | |
| string Reservation purpose | optional | The purpose of the block. |
| string | optional | Additional notes of the block. |
| string Availability block state | required | State of the availability block. |
| string | optional | Unique identifier of the Booker as a creator of an availability block. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Availability block | required | Availability blocks. |
Reservation purpose
Leisure
Business
Student
Update availability blocks
This feature is being actively developed, features and behavior of this operation might change on short notice.
Updates information about the specified Availability block.
Request
[PlatformAddress]/api/connector/v1/availabilityBlocks/update
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. |
| string | optional | Unique identifier of the Enterprise. Required when using a Portfolio Access Token, ignored otherwise. |
| array of Availability block update parameters | required, max 1000 items | Availability blocks to be updated. |
Availability block update parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the Availability block. |
| optional | The name of the block (or | |
| required | Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format (or | |
| required | End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format (or | |
| required | The moment when the block and its availability is released (or | |
| optional, max 255 characters | Identifier of the block from external system (or |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Availability block | required | Availability blocks. |
Delete availability blocks
Delete availability blocks. Note that an availability block containing active reservations (reservations which are not Canceled
) cannot be deleted.
Request
[PlatformAddress]/api/connector/v1/availabilityBlocks/delete
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. |
| string | optional | Unique identifier of the Enterprise. Required when using a Portfolio Access Token, ignored otherwise. |
| array of string | required, max 1000 items | Unique identifier of the Availability block to delete. |
Response
Last updated