Connector API
  • Mews Connector API
  • Getting started
  • Usage guidelines
    • Authentication
    • Requests
    • Responses
    • Environments
    • Serialization
    • Pagination
    • Best practices
  • Concepts
    • Multi-property
    • Restrictions
    • Taxation
    • Time units
  • Use cases
    • 'How to' use cases
    • Accounting
    • Customer loyalty
    • Customer management
    • Customer messaging
    • Data export
    • Device integration
    • Events
    • Guest technology
    • Housekeeping
    • Kiosk
    • Mews Payment Terminals
    • Payment automation
    • Point of sale
    • Reputation management
    • Revenue management
    • Upsell
  • API Operations
    • Common objects
    • Accounting categories
    • Accounting items
    • Accounts
    • Account notes
    • Addresses
    • Age categories
    • Availability adjustments
    • Availability blocks
    • Billing automations
    • Bills
    • Business segments
    • Cancellation policies
    • Cashiers
    • Cashier transactions
    • Commands
    • Companies
    • Companionships
    • Company contracts
    • Configuration
    • Counters
    • Countries
    • Credit cards
    • Currencies
    • Customers
    • Departments
    • Devices
    • Enterprises
    • Exchange rates
    • Exports
    • Identity documents
    • Images
    • Languages
    • Loyalty memberships
    • Loyalty programs
    • Loyalty tiers
    • Messages
    • Message threads
    • Order items
    • Orders
    • Outlet bills
    • Outlet items
    • Outlets
    • Payments
    • Payment requests
    • Preauthorizations
    • Product categories
    • Product service orders
    • Products
    • Rates
    • Rate groups
    • Reservations
    • Reservation groups
    • Resource access tokens
    • Resource blocks
    • Resources
    • Resource categories
    • Resource features
    • Restrictions
    • Routing rules
    • Rules
    • Service order notes
    • Service overbooking limits
    • Services
    • Source assignments
    • Sources
    • Tasks
    • Tax environments
    • Taxations
    • Vouchers
    • Voucher codes
  • API Events
    • Ways to communicate
    • General Webhooks
    • Integration Webhooks
    • Webhooks FAQ
    • WebSockets
  • Your integration journey
    • Certification
  • Deprecations
    • Migration guide: Get all reservations
  • Changelog
    • Changelog 2024
    • Changelog 2023
    • Changelog 2022
    • Changelog 2021
    • Changelog 2020
    • Changelog 2019
    • Changelog 2018
    • Changelog 2017
    • Changelog 2016
Powered by GitBook
On this page
  • Get all restrictions
  • Request
  • Response
  • Add restrictions
  • Request
  • Response
  • Set restrictions
  • Request
  • Response
  • Delete restrictions
  • Request
  • Response
  • Clear restrictions
  • Request
  • Response

Was this helpful?

  1. API Operations

Restrictions

PreviousResource featuresNextRouting rules

Last updated 4 months ago

Was this helpful?

Get all restrictions

Returns all restrictions of the default service provided by the enterprise. Note this operation uses and supports .

Request

[PlatformAddress]/api/connector/v1/restrictions/getAll

