# Restrictions ## Get all restrictions Returns all restrictions of the default service provided by the enterprise. Note this operation uses [Pagination](/connector-api/guidelines/pagination.md) and supports [Portfolio Access Tokens](/connector-api/concepts/multi-property.md). ### Request `[PlatformAddress]/api/connector/v1/restrictions/getAll` ```javascript { "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "EnterpriseIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6", "4d0201db-36f5-428b-8d11-4f0a65e960cc" ], "ServiceIds": [ "bd26d8db-86da-4f96-9efc-e5a4654a4a94" ], "ResourceCategoryIds": [ "34c29e73-c8db-4e93-b51b-981e42655e03" ], "RateIds": [ "ed4b660b-19d0-434b-9360-a4de2ea42eda" ], "Origin": "Integration", "CollidingUtc": { "StartUtc": "2020-02-15T00:00:00Z", "EndUtc": "2020-02-20T00:00:00Z" }, "CreatedUtc": { "StartUtc": "2020-02-05T00:00:00Z", "EndUtc": "2020-02-15T00:00:00Z" }, "UpdatedUtc": { "StartUtc": "2020-02-05T00:00:00Z", "EndUtc": "2020-02-15T00:00:00Z" }, "Limitation": { "Count": 10 } } ``` | Property | Type | Contract | Description | | --------------------- | -------------------------------------------------------------------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ClientToken` | string | required | Token identifying the client application. | | `AccessToken` | string | required | Access token of the client application. | | `Client` | string | required | Name and version of the client application. | | `EnterpriseIds` | 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. | | `CollidingUtc` | [Time interval](/connector-api/operations/_objects.md#time-interval) | optional | Interval in which the `Restriction` is active. | | `CreatedUtc` | [Time interval](/connector-api/operations/_objects.md#time-interval) | optional | Interval in which the `Restriction` was created. | | `UpdatedUtc` | [Time interval](/connector-api/operations/_objects.md#time-interval) | optional | Interval in which the `Restriction` was updated. | | `RestrictionIds` | array of string | optional, max 1000 items | Unique identifiers of the `Restriction`. | | `ResourceCategoryIds` | array of string | optional, max 1000 items | Unique identifiers of `Resource category`. | | `RateIds` | array of string | optional, max 1000 items | Unique identifiers of `Rate`. Returns all restrictions that affect the given rates, i.e. ones without any `Restriction Conditions`, ones assigned directly to specified rates, ones assigned to `Rate group` of specified rates, or ones inherited from base rates.\`. | | `ExactRateIds` | array of string | optional, max 1000 items | Unique identifiers of `Rate`. Returns only those restrictions which have matching `ExactRateId` set in `Restriction Condition`. | | `BaseRateIds` | array of string | optional, max 1000 items | Unique identifiers of `Rate`. Returns only those restrictions which have matching `BaseRateId` set in `Restriction Condition`. | | `Origin` | [Restriction origin](#restriction-origin) | optional | Restriction origin. Returns only those restrictions which have matching Origin or all if not specified. | | `ServiceIds` | array of string | required, max 1000 items | Unique identifiers of the `Service` from which the restrictions are requested. | | `Limitation` | [Limitation](/connector-api/guidelines/pagination.md#limitation) | required | Limitation on the quantity of data returned and optional Cursor for the starting point of data. | | ~~`TimeFilter`~~ | ~~string~~ | ~~optional~~ | **Deprecated!** | | ~~`StartUtc`~~ | ~~string~~ | ~~optional~~ | **Deprecated!** | | ~~`EndUtc`~~ | ~~string~~ | ~~optional~~ | **Deprecated!** | #### Restriction origin * `User` - Restriction was created by a user in Mews. * `Integration` - Restriction was created by a 3rd-party integration. ### Response ```javascript { "Restrictions": [ { "Id": "40c24757-c16e-4094-91d3-4ca952e488a1", "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "ExternalIdentifier": "5678", "Origin": "Integration", "Conditions": { "Type": "Stay", "ExactRateId": "7c7e89d6-69c0-4cce-9d42-35443f2193f3", "BaseRateId": null, "RateGroupId": null, "ResourceCategoryId": "86336EAC-4168-46B1-A544-2A47251BF864", "ResourceCategoryType": null, "StartUtc": "2018-10-09T00:00:00Z", "EndUtc": "2018-10-31T00:00:00Z", "Days": [ "Saturday", "Sunday" ] }, "Exceptions": { "MinAdvance": null, "MaxAdvance": null, "MinLength": "P0M2DT0H0M0S", "MaxLength": "P0M7DT0H0M0S", "MinPrice": { "Value": 50, "Currency": "EUR" }, "MaxPrice": { "Value": 150, "Currency": "EUR" } } }, { "Id": "b40ac4a8-f5da-457d-88fe-7a895e1580ab", "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "ExternalIdentifier": "5678", "Origin": "Integration", "Conditions": { "Type": "Start", "ExactRateId": null, "BaseRateId": "e5b538b1-36e6-43a0-9f5c-103204c7f68e", "RateGroupId": null, "ResourceCategoryId": null, "ResourceCategoryType": "Room", "StartUtc": "2018-10-01T00:00:00Z", "EndUtc": "2018-10-31T00:00:00Z", "Days": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ] }, "Exceptions": { "MinAdvance": "P0M1DT0H0M0S", "MaxAdvance": "P0M3DT0H0M0S", "MinLength": null, "MaxLength": null, "MinPrice": null, "MaxPrice": null } } ], "Cursor": "b40ac4a8-f5da-457d-88fe-7a895e1580ab" } ``` | Property | Type | Contract | Description | | -------------- | ------------------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Restrictions` | array of [Restriction](#restriction) | required | Restrictions of the default service. | | `Cursor` | 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. | #### Restriction The added restriction. | Property | Type | Contract | Description | | -------------------- | ----------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------- | | `Id` | string | required | Unique identifier of the restriction. | | `ServiceId` | string | required | Unique identifier of the `Service`. | | `ExternalIdentifier` | string | optional | External identifier of the restriction. | | `Origin` | [Restriction origin](#restriction-origin) | required | Restriction origin | | `Conditions` | [Restriction condition](#restriction-condition) | required | The conditions or rules that must be met by a reservation for the restriction to apply. | | `Exceptions` | [Restriction exception](#restriction-exception) | optional | The rules that prevent the restriction from applying to a reservation, even when all conditions have been met. | #### Restriction origin * `User` - Restriction was created by a user in Mews. * `Integration` - Restriction was created by a 3rd-party integration. #### Restriction condition The conditions or rules that must be met by a reservation for the restriction to apply. | Property | Type | Contract | Description | | ---------------------- | ------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Type` | [Restriction type](#restriction-type) | required | Restriction type. | | `ExactRateId` | string | optional | Unique identifier of the restricted exact `Rate`. | | `BaseRateId` | string | optional | Unique identifier of the restricted base `Rate`. | | `RateGroupId` | string | optional | Unique identifier of the restricted `Rate group`. | | `ResourceCategoryId` | string | optional | Unique identifier of the restricted `Resource category`. | | `ResourceCategoryType` | [Resource category type](#resource-category-type) | optional | Name of the restricted `Resource category type`. | | `StartUtc` | string | optional | Start date of the restriction time interval, specified in ISO 8601 format and adjusted to UTC - see [Datetimes](/connector-api/guidelines/serialization.md#datetimes) for important information on format and implementation. | | `EndUtc` | string | optional | End date of the restriction time interval, specified in ISO 8601 format and adjusted to UTC - see [Datetimes](/connector-api/guidelines/serialization.md#datetimes) for important information on format and implementation. | | `Days` | array of string | optional | The restricted days of week. Defaults to all days when not provided. Ignored when the service uses a time unit longer than a day. | | `Hours` | [Hours](#hours) | optional | The restricted hours. Defaults to all hours when not provided. | #### Hours | Property | Type | Contract | Description | | ------------- | ------- | -------- | --------------- | | `Zero` | boolean | required | Hour 0 enabled | | `One` | boolean | required | Hour 1 enabled | | `Two` | boolean | required | Hour 2 enabled | | `Three` | boolean | required | Hour 3 enabled | | `Four` | boolean | required | Hour 4 enabled | | `Five` | boolean | required | Hour 5 enabled | | `Six` | boolean | required | Hour 6 enabled | | `Seven` | boolean | required | Hour 7 enabled | | `Eight` | boolean | required | Hour 8 enabled | | `Nine` | boolean | required | Hour 9 enabled | | `Ten` | boolean | required | Hour 10 enabled | | `Eleven` | boolean | required | Hour 11 enabled | | `Twelve` | boolean | required | Hour 12 enabled | | `Thirteen` | boolean | required | Hour 13 enabled | | `Fourteen` | boolean | required | Hour 14 enabled | | `Fifteen` | boolean | required | Hour 15 enabled | | `Sixteen` | boolean | required | Hour 16 enabled | | `Seventeen` | boolean | required | Hour 17 enabled | | `Eighteen` | boolean | required | Hour 18 enabled | | `Nineteen` | boolean | required | Hour 19 enabled | | `Twenty` | boolean | required | Hour 20 enabled | | `TwentyOne` | boolean | required | Hour 21 enabled | | `TwentyTwo` | boolean | required | Hour 22 enabled | | `TwentyThree` | boolean | required | Hour 23 enabled | #### Restriction exception The rules that prevent the restriction from applying to a reservation, even when all conditions have been met. | Property | Type | Contract | Description | | ------------ | ------------------------------------------------------------------------------------------------------ | -------- | -------------------------------------------------------------------------------------------- | | `MinAdvance` | string | optional | The minimum time before the reservation starts, you can reserve in ISO 8601 duration format. | | `MaxAdvance` | string | optional | The maximum time before the reservation starts, you can reserve in ISO 8601 duration format. | | `MinLength` | string | optional | Minimal reservation length in ISO 8601 duration format. | | `MaxLength` | string | optional | Maximal reservation length in ISO 8601 duration format. | | `MinPrice` | [Currency value (ver 2018-06-07)](/connector-api/operations/_objects.md#currency-value-ver-2018-06-07) | optional | Value of the minimum price per time unit. | | `MaxPrice` | [Currency value (ver 2018-06-07)](/connector-api/operations/_objects.md#currency-value-ver-2018-06-07) | optional | Value of the maximum price per time unit. | ## Set restrictions Adds new restrictions with the specified conditions. For improved efficiency, multiple similar restrictions will be merged into a single restriction. A quota of 150,000 restrictions per service applies, although it is unlikely to be exceeded because of the merging algorithm. For more information about the merging algorithm, see [Restrictions concepts](/connector-api/concepts/restrictions.md). Care is needed to specify `StartUtc` and `EndUtc` in the correct format - see [Datetimes](/connector-api/guidelines/serialization.md#datetimes). Only restrictions created through the API are affected by this operation, *not* restrictions created by the user within **Mews Operations**. Similarly, if a user creates a restriction in **Mews Operations**, this will *not* affect restrictions created through the API. ### Request `[PlatformAddress]/api/connector/v1/restrictions/set` ```javascript { "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "Data": [ { "Type": "Start", "ExactRateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda", "ResourceCategoryId": "773d5e42-de1e-43a0-9ce6-f940faf2303f", "StartUtc": "2023-02-15T00:00:00Z", "EndUtc": "2023-02-22T00:00:00Z", "Days": { "Monday": false, "Tuesday": false, "Wednesday": false, "Thursday": false, "Friday": true, "Saturday": true, "Sunday": true }, "MinLength": "P0M2DT0H0M0S", "MaxLength": "P0M7DT0H0M0S" }, { "Type": "Start", "BaseRateId": "e5b538b1-36e6-43a0-9f5c-103204c7f68e", "StartUtc": "2023-02-23T00:00:00Z", "EndUtc": "2023-03-03T00:00:00Z", "Days": { "Monday": true, "Tuesday": true, "Wednesday": true, "Thursday": true, "Friday": true, "Saturday": false, "Sunday": false }, "MinAdvance": "P0Y0M1DT0H0M0S", "MaxAdvance": "P0Y0M3DT0H0M0S" } ] } ``` | Property | Type | Contract | Description | | ------------- | ----------------------------------------------------------------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------- | | `ClientToken` | string | required | Token identifying the client application. | | `AccessToken` | string | required | Access token of the client application. | | `Client` | string | required | Name and version of the client application. | | `ServiceId` | string [Hybrid identifier](/connector-api/operations/_objects.md#hybrid-identifier) | required | Unique identifier of the [Service](/connector-api/operations/services.md#service) restrictions will be set in. | | `Data` | array of [Restriction set data](#restriction-set-data) | required, max 1000 items | Parameters of restrictions. | #### Restriction set data | Property | Type | Contract | Description | | ---------------------- | ------------------------------------------------------------------------------------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Type` | [Restriction type](#restriction-type) | required | Restriction type. | | `ExactRateId` | string [Hybrid identifier](/connector-api/operations/_objects.md#hybrid-identifier) | optional | Unique identifier of the exact `Rate` to which the restriction applies. | | `BaseRateId` | string [Hybrid identifier](/connector-api/operations/_objects.md#hybrid-identifier) | optional | Unique identifier of the base `Rate` to which the restriction applies. | | `RateGroupId` | string [Hybrid identifier](/connector-api/operations/_objects.md#hybrid-identifier) | optional | Unique identifier of the `Rate group` to which the restriction applies. | | `ResourceCategoryId` | string [Hybrid identifier](/connector-api/operations/_objects.md#hybrid-identifier) | optional | Unique identifier of the `Resource category` to which the restriction applies. | | `ResourceCategoryType` | [Resource category type](#resource-category-type) | optional | Name of the `Resource category type` to which the restriction applies. | | `StartUtc` | string | optional | Start date of the time interval for which the restriction conditions should be applied. This must be in UTC timezone in ISO 8601 format - see [Datetimes](/connector-api/guidelines/serialization.md#datetimes). | | `EndUtc` | string | optional | End date of the time interval for which the restriction conditions should be applied. This must be in UTC timezone in ISO 8601 format - see [Datetimes](/connector-api/guidelines/serialization.md#datetimes). | | `Days` | [Days parameters](#days-parameters) | required | The restricted days of week. | | `MinAdvance` | string | optional | The minimum time before the reservation starts, you can reserve in ISO 8601 duration format. | | `MaxAdvance` | string | optional | The maximum time before the reservation starts, you can reserve in ISO 8601 duration format. | | `MinLength` | string | optional | Minimal reservation length in ISO 8601 duration format. | | `MaxLength` | string | optional | Maximal reservation length in ISO 8601 duration format. | | `MinPrice` | [Currency value (ver 2023-02-02)](/connector-api/operations/_objects.md#currency-value-ver-2023-02-02) | optional | Value of the minimum price per time unit. | | `MaxPrice` | [Currency value (ver 2023-02-02)](/connector-api/operations/_objects.md#currency-value-ver-2023-02-02) | optional | Value of the maximum price per time unit. | #### Restriction type * `Stay` - Guests can't stay within specified dates. * `Start` - Guests can't check in within specified dates. * `End` - Guests can't check out within specified dates. #### Resource category type * `Room` * `Bed` * `Dorm` * `Apartment` * `Suite` * `Villa` * `Site` * `Office` * `MeetingRoom` * `ParkingSpot` * `Desk` * `TeamArea` * `Membership` * `Tent` * `CaravanOrRV` * `UnequippedCampsite` * `Bike` * `ExtraBed` * `Cot` * `Crib` * `ConferenceRoom` * `Rooftop` * `Garden` * `Restaurant` * `Amphitheater` * `PrivateSpaces` #### Days parameters | Property | Type | Contract | Description | | ----------- | ------- | -------- | ----------------- | | `Monday` | boolean | required | Monday enabled | | `Tuesday` | boolean | required | Tuesday enabled | | `Wednesday` | boolean | required | Wednesday enabled | | `Thursday` | boolean | required | Thursday enabled | | `Friday` | boolean | required | Friday enabled | | `Saturday` | boolean | required | Saturday enabled | | `Sunday` | boolean | required | Sunday enabled | ### Response ```javascript {} ``` ## Clear restrictions Deletes restrictions that exactly match the specified conditions, using a splicing algorithm. This operation is intended to be used alongside [Set restrictions](#set-restrictions). The specified conditions must be met exactly. The time interval, however, does not need to correspond to an existing restriction in the system, instead the API uses a splicing algorithm to work out how to divide up any existing restrictions to meet the specified time interval. For details about matching conditions and the splicing algorithm, see [Concepts > Restrictions](/connector-api/concepts/restrictions.md). Only restrictions created through the API are affected by this operation, *not* restrictions created by the user within **Mews Operations**. Similarly, if a user creates a restriction in **Mews Operations**, this will *not* affect restrictions created through the API. ### Request `[PlatformAddress]/api/connector/v1/restrictions/clear` ```javascript { "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "Data": [ { "Type": "Start", "ExactRateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda", "ResourceCategoryId": "773d5e42-de1e-43a0-9ce6-f940faf2303f", "StartUtc": "2023-02-15T00:00:00Z", "EndUtc": "2023-02-22T00:00:00Z", "Days": { "Monday": false, "Tuesday": false, "Wednesday": false, "Thursday": false, "Friday": true, "Saturday": true, "Sunday": true } }, { "Type": "Start", "BaseRateId": "e5b538b1-36e6-43a0-9f5c-103204c7f68e", "StartUtc": "2023-02-23T00:00:00Z", "EndUtc": "2023-03-03T00:00:00Z", "Days": { "Monday": true, "Tuesday": true, "Wednesday": true, "Thursday": true, "Friday": true, "Saturday": false, "Sunday": false } } ] } ``` | Property | Type | Contract | Description | | ------------- | ----------------------------------------------------------------------------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------ | | `ClientToken` | string | required | Token identifying the client application. | | `AccessToken` | string | required | Access token of the client application. | | `Client` | string | required | Name and version of the client application. | | `ServiceId` | string [Hybrid identifier](/connector-api/operations/_objects.md#hybrid-identifier) | required | Unique identifier of the [Service](/connector-api/operations/services.md#service) to which the restrictions apply. | | `Data` | array of [Restriction clear data](#restriction-clear-data) | required, max 1000 items | Details of the matching conditions and time intervals for clearing restrictions. | #### Restriction clear data | Property | Type | Contract | Description | | ---------------------- | ----------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Type` | [Restriction type](#restriction-type) | required | Restriction type. | | `ExactRateId` | string [Hybrid identifier](/connector-api/operations/_objects.md#hybrid-identifier) | optional | Unique identifier of the exact `Rate` to which the restriction applies. | | `BaseRateId` | string [Hybrid identifier](/connector-api/operations/_objects.md#hybrid-identifier) | optional | Unique identifier of the base `Rate` to which the restriction applies. | | `RateGroupId` | string [Hybrid identifier](/connector-api/operations/_objects.md#hybrid-identifier) | optional | Unique identifier of the `Rate group` to which the restriction applies. | | `ResourceCategoryId` | string [Hybrid identifier](/connector-api/operations/_objects.md#hybrid-identifier) | optional | Unique identifier of the `Resource category` to which the restriction applies. | | `ResourceCategoryType` | [Resource category type](#resource-category-type) | optional | Name of the `Resource category type` to which the restriction applies. | | `StartUtc` | string | optional | Start date of the time interval for which the restriction conditions should be applied. This must be in UTC timezone in ISO 8601 format - see [Datetimes](/connector-api/guidelines/serialization.md#datetimes). | | `EndUtc` | string | optional | End date of the time interval for which the restriction conditions should be applied. This must be in UTC timezone in ISO 8601 format - see [Datetimes](/connector-api/guidelines/serialization.md#datetimes). | | `Days` | [Days parameters](#days-parameters) | required | The days of week to which the restriction applies. | ### Response ```javascript {} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.mews.com/connector-api/operations/restrictions.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.