ReservationFilterParameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ReservationFilterParameters",
  "title": "ReservationFilterParameters",
  "required": [
    "AccessToken",
    "Client",
    "ClientToken",
    "Extent",
    "Limitation",
    "ServiceIds"
  ],
  "type": "object",
  "properties": {
    "ClientToken": {
      "minLength": 1,
      "type": "string",
      "description": "Token identifying the client application."
    },
    "AccessToken": {
      "minLength": 1,
      "type": "string",
      "description": "Access token of the client application."
    },
    "Client": {
      "minLength": 1,
      "type": "string",
      "description": "Name and version of the client application."
    },
    "ServiceIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of the [Services](https://mews-systems.gitbook.io/connector-api/operations/services/#service) from which the reservations are requested."
    },
    "ServiceId": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "deprecated": true
    },
    "GroupIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of the requested [Reservation groups](https://mews-systems.gitbook.io/connector-api/operations/#reservation-group).",
      "nullable": true
    },
    "ReservationIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of the requested [Reservations](https://mews-systems.gitbook.io/connector-api/operations/#reservation-ver-2017-04-12).",
      "nullable": true
    },
    "CustomerIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of the [Customers](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer) which own the reservations.",
      "nullable": true
    },
    "AssignedResourceIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of [Resources](https://mews-systems.gitbook.io/connector-api/operations/resources/#resource) assigned to the reservations.",
      "nullable": true
    },
    "RateIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of [Rates](https://mews-systems.gitbook.io/connector-api/operations/rates/#rate) assigned to the reservations.",
      "nullable": true
    },
    "BusinessSegmentIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of [Business segments](https://mews-systems.gitbook.io/connector-api/operations/businesssegments/#business-segment) assigned to the reservations.",
      "nullable": true
    },
    "ChannelNumbers": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Set of numbers or references used by the Channel (i.e. OTA, GDS, CRS, etc.) in case the reservation group originates there, e.g. Booking.com confirmation numbers.",
      "nullable": true
    },
    "Numbers": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Confirmation numbers of [Reservations](https://mews-systems.gitbook.io/connector-api/operations/#reservation-ver-2017-04-12).",
      "nullable": true
    },
    "StartUtc": {
      "type": "string",
      "description": "Start of the interval in UTC timezone in ISO 8601 format. Required when used in conjunction with the TimeFilter or States search parameter.",
      "format": "date-time",
      "nullable": true
    },
    "EndUtc": {
      "type": "string",
      "description": "End of the interval in UTC timezone in ISO 8601 format. Required when used in conjunction with the TimeFilter or States search parameter.",
      "format": "date-time",
      "nullable": true
    },
    "TimeFilter": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/ReservationTimeFilter"
        }
      ],
      "description": "Time filter of the interval. If not specified, reservations Colliding with the interval are returned.",
      "nullable": true
    },
    "Currency": {
      "type": "string",
      "description": "ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency) the item costs should be converted to.",
      "format": "currency",
      "nullable": true
    },
    "States": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ServiceOrderStateOld"
      },
      "description": "States the reservations should be in. If not specified, reservations in Confirmed, Started or Processed states or reservations specified by ReservationIds regardless of state are returned.",
      "nullable": true
    },
    "Extent": {
      "title": "Reservation extent",
      "allOf": [
        {
          "$ref": "#/components/schemas/ReservationExtent"
        }
      ],
      "description": "Extent of data to be returned. E.g. it is possible to specify that together with the reservations, customers, groups and rates should be also returned."
    },
    "Limitation": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Limitation"
        }
      ],
      "description": "Limitation on the quantity of data returned."
    }
  },
  "additionalProperties": false,
  "x-schema-id": "ReservationFilterParameters"
}