{
  "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

optional

Interval in which the Restriction is active.

CreatedUtc

optional

Interval in which the Restriction was created.

UpdatedUtc

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

required

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

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

{
  "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

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.

Add restrictions

Deprecated!

Request

[PlatformAddress]/api/connector/v1/restrictions/add

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
  "Restrictions": [
    {
      "Identifier": "1234",
      "ExternalIdentifier": "5678",
      "Conditions": {
        "Type": "Start",
        "ExactRateId": "7c7e89d6-69c0-4cce-9d42-35443f2193f3",
        "ResourceCategoryId": "86336EAC-4168-46B1-A544-2A47251BF864",
        "Days": [
          "Friday",
          "Saturday",
          "Sunday"
        ]
      },
      "Exceptions": {
        "MinLength": "P0M2DT0H0M0S",
        "MaxLength": "P0M7DT0H0M0S"
      }
    },
    {
      "Identifier": "1235",
      "ExternalIdentifier": "5678",
      "Conditions": {
        "Type": "Start",
        "BaseRateId": "e5b538b1-36e6-43a0-9f5c-103204c7f68e",
        "Days": [
          "Friday",
          "Saturday",
          "Sunday"
        ]
      },
      "Exceptions": {
        "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

required

Restrictions

required, max 1000 items

Parameters of restrictions.

Restriction data

Property
Type
Contract
Description

Identifier

string

optional

Identifier of the restriction within the transaction.

ExternalIdentifier

string

optional

External identifier of the restriction.

Conditions

required

The conditions or rules that must be met by a reservation for the restriction to apply.

Exceptions

optional

The rules that prevent the restriction from applying to a reservation, even when all conditions have been met.

Restriction condition data

Property
Type
Contract
Description

Type

required

Restriction type.

ExactRateId

optional

Unique identifier of the exact Rate to which the restriction applies.

BaseRateId

optional

Unique identifier of the base Rate to which the restriction applies.

RateGroupId

optional

Unique identifier of the Rate group to which the restriction applies.

ResourceCategoryId

optional

Unique identifier of the Resource category to which the restriction applies.

ResourceCategoryType

optional

Name of the Resource category type to which the restriction applies.

StartUtc

string

optional

EndUtc

string

optional

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

optional

The restricted hours. Defaults to all hours when not provided.

Restriction exception data

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

optional

Value of the minimum price per time unit.

MaxPrice

optional

Value of the maximum price per time unit.

Response

{
  "Restrictions": [
    {
      "Identifier": "1234",
      "Restriction": {
        "Id": "40c24757-c16e-4094-91d3-4ca952e488a1",
        "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
        "ExternalIdentifier": "5678",
        "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": null,
          "MaxPrice": null
        }
      }
    },
    {
      "Identifier": "1235",
      "Restriction": {
        "Id": "b40ac4a8-f5da-457d-88fe-7a895e1580ab",
        "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
        "ExternalIdentifier": "5678",
        "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
        }
      }
    }
  ]
}
Property
Type
Contract
Description

Restrictions

optional

The added restrictions.

Added restriction

Property
Type
Contract
Description

Identifier

string

optional

Identifier of the restriction within the transaction.

Restriction

optional

The added restriction.

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

required

Restriction origin

Conditions

required

The conditions or rules that must be met by a reservation for the restriction to apply.

Exceptions

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

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

optional

Name of the restricted Resource category type.

StartUtc

string

optional

EndUtc

string

optional

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

optional

The restricted hours. Defaults to all hours when not provided.

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

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

optional

Value of the minimum price per time unit.

MaxPrice

optional

Value of the maximum price per time unit.

Set restrictions

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

{
  "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

required

Data

required, max 1000 items

Parameters of restrictions.

Restriction set data

Property
Type
Contract
Description

Type

required

Restriction type.

ExactRateId

optional

Unique identifier of the exact Rate to which the restriction applies.

BaseRateId

optional

Unique identifier of the base Rate to which the restriction applies.

RateGroupId

optional

Unique identifier of the Rate group to which the restriction applies.

ResourceCategoryId

optional

Unique identifier of the Resource category to which the restriction applies.

ResourceCategoryType

optional

Name of the Resource category type to which the restriction applies.

StartUtc

string

optional

EndUtc

string

optional

Days

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

optional

Value of the minimum price per time unit.

MaxPrice

optional

Value of the maximum price per time unit.

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

{}

Delete restrictions

Deprecated!

Request

[PlatformAddress]/api/connector/v1/restrictions/delete

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "RestrictionIds": [
    "af4949ce-c061-4f27-89f9-5a6a9ef725a7",
    "e2f8aa29-0c09-4097-801c-7888c9fb57ae"
  ]
}
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.

RestrictionIds

array of string

required

Unique identifiers of the Restriction.

Response

{}

Clear restrictions

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

{
  "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

required

Data

required, max 1000 items

Details of the matching conditions and time intervals for clearing restrictions.

Restriction clear data

Property
Type
Contract
Description

Type

required

Restriction type.

ExactRateId

optional

Unique identifier of the exact Rate to which the restriction applies.

BaseRateId

optional

Unique identifier of the base Rate to which the restriction applies.

RateGroupId

optional

Unique identifier of the Rate group to which the restriction applies.

ResourceCategoryId

optional

Unique identifier of the Resource category to which the restriction applies.

ResourceCategoryType

optional

Name of the Resource category type to which the restriction applies.

StartUtc

string

optional

EndUtc

string

optional

Days

required

The days of week to which the restriction applies.

Response

{}

array of

This operation is . Use instead.

Adds new restrictions with the specified conditions. Care is needed to specify StartUtc and EndUtc in the correct format - see . Important: If consecutive restrictions are sent with the exact same conditions and exceptions, no attempt at merging them into a single restriction is made. This means that there can be a large number of restrictions per service, leading to sub-optimal performance. A quota limit of 150,000 has been introduced for this reason. To mitigate the issue, the preferred way to add restrictions is operation .

Unique identifier of the restrictions will be added in.

array of

string

string

string

string

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 .

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 .

array of

Start date of the restriction time interval, specified in ISO 8601 format and adjusted to UTC - see for important information on format and implementation.

End date of the restriction time interval, specified in ISO 8601 format and adjusted to UTC - see for important information on format and implementation.

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 .

Care is needed to specify StartUtc and EndUtc in the correct format - see . If migrating from deprecated operation , note that the validation of these properties is stronger in this operation.

string

Unique identifier of the restrictions will be set in.

array of

string

string

string

string

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 .

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 .

This operation is . Use instead.

Removes restrictions from the service. This operation is intended to be used alongside .

Deletes restrictions that exactly match the specified conditions, using a splicing algorithm. This operation is intended to be used alongside . 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 .

string

Unique identifier of the to which the restrictions apply.

array of

string

string

string

string

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 .

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 .

Pagination
Portfolio Access Tokens
Concepts > Restrictions
deprecated
Set restrictions
deprecated
Clear restrictions
Add restrictions
Concepts > Restrictions
Set restrictions
Restriction origin
Restriction
Restriction data
Restriction condition data
Restriction exception data
Restriction type
Resource category type
Hours
Added restriction
Restriction
Restriction origin
Restriction condition
Restriction exception
Restriction type
Resource category type
Hours
Restriction set data
Restriction type
Resource category type
Days parameters
Restriction clear data
Restriction type
Resource category type
Days parameters
Set restriction
Datetimes
Add restrictions
Datetimes
Datetimes
Datetimes
Datetimes
Datetimes
Datetimes
Datetimes
Datetimes
Datetimes
Limitation
Time interval
Time interval
Time interval
Hybrid identifier
Hybrid identifier
Hybrid identifier
Hybrid identifier
Currency value (ver 2018-06-07)
Currency value (ver 2018-06-07)
Currency value (ver 2018-06-07)
Currency value (ver 2018-06-07)
Hybrid identifier
Hybrid identifier
Hybrid identifier
Hybrid identifier
Hybrid identifier
Currency value (ver 2023-02-02)
Currency value (ver 2023-02-02)
Hybrid identifier
Hybrid identifier
Hybrid identifier
Hybrid identifier
Hybrid identifier
Service
Service
Service