openapi-to-postmanv2
Version:
Convert a given OpenAPI specification to Postman Collection v2.0
1,421 lines • 1.86 MB
JSON
{
"openapi": "2.0",
"info": {
"title": "OPERA Cloud Reservation API",
"description": "APIs to cater for Reservation functionality in OPERA Cloud. <br /><br />OPERA Cloud Reservations System provides a complete set of capabilities for creating and updating reservations. Reservations are a central feature of OPERA Cloud. As a key source of information, the reservation specifies a guest's arrival date, departure date, room type, rate, packages, and many other details. It is also a gateway to dozens of other functions that contribute to the guest's experience. All reservations in OPERA Cloud require a guest profile. <br /><br /> You can create profiles while booking a reservation. If a profile already exists, you can look it up (using getProfiles in CRM module) and attach it to the reservation during the reservation booking process using the Profile ID.<br /><br /> Compatible with OPERA Cloud release 25.4.0.0.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2025 Oracle and/or its affiliates.</p>",
"version": "25.4.0.0",
"termsOfService": "https://www.oracle.com/legal/terms.html",
"contact": {
"email": "hospitality_apis_ww_grp@oracle.com"
},
"license": {
"name": "UPL",
"url": "https://opensource.org/licenses/upl"
}
},
"schemes": [
"https"
],
"basePath": "/rsv/v1",
"produces": [
"application/json"
],
"paths": {
"/blockReservationStatisticsByDateAndRoomPool": {
"get": {
"summary": "Get block Reservation Statistics",
"description": "Get block Reservation statistics by date and room pool <p><strong>OperationId:</strong>getBlockReservationStatisticsByDateAndRoomPool</p> <p>This API allows a time span of <strong>90</strong> days.</p>",
"operationId": "getBlockReservationStatisticsByDateAndRoomPool",
"parameters": [
{
"name": "excludeBlocksWithoutQuoteID",
"in": "query",
"required": false,
"description": "Whether to exclude blocks without quote IDs from the statistics gathering.",
"type": "boolean"
},
{
"name": "startDate",
"in": "query",
"required": false,
"type": "string",
"format": "date"
},
{
"name": "endDate",
"in": "query",
"required": false,
"type": "string",
"format": "date"
},
{
"name": "duration",
"in": "query",
"required": false,
"type": "string"
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
},
{
"$ref": "#/parameters/x-request-id"
},
{
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/x-externalsystem"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"responses": {
"200": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
}
},
"description": "Response for BlockReservationStatisticsByDateAndRoomPool operation.",
"schema": {
"$ref": "#/definitions/blockReservationStatistics"
}
},
"204": {
"description": "BlockReservationStatisticsByDateAndRoomPool not found."
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"tags": [
"RSVStats"
]
}
},
"/calls": {
"post": {
"summary": "Register Call",
"description": "Register call on a reservation. <p><strong>OperationId:</strong>postCall</p>",
"operationId": "postCall",
"parameters": [
{
"name": "registerCall",
"in": "body",
"required": true,
"description": "Request to register call. Either creates a new call or updates an existing call.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/registerCall"
}
]
}
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
},
{
"$ref": "#/parameters/x-request-id"
},
{
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/x-externalsystem"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"responses": {
"201": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
},
"Location": {
"type": "string",
"description": "Location of newly created resource"
}
},
"description": "Response that contains either created/updated call information if successful or error(s) if not.",
"schema": {
"$ref": "#/definitions/registerCall"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"tags": [
"Reservation"
]
}
},
"/calls/statistics": {
"get": {
"summary": "Get call statistics",
"description": "Use this API to get call statistics. <p><strong>OperationId:</strong>getCallStatistics</p> <p>This API allows a time span of <strong>30</strong> days.</p>",
"operationId": "getCallStatistics",
"parameters": [
{
"name": "end",
"in": "query",
"required": false,
"description": "The ending value of the date range.",
"type": "string",
"format": "date"
},
{
"name": "start",
"in": "query",
"required": false,
"description": "The starting value of the date range.",
"type": "string",
"format": "date"
},
{
"name": "domain",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "appUserName",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
},
{
"$ref": "#/parameters/x-request-id"
},
{
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/x-externalsystem"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"responses": {
"200": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
}
},
"description": "Response object to the request to retrieve Call Statistics.",
"schema": {
"$ref": "#/definitions/callStatistics"
}
},
"204": {
"description": "CallStatistics not found."
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"tags": [
"Reservation"
]
}
},
"/externalSystems/{extSystemCode}/reservations": {
"get": {
"summary": "Get Reservations for a hotel",
"description": "This API will allow a user to retrieve a list of reservations based on the search criteria specified in the request body. For example you can search for reservations using query parameters like first name, last name, arrival/departure date, external confirmation number. <p><strong>OperationId:</strong>getExternalSystemReservations</p>",
"operationId": "getExternalSystemReservations",
"parameters": [
{
"name": "extSystemCode",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system."
},
{
"name": "externalReferenceList",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"items": {
"type": "string"
},
"required": true
},
{
"name": "recentlyAccessed",
"in": "query",
"required": false,
"description": "Mark this reservation as recently accessed.",
"type": "boolean"
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Indicates maximum number of records a Web Service should return.",
"type": "integer"
},
{
"name": "offset",
"in": "query",
"default": 0,
"required": false,
"description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.",
"type": "integer"
},
{
"name": "resvExternalReferencesToFetch",
"in": "query",
"type": "array",
"maxItems": 10,
"collectionFormat": "multi",
"description": "Define the external system(s) to return external reference ids for reservations. A maximum of 10 different external systems can be be provided for this parameter.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "searchType",
"in": "query",
"required": false,
"type": "string",
"uniqueItems": true,
"enum": [
"Any",
"DayUse",
"Arrival",
"Arrived",
"Departure",
"WaitList",
"Cancellation",
"CheckedOut",
"NoShow",
"Complimentary",
"InHouse",
"PostStayPendingBalance",
"PreRegistered",
"PostToRoom",
"OpenFolio",
"ScheduledCheckOut",
"Queued",
"MobileCheckout",
"RegisteredAndInHouse",
"ResvBlockTraces",
"GuestMessages",
"MassCancellation",
"Operator",
"Turndown",
"WalkIn",
"AdvanceCheckedIn",
"OpenBalance",
"AutoFolioSettlement",
"Routing",
"PlayerSnapshot"
],
"description": "Represents Reservation search type Player Snapshot."
},
{
"name": "hotelIds",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"description": "List of Hotels to support searches with multiple resorts for which traces are to be fetched.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "text",
"in": "query",
"required": false,
"description": "Free form text field for searching all reservation fields",
"type": "string"
},
{
"name": "arrivalEndDate",
"in": "query",
"required": false,
"description": "The ending value of the date range.",
"type": "string",
"format": "date"
},
{
"name": "arrivalStartDate",
"in": "query",
"required": false,
"description": "The starting value of the date range.",
"type": "string",
"format": "date"
},
{
"name": "departureEndDate",
"in": "query",
"required": false,
"description": "The ending value of the date range.",
"type": "string",
"format": "date"
},
{
"name": "departureStartDate",
"in": "query",
"required": false,
"description": "The starting value of the date range.",
"type": "string",
"format": "date"
},
{
"name": "expectedArrivalStartTime",
"in": "query",
"required": false,
"description": "The ending value of the time span.",
"type": "string",
"format": "date-time"
},
{
"name": "expectedArrivalEndTime",
"in": "query",
"required": false,
"description": "The starting value of the time span.",
"type": "string",
"format": "date-time"
},
{
"name": "expectedReturnEndTime",
"in": "query",
"required": false,
"description": "The ending value of the time span.",
"type": "string",
"format": "date-time"
},
{
"name": "expectedReturnStartTime",
"in": "query",
"required": false,
"description": "The starting value of the time span.",
"type": "string",
"format": "date-time"
},
{
"name": "companyNames",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Attached profile name",
"items": {
"type": "string"
},
"required": false
},
{
"name": "travelAgentIds",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "companyIds",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "sourceIds",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "contactIds",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "groupIds",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "billingContactIds",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "profileIds",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "membershipCardNumber",
"in": "query",
"required": false,
"description": "Membership ID criteria.",
"type": "string"
},
{
"name": "membershipLevels",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "membershipTypes",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "surname",
"in": "query",
"required": false,
"description": "Family name, last name.",
"type": "string"
},
{
"name": "givenName",
"in": "query",
"required": false,
"description": "Given name, first name or names",
"type": "string"
},
{
"name": "anyVIPStatus",
"in": "query",
"required": false,
"description": "VIP status of the customer.",
"type": "boolean"
},
{
"name": "vipCodes",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "VIP status of the customer.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "guaranteeCode",
"in": "query",
"required": false,
"description": "Fetches the reservation having Guarantee Code(Reservation Type) supplied here.",
"type": "string"
},
{
"name": "paymentMethod",
"in": "query",
"required": false,
"description": "Fetches the reservation having method of payment supplied here.",
"type": "string"
},
{
"name": "discountApplied",
"in": "query",
"default": false,
"required": false,
"description": "Fetches the reservation for which discount is applied",
"type": "boolean"
},
{
"name": "user",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "createdBy",
"in": "query",
"required": false,
"description": "Fetches reservation created by specified user. If both CreatedByUsers and CreatedBy is specified, CreatedByUsers will take precedence.",
"type": "string"
},
{
"name": "cancelledByList",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"description": "Fetches reservations cancelled by list of users.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "cancelledOn",
"in": "query",
"required": false,
"description": "Fetches the reservations which are cancelled on a specific date.",
"type": "string",
"format": "date"
},
{
"name": "ratePlanCodes",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "sourceCodes",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "marketCodes",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "excludeBlockReservations",
"in": "query",
"required": false,
"description": "If true the search result will exclude the blocks reservations.",
"type": "boolean"
},
{
"name": "blockName",
"in": "query",
"required": false,
"description": "The Name of the block that is attached to the reservation.",
"type": "string"
},
{
"name": "blockIds",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "blockCodes",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "customReference",
"in": "query",
"required": false,
"description": "Custom reference",
"type": "string"
},
{
"name": "recordLocator",
"in": "query",
"required": false,
"description": "GDS Record Locator for reservation.",
"type": "string"
},
{
"name": "orderBy",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"items": {
"type": "string",
"enum": [
"Nights",
"ArrivalDate",
"ArrivalDateETR",
"DepartureDate",
"GuestSurname",
"RateAmount",
"RateCode",
"Room",
"RoomType"
]
},
"required": false
},
{
"name": "sortOrder",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"default": [
"Asc"
],
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"Asc",
"Desc"
]
},
"required": false
},
{
"name": "roomAssignedOnly",
"in": "query",
"required": false,
"description": "Indicator to query reservations which have a room number assigned.",
"type": "boolean"
},
{
"name": "roomUnassignedOnly",
"in": "query",
"required": false,
"description": "Indicator to query reservations which does not have a room number assigned.",
"type": "boolean"
},
{
"name": "roomId",
"in": "query",
"required": false,
"description": "Room number of the reservation to search by.",
"type": "string"
},
{
"name": "roomType",
"in": "query",
"required": false,
"type": "array",
"description": "Room Type.",
"maxItems": 4000,
"items": {
"type": "string"
}
},
{
"name": "roomFeatures",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "A code representing a room feature.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "roomSpecials",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Preference value for display purposes.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "roomSmokingPreference",
"in": "query",
"required": false,
"description": "Preference value for display purposes.",
"type": "string"
},
{
"name": "roomFloorPreferences",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Preference value for display purposes.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "housekeepingRoomStatuses",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"Clean",
"Dirty",
"Pickup",
"Inspected",
"OutOfOrder",
"OutOfService"
]
},
"required": false
},
{
"name": "roomClasses",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "roomRangeFrom",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "roomRangeTo",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "communication",
"in": "query",
"required": false,
"description": "Any communication attached to the reservation from the primary guest's profile such as phone, fax or email address.",
"type": "string"
},
{
"name": "phone",
"in": "query",
"required": false,
"description": "The phone number attached to the reservation from the primary guest's profile.",
"type": "string"
},
{
"name": "email",
"in": "query",
"required": false,
"description": "The email address attached to the reservation from the primary guest's profile.",
"type": "string"
},
{
"name": "fetchInstructions",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Instruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"Reservation",
"ReservationID",
"Indicators",
"Deposits",
"RevenuesAndBalances",
"GuestServiceStatus",
"MasterInfo",
"CancellationInfo",
"BlockReservations",
"TaxType",
"GuestDeviceNotification",
"RoomAssignedByAI"
]
},
"required": false
},
{
"name": "allowPreRegistration",
"in": "query",
"required": false,
"description": "Flag containing true or false value for reservation to be eligible for prior check in by guest using mobile device. Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile check in yes / no. Upon fetch, the current state of the flag will show true or false.",
"type": "boolean"
},
{
"name": "hasDepositBalance",
"in": "query",
"required": false,
"description": "Indicates that only reservations with deposit balance should be expected from the result.",
"type": "boolean"
},
{
"name": "hasOpenBalance",
"in": "query",
"required": false,
"description": "Indicates that only reservations with open balance should be expected from the result.",
"type": "boolean"
},
{
"name": "hasOpenFolio",
"in": "query",
"required": false,
"description": "Indicates that only reservations with open folio should be expected from the result.",
"type": "boolean"
},
{
"name": "includeScheduledCheckOut",
"in": "query",
"required": false,
"description": "Criteria that indicates whether to scheduled checkouts or not.",
"type": "boolean"
},
{
"name": "linkedOnly",
"in": "query",
"required": false,
"description": "Indicates that only linked reservations should be expected from the result.",
"type": "boolean"
},
{
"name": "unlinkedOnly",
"in": "query",
"required": false,
"description": "Indicates that only unlinked reservations should be expected from the result.",
"type": "boolean"
},
{
"name": "actualArrivals",
"in": "query",
"required": false,
"description": "Indicates if reservations which have already arrived on the Search Date is required.",
"type": "boolean"
},
{
"name": "actualDepartures",
"in": "query",
"required": false,
"description": "Indicates if reservations which were expected to depart on the Search Date and have already checked, is required.",
"type": "boolean"
},
{
"name": "complimentaryReservations",
"in": "query",
"required": false,
"description": "Indicates if reservations where rate codes are marked as Complimentary Rates , is required. This flag should be used in conjunction with the Arrivals, Departures or StayOvers criteria.",
"type": "boolean"
},
{
"name": "dayOfArrivalCancels",
"in": "query",
"required": false,
"description": "Indicates if reservations which have cancelled on the Search Date which is also the day of arrival is required.",
"type": "boolean"
},
{
"name": "dayUse",
"in": "query",
"required": false,
"description": "Indicates if reservations which are day use reservation on the Search Date, is required.",
"type": "boolean"
},
{
"name": "earlyDepartures",
"in": "query",
"required": false,
"description": "Indicates if reservations which checked out early on the Search Date, is required.",
"type": "boolean"
},
{
"name": "expectedArrivals",
"in": "query",
"required": false,
"description": "Indicates if reservations which are expected arrivals for the Search Date and who have not yet arrived, is required.",
"type": "boolean"
},
{
"name": "expectedDepartures",
"in": "query",
"required": false,
"description": "Indicates if reservations which are expected departures for the Search Date and who have not yet departed, is required.",
"type": "boolean"
},
{
"name": "extendedStays",
"in": "query",
"required": false,
"description": "Indicates if reservations which have extended their stays on the Search Date, is required.",
"type": "boolean"
},
{
"name": "houseUseReservations",
"in": "query",
"required": false,
"description": "Indicates if reservations where rate codes are marked as House Use Rates , is required. This flag should be used in conjunction with the Arrivals, Departures or StayOvers criteria.",
"type": "boolean"
},
{
"name": "stayovers",
"in": "query",
"required": false,
"description": "Indicates if reservations which are StayOvers on the Search Date, is required.",
"type": "boolean"
},
{
"name": "stayDate",
"in": "query",
"required": false,
"description": "Date for searching the reservations. This is the date for which the search types are applicable. If date is not available, the business date will be used by default.",
"type": "string",
"format": "date"
},
{
"name": "roomRoutingId",
"in": "query",
"required": false,
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"type": "string"
},
{
"name": "excludePseudoRoomReservations",
"in": "query",
"required": false,
"description": "Indicates to exclude Pseudo room reservations.",
"type": "boolean"
},
{
"name": "excludeReservationIds",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "excludeVIPStatusCodes",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "VIP status of the customer.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "excludeSpecials",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Preference value for display purposes.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "excludeFloorPreferences",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Preference value for display purposes.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "excludeAdvanceCheckedIn",
"in": "query",
"required": false,
"description": "Indicates to exclude Advance Checked In Reservations from search result.",
"type": "boolean"
},
{
"name": "excludeRoomFeatures",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Exclude the reservation(s) with provided room features from the search result.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "playerId",
"in": "query",
"required": false,
"description": "Player ID associated to the reservation.",
"type": "string"
},
{
"name": "gamingBalanceFrom",
"in": "query",
"required": false,
"description": "Balance from.",
"type": "number"
},
{
"name": "gamingBalanceTo",
"in": "query",
"required": false,
"description": "Balance to.",
"type": "number"
},
{
"name": "compAccountingBalanceFrom",
"in": "query",
"required": false,
"description": "Comp Balance From",
"type": "number"
},
{
"name": "compAccountingBalanceTo",
"in": "query",
"required": false,
"description": "Comp Balance To",
"type": "number"
},
{
"name": "searchTypes",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"uniqueItems": true,
"description": "Represents Reservation search type Player Snapshot.",
"items": {
"type": "string",
"enum": [
"Any",
"DayUse",
"Arrival",
"Arrived",
"Departure",
"WaitList",
"Cancellation",
"CheckedOut",
"NoShow",
"Complimentary",
"InHouse",
"PostStayPendingBalance",
"PreRegistered",
"PostToRoom",
"OpenFolio",
"ScheduledCheckOut",
"Queued",
"MobileCheckout",
"RegisteredAndInHouse",
"ResvBlockTraces",
"GuestMessages",
"MassCancellation",
"Operator",
"Turndown",
"WalkIn",
"AdvanceCheckedIn",
"OpenBalance",
"AutoFolioSettlement",
"Routing",
"PlayerSnapshot"
]
},
"required": false
},
{
"name": "reservationStatuses",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Reservation status type for reservations search.",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"Cancelled",
"CheckedOut",
"CheckedIn",
"DueIn",
"DueOut",
"InHouse",
"NoShow",
"WaitList"
]
},
"required": false
},
{
"name": "transportationCodes",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"description": "Codes to be searched.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "roomReadyStatuses",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Enum to denote the Status of Readiness messages sent to Guest Devices.",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"Pending",
"Completed",
"Failed",
"Sent",
"Received",
"Cancelled",
"PendingAvailability"
]
},
"required": false
},
{
"name": "checkoutMessageReceived",
"in": "query",
"required": false,
"description": "Fetches the reservations for which Checkout Message is received.",
"type": "boolean"
},
{
"name": "optedForCommunication",
"in": "query",
"required": false,
"description": "Fetches the reservations for which reservation communication has been opted.",
"type"