Mews · Schema

Restriction set data

HospitalityHotelsPMSProperty Management

Properties

Name Type Description
Type object 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.)
ExactRateId string Unique identifier of the exact `Rate` to which the restriction applies.
BaseRateId string Unique identifier of the base `Rate` to which the restriction applies.
RateGroupId string Unique identifier of the `Rate group` to which the restriction applies.
ResourceCategoryId string Unique identifier of the `Resource category` to which the restriction applies.
ResourceCategoryType object Name of the `Resource category type` to which the restriction applies. Room Bed Dorm Apartment Suite Villa Site Office MeetingRoom ParkingSpot Desk TeamArea Membership Tent CaravanOrRV UnequippedCamps
StartUtc 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 [Datetimes](https://mews-systems.gitbook.io/connector-api/
EndUtc string 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](https://mews-systems.gitbook.io/connector-api/gu
Days object The restricted days of week.
MinAdvance string The minimum time before the reservation starts, you can reserve in ISO 8601 duration format.
MaxAdvance string The maximum time before the reservation starts, you can reserve in ISO 8601 duration format.
MinLength string Minimal reservation length in ISO 8601 duration format.
MaxLength string Maximal reservation length in ISO 8601 duration format.
MinPrice object Value of the minimum price per time unit.
MaxPrice object Value of the maximum price per time unit.
View JSON Schema on GitHub

JSON Schema

mews-restrictionsetdata-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RestrictionSetData",
  "title": "Restriction set data",
  "required": [
    "Days",
    "Type"
  ],
  "type": "object",
  "properties": {
    "Type": {
      "title": "Restriction type",
      "allOf": [
        {
          "$ref": "#/components/schemas/RestrictionTypeEnum"
        }
      ],
      "description": "Restriction type.\n\nStay (Guests can't stay within specified dates.)\n\nStart (Guests can't check in within specified dates.)\n\nEnd (Guests can't check out within specified dates.)",
      "x-enumNames": [
        "Stay",
        "Start",
        "End"
      ],
      "x-enumDescriptions": [
        "Guests can't stay within specified dates.",
        "Guests can't check in within specified dates.",
        "Guests can't check out within specified dates."
      ]
    },
    "ExactRateId": {
      "type": "string",
      "description": "Unique identifier of the exact `Rate` to which the restriction applies.",
      "nullable": true,
      "x-schema-id": "HybridIdentifier"
    },
    "BaseRateId": {
      "type": "string",
      "description": "Unique identifier of the base `Rate` to which the restriction applies.",
      "nullable": true,
      "x-schema-id": "HybridIdentifier"
    },
    "RateGroupId": {
      "type": "string",
      "description": "Unique identifier of the `Rate group` to which the restriction applies.",
      "nullable": true,
      "x-schema-id": "HybridIdentifier"
    },
    "ResourceCategoryId": {
      "type": "string",
      "description": "Unique identifier of the `Resource category` to which the restriction applies.",
      "nullable": true,
      "x-schema-id": "HybridIdentifier"
    },
    "ResourceCategoryType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceCategoryTypeEnum"
        }
      ],
      "description": "Name of the `Resource category type` to which the restriction applies.\n\nRoom\n\nBed\n\nDorm\n\nApartment\n\nSuite\n\nVilla\n\nSite\n\nOffice\n\nMeetingRoom\n\nParkingSpot\n\nDesk\n\nTeamArea\n\nMembership\n\nTent\n\nCaravanOrRV\n\nUnequippedCampsite\n\nBike\n\nExtraBed\n\nCot\n\nCrib\n\nConferenceRoom\n\nRooftop\n\nGarden\n\nRestaurant\n\nAmphitheater\n\nPrivateSpaces",
      "nullable": true
    },
    "StartUtc": {
      "type": "string",
      "description": "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](https://mews-systems.gitbook.io/connector-api/guidelines/serialization#datetimes).",
      "format": "date-time",
      "nullable": true
    },
    "EndUtc": {
      "type": "string",
      "description": "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](https://mews-systems.gitbook.io/connector-api/guidelines/serialization#datetimes).",
      "format": "date-time",
      "nullable": true
    },
    "Days": {
      "title": "Days parameters",
      "allOf": [
        {
          "$ref": "#/components/schemas/DaysParameters"
        }
      ],
      "description": "The restricted days of week."
    },
    "MinAdvance": {
      "type": "string",
      "description": "The minimum time before the reservation starts, you can reserve in ISO 8601 duration format.",
      "format": "date-time",
      "nullable": true
    },
    "MaxAdvance": {
      "type": "string",
      "description": "The maximum time before the reservation starts, you can reserve in ISO 8601 duration format.",
      "format": "date-time",
      "nullable": true
    },
    "MinLength": {
      "type": "string",
      "description": "Minimal reservation length in ISO 8601 duration format.",
      "format": "date-time",
      "nullable": true
    },
    "MaxLength": {
      "type": "string",
      "description": "Maximal reservation length in ISO 8601 duration format.",
      "format": "date-time",
      "nullable": true
    },
    "MinPrice": {
      "title": "Currency value (ver 2023-02-02)",
      "allOf": [
        {
          "$ref": "#/components/schemas/CurrencyValue"
        }
      ],
      "description": "Value of the minimum price per time unit.",
      "nullable": true
    },
    "MaxPrice": {
      "title": "Currency value (ver 2023-02-02)",
      "allOf": [
        {
          "$ref": "#/components/schemas/CurrencyValue"
        }
      ],
      "description": "Value of the maximum price per time unit.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "RestrictionSetData"
}