openapi: 3.2.0 info: title: Oracle Hospitality Hotel Config API version: 26.2.0.0 contact: email: hospitality_apis_ww_grp@oracle.com license: name: UPL url: https://opensource.org/licenses/upl termsOfService: https://www.oracle.com/legal/terms.html description: 'Operations tagged HotelConfig across 7 of this provider''s published API definitions: oracle-hospitality-property-v1-crmcfg.json, oracle-hospitality-property-v1-entcfg.json, oracle-hospitality-property-v1-evmcfg.json, oracle-hospitality-property-v1-fofcfg.json, oracle-hospitality-property-v1-rmcfg.json, oracle-hospitality-property-v1-rsvcfg.json, oracle-hospitality-property-v1-rtp.json. Each path carries the servers of the definition it was published in.' servers: - url: /crm/config/v1 - url: /ent/config/v1 - url: /evm/config/v1 - url: /fof/config/v1 - url: /rm/config/v1 - url: /rsv/config/v1 - url: /rtp/v1 tags: - name: HotelConfig description: These APIs will allow you to configure profile related configuration related to Administration. paths: /availablePreferences: get: summary: Get available Preferences description: Use this API to Fetch Available Preferences for a Property. The request can be filtered to search only for preferences marked for reservation.

OperationId:getAvailablePreferences

operationId: getAvailablePreferences parameters: - name: hotelId in: query required: true schema: type: string - name: isOnlyForReservation in: query required: false description: Flag for available reservation preferences, by default its true schema: type: boolean default: 'true' - name: preferenceType in: query required: false schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: A collection of preferences content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/availablePreferencesDetails' '204': description: AvailablePreferences not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /crm/config/v1 /communicationTypes: get: summary: Get communication types description: Use this API to get communication types.

OperationId:getCommunicationTypes

operationId: getCommunicationTypes parameters: - name: codes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: roles in: query description: Phone Number Communication Role. required: false style: form explode: true schema: type: array items: type: string enum: - Email - Fax - EmailForRequest - Webpage - Phone uniqueItems: true - name: description in: query required: false description: Description of the Communication Types to be searched. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Communication Types. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/communicationTypesDetails' '204': description: CommunicationTypes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create a communication type description: Use this API to create a communication type.

OperationId:postCommunicationType

operationId: postCommunicationType parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/communicationTypeCriteria' description: Request object for creating a new Communication Type. required: true servers: - url: /crm/config/v1 /communicationTypes/{communicationTypeCode}: delete: summary: Delete a communication type description: Use this API to delete a communication type.

OperationId:removeCommunicationType

operationId: removeCommunicationType parameters: - name: communicationTypeCode in: path required: true description: Unique Code of communication Types. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change a communication type description: Use this API to update a communication type.

OperationId:changeCommunicationType

operationId: changeCommunicationType parameters: - name: communicationTypeCode in: path required: true description: Unique Code of communication Types. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/communicationTypeToBeChanged' description: Request object for changing an existing Communication Type. required: true servers: - url: /crm/config/v1 /services/hotelConfig/status: get: summary: ' ping' description: Ping Hotel Configuration Service

OperationId:pingHotelConfigServices

operationId: pingHotelConfigServices parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for Ping operation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/operaVersion' '204': description: pingHotelConfigServices not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /crm/config/v1 /airports: get: summary: Get template airports description: Use this API to get template airports.

OperationId:getTemplateAirports

operationId: getTemplateAirports parameters: - name: airportCodes in: query description: Airport code identifying the airport. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching template airports. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateAirportsDetails' '204': description: TemplateAirports not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create new template airports description: Use this API to create new template airports.

OperationId:postTemplateAirports

operationId: postTemplateAirports parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateAirportsCriteria' description: Request object for creating new template airports. required: true servers: - url: /ent/config/v1 /airports/{airportCode}: put: summary: Change template airports description: Use this API to update template airports.

OperationId:changeTemplateAirports

operationId: changeTemplateAirports parameters: - name: airportCode in: path required: true description: Unique Code of airport. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateAirportsToBeChanged' description: Request object for modifying template airports. required: true delete: summary: Delete template airports description: Use this API to delete template airports.

OperationId:removeTemplateAirports

operationId: removeTemplateAirports parameters: - name: airportCode in: path required: true description: Unique Code of airport. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /amenities: get: summary: ' Get template amenities' description: ' Use this API to get template amenities.

OperationId:getTemplateAmenities

' operationId: getTemplateAmenities parameters: - name: general in: query required: false description: Is it a General amenity type. schema: type: boolean - name: meeting in: query required: false description: Is it a Meeting amenity type. schema: type: boolean - name: amenityCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching amenities at the template level. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateAmenitiesDetails' '204': description: TemplateAmenities not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create template amenities description: Use this API to create template amenities.

OperationId:postTemplateAmenities

operationId: postTemplateAmenities parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateAmenitiesCriteria' description: Request object for creating amenities at the template level. required: true servers: - url: /ent/config/v1 /amenities/{featureCode}: put: summary: Change template amenities description: Use this API to update template amenities.

OperationId:changeTemplateAmenities

operationId: changeTemplateAmenities parameters: - name: featureCode in: path required: true description: Unique Code of feature. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateAmenitiesToBeChanged' description: Request object for changing amenities at the template level. required: true delete: summary: Delete template amenities description: Use this API to delete template amenities.

OperationId:removeTemplateAmenities

operationId: removeTemplateAmenities parameters: - name: featureCode in: path required: true description: Unique Code of feature. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /attractions: get: summary: Get Attraction Template description: This API accepts the attraction template request search criteria and fetches the attraction templates that match the criteria.

OperationId:getAttractionTemplates

operationId: getAttractionTemplates parameters: - name: attractionCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: classCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for information regarding attraction templates. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/attractionTemplatesDetails' '204': description: AttractionTemplates not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Attraction Template description: This API is used to create a new attraction template based on the request. .

OperationId:postAttractionTemplates

operationId: postAttractionTemplates parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/attractionTemplatesCriteria' description: Request object for creating a new attraction code template. required: true servers: - url: /ent/config/v1 /attractions/{attractionCode}: put: summary: Change Attraction Template description: This API is used to update an existing attraction template.

OperationId:changeAttractionTemplates

operationId: changeAttractionTemplates parameters: - name: attractionCode in: path required: true description: Unique Code of attraction template. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/attractionTemplatesToBeChanged' description: Request object for modifying the existing attraction attraction templates. required: true delete: summary: Delete an existing attraction template description: Use this API to delete an existing attraction template.

OperationId:removeAttractionTemplates

operationId: removeAttractionTemplates parameters: - name: attractionCode in: path required: true description: Unique Code of attraction template. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /calendar: get: summary: Get Hotel Calendar description: Use this API to get detailed information of calendar entries for a date range.

OperationId:getPropertyCalendar

operationId: getPropertyCalendar parameters: - name: startDate in: query required: true schema: type: string format: date - name: endDate in: query required: true schema: type: string format: date - name: fetchInstructions in: query description: Indicates entries for a day in calendar. Entries can vary between day types, events, etc. required: true style: form explode: true schema: type: array items: type: string enum: - DayType - Event uniqueItems: true - name: hotelId in: query required: false description: Hotel for which calendar is being represented. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching calendar entries for a hotel. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/hotelCalendarDetails' '204': description: PropertyCalendar not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /configurations/activityLogs: get: summary: Get Configuration Activity Logs description: Use this API to Fetch Configuration Activity logs from Activity Group or Type.

OperationId:getConfigActivityLog

The maximum allowable limit for this API is 20.

This API allows a time span of 4 days.

operationId: getConfigActivityLog parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: hotelId in: query required: false description: Hotel code. schema: type: string - name: module in: query required: false description: Activity module. schema: type: string enum: - Reservation - Contract - Allotment - Outlookview - Profile - Accountreceivables - GdsConvRateCodes - RateCode - Billing - Activity uniqueItems: true - name: parameterName in: query description: Name of the parameter. required: false style: form explode: true schema: type: array items: type: string - name: parameterValue in: query description: Value of the parameter. required: false style: form explode: true schema: type: array items: type: string - name: activityGroup in: query required: false schema: type: string - name: activityType in: query required: false schema: type: string - name: fromDate in: query required: false description: Search from date for the user activity log. schema: type: string format: date - name: toDate in: query required: false description: Search to date for the user activity log. schema: type: string format: date - name: searchText in: query required: false description: Search text for the user activity log. schema: type: string - name: userByIds in: query required: false style: form explode: true schema: type: array items: type: integer maxItems: 4000 - name: userForIds in: query required: false style: form explode: true schema: type: array items: type: integer maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching configuration activity log. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/configActivityLogDetails' '204': description: ConfigActivityLog not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create a new Config Activity Log description: Use this API to create a new Activity Log.

OperationId:postConfigActivityLog

operationId: postConfigActivityLog parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/createConfigActivityLogCriteria' description: Request object for creating Config Activity Logs. required: true servers: - url: /ent/config/v1 /countries: get: summary: Get template Countries description: Use this API to get template Countries.

OperationId:getTemplateCountries

operationId: getTemplateCountries parameters: - name: countriesCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching template Countries. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateCountriesDetails' '204': description: TemplateCountries not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create template Countries description: Use this API to create template Countries.

OperationId:postTemplateCountries

operationId: postTemplateCountries parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateCountriesCriteria' description: Request object for creating new template Countries. required: true servers: - url: /ent/config/v1 /countries/{countryCode}: put: summary: Change template Countries description: Use this API to update template Countries.

OperationId:changeTemplateCountries

operationId: changeTemplateCountries parameters: - name: countryCode in: path required: true description: Unique Code of country. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateCountriesToBeChanged' description: Request object for modifying template Countries. required: true delete: summary: Delete template Countries description: Use this API to delete template Countries.

OperationId:removeTemplateCountries

operationId: removeTemplateCountries parameters: - name: countryCode in: path required: true description: Unique Code of country. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /currencyExchangeRates: get: summary: Get Currency Exchange Rates description: Fetch the currency exchange rates when using this API.

OperationId:getCurrencyExchangeRates

operationId: getCurrencyExchangeRates parameters: - name: exchangeType in: query required: false description: Exchange Rate Types schema: type: string enum: - Posting - Settlement - Exchangecash - Travelagent - Forecast - Membership - Exchangecheck - Certificate uniqueItems: true - name: hotelIds in: query description: List of Hotels for which the currency exchange rate information is required. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: currencyCode in: query required: false description: Currency Code for which the exchange rate is requested. Sending no currency code will return values for all available currency codes. schema: type: string - name: currencyCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: List of currency codes with their exchange rates. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/currencyExchangeRatesDetails' '204': description: CurrencyExchangeRates not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /dayTypeCodes: get: summary: Get Template Day Type Codes description: Use this API to get Template Day Type Codes.

OperationId:getTemplateDayTypeCodes

operationId: getTemplateDayTypeCodes parameters: - name: dayTypesCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching template day type codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateDayTypeCodesDetails' '204': description: TemplateDayTypeCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Template Day Type Codes description: Use this API to update Template Day Type Codes.

OperationId:changeTemplateDayTypeCodes

operationId: changeTemplateDayTypeCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateDayTypeCodesToBeChanged' description: Request object for modifying template day type codes. required: true delete: summary: Delete Template Day Type Codes description: Use this API to delete Template Day Type Codes.

OperationId:removeTemplateDayTypeCodes

operationId: removeTemplateDayTypeCodes parameters: - name: templateDayTypeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Template Day Type Codes description: Use this API to create Template Day Type Codes.

OperationId:postTemplateDayTypeCodes

operationId: postTemplateDayTypeCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateDayTypeCodesCriteria' description: Request object for creating new template day type codes. required: true servers: - url: /ent/config/v1 /dayTypes: put: summary: Set day type for a date range description: You can use this API to set day type for a date range.

OperationId:setDayTypes

operationId: setDayTypes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/setDayTypes' description: Request object for setting day type for specified date range. required: true servers: - url: /ent/config/v1 /dayTypes/{dayType}: delete: summary: Delete day type for a date range description: Use this API to delete day type for a date range.

OperationId:removeDayTypes

operationId: removeDayTypes parameters: - name: dayType in: path required: true description: Unique Code of day type. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: query description: Day type code selected. required: false style: form explode: true schema: type: array items: type: string - name: friday in: query required: false schema: type: boolean - name: monday in: query required: false schema: type: boolean - name: saturday in: query required: false schema: type: boolean - name: sunday in: query required: false schema: type: boolean - name: thursday in: query required: false schema: type: boolean - name: tuesday in: query required: false schema: type: boolean - name: wednesday in: query required: false schema: type: boolean - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: duration in: query required: false schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /departments: get: summary: Get Departments description: Use this API to get Departments.

OperationId:getDepartments

operationId: getDepartments parameters: - name: hotelIds in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: departmentCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: departmentWildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching departments. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/departmentsDetails' '204': description: Departments not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Departments description: Use this API to create Departments.

OperationId:postDepartments

operationId: postDepartments parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/departmentsCriteria' description: Request object for creating new departments. required: true servers: - url: /ent/config/v1 /departments/{departmentCode}: delete: summary: Delete Departments description: Use this API to delete Departments.

OperationId:removeDepartments

operationId: removeDepartments parameters: - name: departmentCode in: path required: true description: Unique Code of department. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: query required: false description: Hotel where the code is configured. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Departments description: Use this API to update Departments.

OperationId:changeDepartments

operationId: changeDepartments parameters: - name: departmentCode in: path required: true description: Unique Code of department. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/departmentsToBeChanged' description: Request object for updating departments. required: true servers: - url: /ent/config/v1 /hotelDetails: get: summary: Get hotel details specified at the template level description: Use this API to get hotel details specified at the template level.

OperationId:getTemplateHotelDetails

operationId: getTemplateHotelDetails parameters: - name: hotelDetailCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: hotelDetailCategoriesCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching hotel details at the template level. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateHotelDetailsDetails' '204': description: TemplateHotelDetails not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create hotel details at the template level description: Use this API to create hotel details at the template level.

OperationId:postTemplateHotelDetails

operationId: postTemplateHotelDetails parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateHotelDetailsCriteria' description: Request object for creating hotel details at the template level. required: true put: summary: Change hotel details specified at the template level description: Use this API to update hotel details specified at the template level.

OperationId:changeTemplateHotelDetails

operationId: changeTemplateHotelDetails parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateHotelDetailsToBeChanged' description: Request object for changing hotel details at the template level. required: true delete: summary: Delete hotel details specified at the template level description: Use this API to delete hotel details specified at the template level.

OperationId:removeTemplateHotelDetails

operationId: removeTemplateHotelDetails parameters: - name: templateHotelDetailCode in: query description: Specifies the hotel detail code. required: false style: form explode: true schema: type: array items: type: string - name: templateHotelDetailCategory in: query description: Specifies the hotel detail category. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotelDetails/copy: put: summary: Copy template hotel details to other properties description: Use this API to copy template hotel details to other properties.

OperationId:copyHotelDetails

operationId: copyHotelDetails parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyHotelDetails' description: Request object for copying template hotel details to hotel(s). required: true servers: - url: /ent/config/v1 /hotels: get: summary: Get Hotels description: Use this API to return hotel configuration information based on search criteria such as hotelId, name.

OperationId:getHotels

operationId: getHotels parameters: - name: hotelId in: query required: false description: Code identifying the hotel. schema: type: string - name: name in: query required: false description: Hotel name to be searched. schema: type: string - name: countryCode description: Code for a country or a nationality (e.g. SW, USA, IN). This is configured chain wise and can be retrieved via /lov/{version}/listOfValues/Countries in: query required: false schema: type: string maxLength: 10 minLength: 0 - name: marketingRegionCode description: Marketing Region Code where the given cities are located. This is configured chain wise and can be retrieved via /lov/{version}/listOfValues/MarketingRegions in: query required: false schema: type: string maxLength: 40 minLength: 0 - name: marketingCity description: Marketing City where the properties are located. This is configured chain wise and can be retrieved via /lov/{version}/listOfValues/MarketingCityTemplates in: query required: false schema: type: string maxLength: 40 minLength: 0 - name: propertyTypeCode in: query required: false description: Property Type to filter the search result. This is configured chain wise and can be retrieved via /lov/{version}/listOfValues/HotelTypes style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: fetchInstructions in: query description: 'Indicates the search mode to further filter the properties, ex: when it is marked as CateringEvent, it should fetch the CATERING_EVENTS active properties' required: false style: form explode: true schema: type: array items: type: string enum: - CateringEvent uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching lists of Property summary information. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/hotelsDetails' '204': description: Hotels not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/attractions/{attractionCode}: delete: summary: Delete Attractions description: ' Use this API to remove an existing attraction.

OperationId:removeAttractionsByCode

' operationId: removeAttractionsByCode parameters: - name: attractionCode in: path required: true description: Unique Code of attraction. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: query description: Hotel where the code is configured. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}: get: summary: Get a Hotel description: Use this API to return hotel configuration information details for a specific property. Specific areas of configuration can be returned based on the fetchInstructions query parameter such as General, Attraction, Airports, Alternatehotels, Raterange, etc..

OperationId:getHotel

operationId: getHotel parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: fetchInstructions in: query description: Simple type for hotel fetch instruction. required: false style: form explode: true schema: type: array items: type: string enum: - General - Attraction - Transportation - Package - Dining - Feature - Directions - GeneralNotes - Airports - Alternatehotels - Miscellaneous - Raterange - Contacts - EventSpaces - Notes - Corporateinformation - Meetingrooms uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Property configuration information. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/hotelDetails' '204': description: Hotel not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Update hotel information description: Use this API to update hotel configuration information.

OperationId:putHotel

operationId: putHotel parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelToBeChanged' description: Request object for changing Property general information. required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/airports: get: summary: Get resort airports description: Use this API to get resort airports.

OperationId:getAirports

operationId: getAirports parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: airportCodes in: query description: Airport code identifying the airport. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching airports configured for hotels. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/airportsDetails' '204': description: Airports not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create new resort airports description: Use this API to create new resort airports.

OperationId:postAirports

operationId: postAirports parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/airportsCriteria' description: Request object for creating new airports for hotels. required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/airports/{airportCode}: put: summary: Change resort airports description: Use this API to update resort airports.

OperationId:changeAirports

operationId: changeAirports parameters: - name: airportCode in: path required: true description: Unique Code of airport. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/airportsToBeChanged' description: Request object for modifying airports for hotels. required: true delete: summary: Delete resort airports description: Use this API to delete resort airports.

OperationId:removeAirports

operationId: removeAirports parameters: - name: airportCode in: path required: true description: Unique Code of airport. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/alternates: post: summary: Create Alternate Hotels description: This API Use this API to creates the hotels Alternate Hotel information.

OperationId:postAlternateHotels

operationId: postAlternateHotels parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/alternateHotelsCriteria' description: Request object for creating new Alternate Hotels for hotels. required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/alternates/{alternateHotelId}: put: summary: Update Alternate Hotels description: This API updated the hotel's Alternate Hotel information.

OperationId:changeAlternateHotels

operationId: changeAlternateHotels parameters: - name: alternateHotelId in: path required: true description: Unique ID of alternate hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/alternateHotelsToBeChanged' description: Request object for changing hotel Alternate Hotels for hotels. required: true delete: summary: Delete Alternate Hotels description: This API Use this API to deletes the hotel's Alternate Hotel information.

OperationId:removeAlternateHotels

operationId: removeAlternateHotels parameters: - name: alternateHotelId in: path required: true description: Unique ID of alternate hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/amenities: get: summary: Get amenities description: Use this API to get amenities.

OperationId:getAmenities

operationId: getAmenities parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: general in: query required: false description: Is it a General amenity type. schema: type: boolean - name: meeting in: query required: false description: Is it a Meeting amenity type. schema: type: boolean - name: amenityCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching amenities at the property level. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/amenitiesDetails' '204': description: Amenities not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create amenities description: Use this API to create amenities.

OperationId:postAmenities

operationId: postAmenities parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/amenitiesCriteria' description: Request object for creating amenities at the property level. required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/amenities/{featureCode}: put: summary: Change amenities description: Use this API to update amenities.

OperationId:changeAmenities

operationId: changeAmenities parameters: - name: featureCode in: path required: true description: Unique Code of feature. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/amenitiesToBeChanged' description: Request object for changing amenities at the property level. required: true delete: summary: Delete amenities description: Use this API to delete amenities.

OperationId:removeAmenities

operationId: removeAmenities parameters: - name: featureCode in: path required: true description: Unique Code of feature. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: beginDate in: query description: The date the amenity is scheduled to become active. required: false style: form explode: true schema: type: array items: type: string format: date - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/attractions: get: summary: Get Attractions description: Use this API to get Attractions.

OperationId:getAttractions

operationId: getAttractions parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: attractionCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: classCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for information regarding attraction. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/attractionsDetails' '204': description: Attractions not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Attractions description: This API can be used to Use this API to create a new attraction for a property. .

OperationId:postAttractions

operationId: postAttractions parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/attractionsCriteria' description: Request object for creating a new group of attractions. required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/attractions/{attractionCode}: put: summary: Update an Attraction description: This API is used to Use this API to update an existing attraction. .

OperationId:changeAttractions

operationId: changeAttractions parameters: - name: attractionCode in: path required: true description: Unique Code of attraction. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/attractionsToBeChanged' description: Request object for modifying an existing attraction. required: true delete: summary: Delete Attractions description: ' Use this API to remove an existing attraction.

OperationId:removeAttractions

' operationId: removeAttractions parameters: - name: attractionCode in: path required: true description: Unique Code of attraction. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: attractionCodes in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/calendar: get: summary: Get Hotel Calendar description: Use this API to get detailed information of calendar entries for a date range.

OperationId:getHotelCalendar

operationId: getHotelCalendar parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: startDate in: query required: true schema: type: string format: date - name: endDate in: query required: true schema: type: string format: date - name: fetchInstructions in: query description: Indicates entries for a day in calendar. Entries can vary between day types, events, etc. required: true style: form explode: true schema: type: array items: type: string enum: - DayType - Event uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching calendar entries for a hotel. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/hotelCalendarDetails' '204': description: HotelCalendar not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/centralConfigs/{config}: get: summary: Lists the configurations managed centrally description: This API will get the configuration items added from central within the property for this Configuration.

OperationId:getCentralConfig

operationId: getCentralConfig parameters: - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - name: config in: path required: true description: Configuration to be checked for listing the centrally managed items. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: List of configurations added from central. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/centralConfigsResponse' '204': description: Central Configs not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/centralConfigs/{config}/items/{code}: put: summary: Change the status for Central Config to manage at Hotel/Enterprise Level. description: This API will manage if config can be updated from Hotel.

OperationId:changeCentralConfig

operationId: changeCentralConfig parameters: - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 200 minLength: 1 - name: config in: path required: true description: Configuration to be checked for listing the configs. schema: type: string maxLength: 200 minLength: 1 - name: code in: path required: true description: Configuration Item to be modified. schema: type: string maxLength: 200 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of updated resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/centralConfigRequest' description: Central Configuration required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/contacts: post: summary: Create Hotel Contacts description: Use this API to create Hotel Contacts.

OperationId:postHotelContacts

operationId: postHotelContacts parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelContactsCriteria' description: Request object for creating new Contacts for hotels. required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/contacts/{contactId}: put: summary: Change Hotel Contact description: Use this API to update Hotel Contact.

OperationId:changeHotelContacts

operationId: changeHotelContacts parameters: - name: contactId in: path required: true description: Unique ID of contact. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelContactsToBeChanged' description: Request object for changing hotel Contacts for hotels. required: true delete: summary: Delete Hotel contact description: Use this API to delete Hotel contact.

OperationId:removeHotelContacts

operationId: removeHotelContacts parameters: - name: contactId in: path required: true description: Unique ID of contact. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: idExtension in: query required: false description: Additional identifying value assigned by the creating system. schema: type: integer - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/countries: get: summary: Get Countries description: Use this API to get Countries.

OperationId:getCountries

The maximum allowable limit for this API is 20.

operationId: getCountries parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: countriesCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string maxLength: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Countries. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/countriesDetails' '204': description: Countries not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/countries/{countryCode}: put: summary: Update a Country Code description: Update a Country Code.

OperationId:changeCountries

operationId: changeCountries parameters: - name: countryCode in: path required: true description: Unique Code of country. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/countriesToBeChanged' description: Request object for modifying Countries for hotels. required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/creditcardTypes: get: summary: Get Credit Card Types description: Use this API to get Credit Card Types.

OperationId:getCreditCardTypes

operationId: getCreditCardTypes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: fetchInactive in: query required: false description: Determines wether to fetch inactive records or not. schema: type: boolean - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Credit Card Types. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/creditCardTypesDetails' '204': description: CreditCardTypes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig delete: summary: Delete Credit Card Types description: Use this API to delete Credit Card Types.

OperationId:removeCreditCardTypes

operationId: removeCreditCardTypes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: creditCardTypesCode in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Credit Card Types description: Use this API to update Credit Card Types.

OperationId:changeCreditCardTypes

operationId: changeCreditCardTypes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/creditCardTypesToBeChanged' description: Request object for changing Credit Card Types. required: true post: summary: Create Credit Card Types description: Use this API to create Credit Card Types.

OperationId:postCreditCardTypes

operationId: postCreditCardTypes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/creditCardTypesCriteria' description: Request object for creating Credit Card Types. required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/dayTypeCodes: get: summary: Get Hotel Day Type Codes description: Use this API to get Hotel Day Type Codes.

OperationId:getHotelDayTypeCodes

operationId: getHotelDayTypeCodes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: dayTypesCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching day type codes for a hotel. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/hotelDayTypeCodesDetails' '204': description: HotelDayTypeCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Hotel Day Type Codes description: Use this API to update Hotel Day Type Codes.

OperationId:changeHotelDayTypeCodes

operationId: changeHotelDayTypeCodes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelDayTypeCodesToBeChanged' description: Request object for modifying day type codes for a hotel. required: true post: summary: Create Hotel Day Type Codes description: Use this API to create Hotel Day Type Codes.

OperationId:postHotelDayTypeCodes

operationId: postHotelDayTypeCodes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelDayTypeCodesCriteria' description: Request object for creating new day type codes for a hotel. required: true delete: summary: Delete Hotel Day Type Codes description: Use this API to delete Hotel Day Type Codes.

OperationId:removeHotelDayTypeCodes

operationId: removeHotelDayTypeCodes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/events: put: summary: 'Set hotel events ' description: Set hotel events.

OperationId:setHotelEvents

operationId: setHotelEvents parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/setHotelEvents' description: Request object for setting hotel events for specified date range. required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/events/{eventId}: delete: summary: Delete Hotel Events description: Use this API to delete Hotel Events.

OperationId:removeHotelEvents

operationId: removeHotelEvents parameters: - name: eventId in: path required: true description: Unique ID of event. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: friday in: query required: false schema: type: boolean - name: monday in: query required: false schema: type: boolean - name: saturday in: query required: false schema: type: boolean - name: sunday in: query required: false schema: type: boolean - name: thursday in: query required: false schema: type: boolean - name: tuesday in: query required: false schema: type: boolean - name: wednesday in: query required: false schema: type: boolean - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: duration in: query required: false schema: type: string - name: eventTitle in: query required: false schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/hotelBrochure: get: summary: Get Hotel Brochure description: This API Use this API to gets the hotel brochure information based on the search criteria. The Hotel code and a set of instructions can be sent as part of the request message.

OperationId:getHotelBrochure

operationId: getHotelBrochure parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: fetchInstructions in: query description: Simple type for hotel fetch instruction. required: false style: form explode: true schema: type: array items: type: string enum: - General - Attraction - Transportation - Package - Dining - Feature - Directions - GeneralNotes - Airports - Alternatehotels - Miscellaneous - Raterange - Contacts - EventSpaces - Notes - Corporateinformation - Meetingrooms uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Basic Property information. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/hotelBrochureDetails' '204': description: HotelBrochure not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/hotelDetails: get: summary: 'Get hotel details ' description: Use this API to get hotel details.

OperationId:getHotelDetails

operationId: getHotelDetails parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: hotelDetailCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: hotelDetailCategoriesCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching hotel details at the property level. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/hotelDetailsDetails' '204': description: HotelDetails not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/jobTitles: get: summary: Get resort job titles description: Use this API to get resort job titles.

OperationId:getJobTitles

operationId: getJobTitles parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: jobTitleCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching job titles configured for hotels. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/jobTitlesDetails' '204': description: JobTitles not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create new resort job titles description: Use this API to create new resort job titles.

OperationId:postJobTitles

operationId: postJobTitles parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/jobTitlesCriteria' description: Request object for creating new job titles for hotels. required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/jobTitles/{jobTitleCode}: put: summary: Change resort job titles description: Use this API to update resort job titles.

OperationId:changeJobTitles

operationId: changeJobTitles parameters: - name: jobTitleCode in: path required: true description: Code for Job Title. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/jobTitlesToBeChanged' description: Request object for modifying job titles for hotels. required: true delete: summary: Delete resort job titles description: Use this API to delete resort job titles.

OperationId:removeJobTitles

operationId: removeJobTitles parameters: - name: jobTitleCode in: path required: true description: Code for Job Title. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/marketingCities: get: summary: Get resort marketing cities description: Use this API to get resort marketing cities.

OperationId:getMarketingCities

The maximum allowable limit for this API is 20.

operationId: getMarketingCities parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Flag to indicate whether to include inactive marketing cities in the results or not. schema: type: boolean - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: marketingCitys in: query description: List of Marketing Cities. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: regionCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: description in: query required: false description: Marketing city description to search for. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching marketing cities configured for hotels. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/marketingCitiesDetails' '204': description: MarketingCities not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create new resort marketing cities description: Use this API to create new resort marketing cities.

OperationId:postMarketingCities

operationId: postMarketingCities parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/marketingCitiesCriteria' description: Request object for creating new marketing cities for hotels. required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/marketingCities/{cityCode}: put: summary: Change resort marketing cities description: Use this API to update resort marketing cities.

OperationId:changeMarketingCities

operationId: changeMarketingCities parameters: - name: cityCode in: path required: true description: Unique Code of city. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/marketingCitiesToBeChanged' description: Request object for modifying marketing cities for hotels. required: true delete: summary: Delete resort marketing cities description: Use this API to delete resort marketing cities.

OperationId:removeMarketingCities

operationId: removeMarketingCities parameters: - name: cityCode in: path required: true description: Unique Code of city. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: regionCode in: query required: false description: Region code the marketing city belongs to. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/notes: post: summary: Create Note information description: Use this API to create Note information.

OperationId:postHotelNotes

operationId: postHotelNotes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelNotesCriteria' description: Request object for creating new Notes for the hotels required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/notes/{noteCode}: put: summary: Update Note information description: Update Note information.

OperationId:changeHotelNotes

operationId: changeHotelNotes parameters: - name: noteCode in: path required: true description: Unique Code of note. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelNotesToBeChanged' description: Request object for changing hotel Notes for hotels. required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/operaContext: get: summary: Get Opera Hotel Context description: This API will retrieve general contextual information for the specified hotel such as business date.

OperationId:getOperaHotelContext

operationId: getOperaHotelContext parameters: - name: hotelId in: path required: true description: Unique ID of hotel schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: The result element returned with general hotel contextual information. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/operaHotelContextDetails' '204': description: OperaHotelContext not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/rateRanges: post: summary: Create Rate Range information description: Use this API to create Rate Range information.

OperationId:postHotelRateRanges

operationId: postHotelRateRanges parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelRateRangesCriteria' description: Request object for creating new Rate Ranges for hotels. required: true put: summary: Update Rate Range information description: Update Rate Range information.

OperationId:changeHotelRateRanges

operationId: changeHotelRateRanges parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelRateRangesToBeChanged' description: Request object for changing hotel Rate Ranges for hotels. required: true delete: summary: Delete Rate Range information description: Use this API to delete Rate Range information.

OperationId:removeHotelRateRanges

operationId: removeHotelRateRanges parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: duration in: query required: false schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/restaurants: post: summary: Create restaurant information description: Use this API to create restaurant information.

OperationId:postHotelRestaurants

operationId: postHotelRestaurants parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelRestaurantsCriteria' description: Request object for creating new restaurants for hotels. required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/restaurants/{restaurantCode}: put: summary: Update the restaurant information description: Update the restaurant information.

OperationId:changeHotelRestaurants

operationId: changeHotelRestaurants parameters: - name: restaurantCode in: path required: true description: Unique Code of restaurant. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelRestaurantsToBeChanged' description: Request object for changing hotel restaurants for hotels. required: true delete: summary: Delete restaurant information description: Use this API to delete restaurant information.

OperationId:removeHotelRestaurants

operationId: removeHotelRestaurants parameters: - name: restaurantCode in: path required: true description: Unique Code of restaurant. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/telephoneBookCategories: get: summary: Get Telephone Book Category description: Use this API to get Telephone Book Category.

OperationId:getTelephoneBookCategories

operationId: getTelephoneBookCategories parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetch Telephone Categories. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/telephoneBookCategoriesDetails' '204': description: TelephoneBookCategories not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Telephone Book Category description: Use this API to create Telephone Book Category.

OperationId:postTelephoneBookCategories

operationId: postTelephoneBookCategories parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/telephoneBookCategoriesCriteria' description: Request object for Telephone Book Category. required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/telephoneBookCategories/{categoryCode}: put: summary: Change Telephone Book Category description: Use this API to update Telephone Book Category.

OperationId:changeTelephoneBookCategories

operationId: changeTelephoneBookCategories parameters: - name: categoryCode in: path required: true description: Unique Code of category. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/telephoneBookCategoriesToBeChanged' description: Request object for Telephone Book Category. required: true delete: summary: Delete Telephone Book Category description: Use this API to delete Telephone Book Category.

OperationId:removeTelephoneBookCategories

operationId: removeTelephoneBookCategories parameters: - name: categoryCode in: path required: true description: Unique Code of category. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: description in: query required: false style: form explode: true schema: type: array items: type: string - name: orderBy in: query required: false style: form explode: true schema: type: array items: type: integer - name: generic in: query required: false style: form explode: true schema: type: array items: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/telephoneBookEntries: get: summary: Get Telephone Book Entries description: Use this API to get Telephone Book Entries.

OperationId:getTelephoneBookEntries

operationId: getTelephoneBookEntries deprecated: true parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: category in: query required: false description: Category code that the telephone book entry belongs to. schema: type: string - name: name in: query required: false description: Wildcard search on the name of telephone book entry. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetch Telephone Book Entries. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/telephoneBookEntriesDetails' '204': description: TelephoneBookEntries not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Telephone Book Entries description: Use this API to create Telephone Book Entries.

OperationId:postTelephoneBookEntries

operationId: postTelephoneBookEntries parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/telephoneBookEntriesCriteria' description: Request object for Telephone Book Entries. required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/telephoneBookEntries/searches: post: summary: Get Telephone Book Entries description: Use this API to get Telephone Book Entries.

OperationId:searchTelephoneBookEntries

operationId: searchTelephoneBookEntries parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetch Telephone Book Entries. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/telephoneBookEntriesDetails' '204': description: TelephoneBookEntries not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/searchTelephoneBookEntriesRequest' servers: - url: /ent/config/v1 /hotels/{hotelId}/telephoneBookEntries/{entryId}: put: summary: Create Telephone Book Entries description: Use this API to create Telephone Book Entries.

OperationId:changeTelephoneBookEntries

operationId: changeTelephoneBookEntries parameters: - name: entryId in: path required: true description: Unique ID of entry. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/telephoneBookEntriesToBeChanged' description: Request object for Telephone Book Entries. required: true delete: summary: Delete Telephone Book Entries description: Use this API to delete Telephone Book Entries.

OperationId:removeTelephoneBookEntries

operationId: removeTelephoneBookEntries parameters: - name: entryId in: path required: true description: Unique ID of entry. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: idContext in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/transportations: get: summary: Get transportation description: Use this API to get transportation.

OperationId:getTransportation

operationId: getTransportation parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: transportationCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for information regarding transportation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/transportationDetails' '204': description: Transportation not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create transportation description: Use this API to create transportation.

OperationId:postTransportation

operationId: postTransportation parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transportationCriteria' description: Request object for creating transportation. required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/transportations/{transportationCode}: put: summary: ' modify transportation' description: You can use this API to modify Transportation for a property.

OperationId:changeTransportation

operationId: changeTransportation parameters: - name: transportationCode in: path required: true description: Unique Code of transportation. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transportationToBeChanged' description: Request object for modifying transportation. required: true delete: summary: Delete transportation description: Use this API to delete transportation.

OperationId:removeTransportation

operationId: removeTransportation deprecated: true parameters: - name: transportationCode in: path required: true description: Unique Code of transportation. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: label in: query required: false style: form explode: true schema: type: array items: type: string - name: orderBy in: query required: false style: form explode: true schema: type: array items: type: integer - name: createDateTime in: query required: false description: Time stamp of the creation. schema: type: string format: date-time - name: creatorId in: query required: false description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. schema: type: string - name: extension in: query required: false description: Extension to reach a specific party at the phone number. schema: type: string - name: lastModifierId in: query required: false description: Identifies the last software system or person to modify a record. schema: type: string - name: lastModifyDateTime in: query required: false description: Time stamp of last modification. schema: type: string format: date-time - name: phoneNumberOrderSequence in: query required: false description: Display Order sequence. schema: type: number - name: phoneNumber in: query required: false description: Telephone number assigned to a single location. schema: type: string - name: phoneTechType in: query required: false description: Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. schema: type: string - name: phoneUseType in: query required: false description: Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening). schema: type: string - name: phoneUseTypeDescription in: query required: false description: Description of the PhoneUseType code schema: type: string - name: phoneNumberPrimaryInd in: query required: false description: When true, indicates a primary information. schema: type: boolean - name: purgeDate in: query required: false description: Date an item will be purged from a database (e.g., from a live database to an archive). schema: type: string format: date - name: distance in: query required: false description: Defines the distance between two points. schema: type: number - name: distanceType in: query required: false description: The unit of measure in a code format. schema: type: string - name: drivingTime in: query required: false description: The driving time in a free text format. schema: type: string - name: description in: query description: The description of the transportation. required: false style: form explode: true schema: type: array items: type: string - name: comments in: query description: Comments about the transportation. required: false style: form explode: true schema: type: array items: type: string - name: priceRange in: query description: The price range of the transportation. required: false style: form explode: true schema: type: array items: type: string - name: websiteOrderSequence in: query required: false description: Display Order sequence. schema: type: number - name: websitePrimaryInd in: query required: false description: When true, indicates a primary information. schema: type: boolean - name: type in: query required: false description: Defines the purpose of the URL address, such as personal, business, public, etc. schema: type: string - name: typeDescription in: query required: false description: Describes the Type code schema: type: string - name: keyOptionsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/transportations/{transportationCode}/deletions: post: summary: Delete transportation description: Use this API to delete transportation.

OperationId:postDeleteTransportation

operationId: postDeleteTransportation parameters: - name: transportationCode in: path required: true description: Unique Code of transportation. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetch transportation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/transportationDetails' '204': description: Transportation not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/deleteTransportationRequest' servers: - url: /ent/config/v1 /hotels/{hotelId}/yieldAdjustmentCodes: get: summary: Get Yield Adjustment Codes description: Use this API to get Yield Adjustment Codes.

OperationId:getYieldAdjustmentCodes

operationId: getYieldAdjustmentCodes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: yieldAdjustmentCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: type in: query required: false description: Defines values for Yield Adjustment Types. schema: type: string enum: - PerStay - PerNight - PerPersonPerNight - PerPersonPerStay uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Yield AdjustmentCodes configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/yieldAdjustmentCodesDetails' '204': description: YieldAdjustmentCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Yield Adjustment Codes description: Use this API to create Yield Adjustment Codes.

OperationId:postYieldAdjustmentCodes

operationId: postYieldAdjustmentCodes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/yieldAdjustmentCodesCriteria' description: Request object for creating new Yield AdjustmentCodes Configurations. required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/yieldAdjustmentCodes/{yieldAdjustmentCode}: put: summary: Change Yield Adjustment Codes description: Use this API to update Yield Adjustment Codes.

OperationId:changeYieldAdjustmentCodes

operationId: changeYieldAdjustmentCodes parameters: - name: yieldAdjustmentCode in: path required: true description: Unique Code of yield adjustment. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/yieldAdjustmentCodesToBeChanged' description: Request object for changing existing Yield AdjustmentCodes Configurations. required: true delete: summary: Delete Yield Adjustment Codes description: Use this API to delete Yield Adjustment Codes.

OperationId:removeYieldAdjustmentCodes

operationId: removeYieldAdjustmentCodes parameters: - name: yieldAdjustmentCode in: path required: true description: Unique Code of yield adjustment. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/yieldCategories: get: summary: Get Yield Category description: Use this API to get Yield Category.

OperationId:getYieldCategories

operationId: getYieldCategories parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: yieldCategoriesCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Yield Category configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/yieldCategoriesDetails' '204': description: YieldCategories not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Yield Category description: Use this API to create Yield Category.

OperationId:postYieldCategories

operationId: postYieldCategories parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/yieldCategoriesCriteria' description: Request object for creating new Yield Category Configurations. required: true servers: - url: /ent/config/v1 /hotels/{hotelId}/yieldCategories/{code}: put: summary: Change Yield Category description: Use this API to update Yield Category.

OperationId:changeYieldCategories

operationId: changeYieldCategories parameters: - name: code in: path required: true description: Unique Code of yield category. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/yieldCategoriesToBeChanged' description: Request object for changing existing Yield Category Configurations. required: true delete: summary: Delete Yield Category description: Use this API to delete Yield Category.

OperationId:removeYieldCategories

operationId: removeYieldCategories parameters: - name: code in: path required: true description: Unique Code of yield category. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{hotelId}/yieldMarketTypes/{code}: delete: summary: Delete Yield Market Types description: Use this API to delete Yield Market Types.

OperationId:removeYieldMarketTypes

operationId: removeYieldMarketTypes parameters: - name: code in: path required: true description: Code of the YieldMarketType. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /hotels/{sourceHotelId}/departments/copy: put: summary: ' copy Departments' description: Copy Departments.

OperationId:copyDepartments

operationId: copyDepartments parameters: - name: sourceHotelId in: path required: true description: Unique ID of source hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyDepartments' description: List of the departments to be copied. required: true servers: - url: /ent/config/v1 /hotels/{sourceHotelId}/yieldAdjustmentCodes/copy: put: summary: ' copy Yield Adjustment Codes' description: Copy Yield Adjustment Codes.

OperationId:copyYieldAdjustmentCodes

operationId: copyYieldAdjustmentCodes parameters: - name: sourceHotelId in: path required: true description: Unique ID of source hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyYieldAdjustmentCodes' description: List of the Yield AdjustmentCodes to be copied. required: true servers: - url: /ent/config/v1 /hotels/{sourceHotelId}/yieldCategories/copy: put: summary: ' copy Yield Category' description: Copy Yield Category.

OperationId:copyYieldCategories

operationId: copyYieldCategories parameters: - name: sourceHotelId in: path required: true description: Unique ID of source hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyYieldCategories' description: List of the Yield Category to be copied. required: true servers: - url: /ent/config/v1 /jobTitles: get: summary: Get template job titles description: Use this API to get template job titles.

OperationId:getTemplateJobTitles

operationId: getTemplateJobTitles parameters: - name: jobTitleCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching template job titles. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateJobTitlesDetails' '204': description: TemplateJobTitles not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create new template job titles description: Use this API to create new template job titles.

OperationId:postTemplateJobTitles

operationId: postTemplateJobTitles parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateJobTitlesCriteria' description: Request object for creating new template job titles. required: true servers: - url: /ent/config/v1 /jobTitles/{jobTitleCode}: put: summary: Change template job titles description: Use this API to update template job titles.

OperationId:changeTemplateJobTitles

operationId: changeTemplateJobTitles parameters: - name: jobTitleCode in: path required: true description: Code for Job Title template. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateJobTitlesToBeChanged' description: Request object for modifying template job titles. required: true delete: summary: Delete template job titles description: Use this API to delete template job titles.

OperationId:removeTemplateJobTitles

operationId: removeTemplateJobTitles parameters: - name: jobTitleCode in: path required: true description: Code for Job Title template. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /languages: get: summary: Get Languages description: Use this API to get Languages.

OperationId:getLanguages

operationId: getLanguages parameters: - name: languageCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: description in: query required: false description: Language description to be searched. schema: type: string - name: useAsAlternateLanguage in: query required: false description: This is a placeholder element for future use. Functionality may not be available for the current implementation. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching languages. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/languagesDetails' '204': description: Languages not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Languages description: Use this API to create Languages.

OperationId:postLanguages

operationId: postLanguages parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/languagesCriteria' description: Request object for creating new language records. required: true servers: - url: /ent/config/v1 /languages/{languageCode}: put: summary: Update a Language description: Update a Language.

OperationId:changeLanguages

operationId: changeLanguages parameters: - name: languageCode in: path required: true description: Unique Code of language. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/languagesToBeChanged' description: Request object for changing details of existing language records. required: true delete: summary: Delete a Language description: Use this API to delete a Language.

OperationId:removeLanguages

operationId: removeLanguages parameters: - name: languageCode in: path required: true description: Unique Code of language. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /marketingCities: get: summary: Get template marketing cities description: Use this API to get template marketing cities.

OperationId:getTemplateMarketingCities

operationId: getTemplateMarketingCities parameters: - name: includeInactive in: query required: false description: Flag to indicate whether to include inactive marketing cities in the results or not. schema: type: boolean - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: marketingCitys in: query description: List of Marketing Cities. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: regionCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: description in: query required: false description: Marketing city description to search for. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching template marketing cities. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateMarketingCitiesDetails' '204': description: TemplateMarketingCities not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create new template marketing cities description: Use this API to create new template marketing cities.

OperationId:postTemplateMarketingCities

operationId: postTemplateMarketingCities parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateMarketingCitiesCriteria' description: Request object for creating new template marketing cities. required: true servers: - url: /ent/config/v1 /marketingCities/copy: put: summary: Copy marketing cities to resorts description: Copy marketing cities to resorts.

OperationId:copyMarketingCities

operationId: copyMarketingCities parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyMarketingCities' description: Request object for copying template marketing cities to hotel(s). required: true servers: - url: /ent/config/v1 /marketingCities/{cityCode}: put: summary: Change template marketing cities description: Use this API to update template marketing cities.

OperationId:changeTemplateMarketingCities

operationId: changeTemplateMarketingCities parameters: - name: cityCode in: path required: true description: Unique Code of city. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateMarketingCitiesToBeChanged' description: Request object for modifying template marketing cities. required: true delete: summary: Delete template marketing cities description: Use this API to delete template marketing cities.

OperationId:removeTemplateMarketingCities

operationId: removeTemplateMarketingCities parameters: - name: cityCode in: path required: true description: Unique Code of city. schema: type: string maxLength: 2000 minLength: 1 - name: regionCode in: query required: false description: Region code the marketing city belongs to. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /notes/{noteCode}: delete: summary: Delete Note information description: Use this API to delete Note information.

OperationId:removeHotelNotes

operationId: removeHotelNotes parameters: - name: noteCode in: path required: true description: Unique Code of note. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /operaAppUrl: get: summary: Fetch all OPERA applications url description: This API will fetch all the OPERA application url

OperationId:getOperaAppUrl

operationId: getOperaAppUrl responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: List of url for all the modules of OPERA application content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/operaAppUrlResponse' '204': description: OPERA url not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /operation: get: summary: Fetch all operations description: This API will fetch all the operations wrt a code.

OperationId:getOperation

operationId: getOperation parameters: - name: code in: query required: false description: Unique code for a configuration. schema: type: string maxLength: 2000 minLength: 1 - name: operation in: query required: false description: Describing the type of operation a particular configuration supports schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: List of configurations added from central. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/operationResponse' '204': description: Central Configs not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /parameters: get: summary: Get OPERA Parameters description: Use this API to get OPERA Parameters.

OperationId:getOperaParameters

operationId: getOperaParameters parameters: - name: parameterName in: query description: Used for Character Strings, length 0 to 80. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: The result element containing a collection of the requested application parameters. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/operaParametersDetails' '204': description: OperaParameters not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /settings: get: summary: Get OPERA Settings description: Use this API to return OPERA controls based on search criteria such as hotelId, cROCode, parameterNameWildCard. OPERA Controls determine the functionality, behavior and defaults for OPERA Cloud. The functions, parameters and settings available are determined by the Cloud Service subscriptions.

operationId: getOperaSettings parameters: - name: hotelId in: query required: false description: Unique ID of hotel. schema: type: string maxLength: 2000 - name: cROCode in: query required: false description: This is the Central Reservation office code. schema: type: string maxLength: 200 - name: parameterNameWildCard in: query required: false description: Wildcard search parameter. schema: type: string maxLength: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: The result element containing the requested application settings. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/operaSettingsDetails' '204': description: OperaSettings not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /telephoneBookEntries/{entryId}: delete: summary: Delete Telephone Book Entries description: Use this API to delete Telephone Book Entries.

OperationId:removeTelephoneBookEntriesWithoutHotelId

operationId: removeTelephoneBookEntriesWithoutHotelId parameters: - name: entryId in: path required: true description: Unique ID of entry. schema: type: string maxLength: 2000 minLength: 1 - name: idContext in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /templateCodes/copy: put: summary: Copy Template Codes description: This API is used to Copy a Template Rate Category in order to create a new Template Rate Category.

OperationId:copyTemplateCodes

operationId: copyTemplateCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyTemplateCodes' required: true servers: - url: /ent/config/v1 /transportations: get: summary: Get transportation templates description: Use this API to get transportation templates.

OperationId:getTransportationTemplates

operationId: getTransportationTemplates parameters: - name: transportationCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching transportation templates. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/transportationTemplatesDetails' '204': description: TransportationTemplates not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create transportation templates description: Use this API to create transportation templates.

OperationId:postTransportationTemplates

operationId: postTransportationTemplates parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transportationTemplatesCriteria' description: Request object for creating transportation templates. required: true servers: - url: /ent/config/v1 /transportations/{transportationCode}: put: summary: Change transportation templates description: Use this API to update transportation templates.

OperationId:changeTransportationTemplates

operationId: changeTransportationTemplates parameters: - name: transportationCode in: path required: true description: Unique Code of transportation. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transportationTemplatesToBeChanged' description: Request object for modifying transportation templates. required: true delete: summary: Delete transportation templates description: Use this API to delete transportation templates.

OperationId:removeTransportationTemplates

operationId: removeTransportationTemplates parameters: - name: transportationCode in: path required: true description: Unique Code of transportation. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /ent/config/v1 /upsert/hotels/{hotelId}/telephoneBookCategories/{categoryCode}: put: summary: Create/Change Telephone Book Category description: Use this API to Create/update Telephone Book Category.

OperationId:changeUpsertTelephoneBookCategories

operationId: changeUpsertTelephoneBookCategories parameters: - name: categoryCode in: path required: true description: Unique Code of category. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/telephoneBookCategoriesToBeChanged' description: Request object for Telephone Book Category. required: true servers: - url: /ent/config/v1 /upsert/hotels/{hotelId}/telephoneBookEntries: put: summary: Create/Change Telephone Book Entries description: Use this API to create/change Telephone Book Entries.

OperationId:changeUpsertTelephoneBookEntries

operationId: changeUpsertTelephoneBookEntries parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/telephoneBookEntriesToBeChanged' description: Request object for Telephone Book Entries. required: true servers: - url: /ent/config/v1 /upsert/hotels/{hotelId}/yieldAdjustmentCodes/{yieldAdjustmentCode}: put: summary: Create/Change Yield Adjustment Codes description: Use this API to Create/update Yield Adjustment Codes.

OperationId:changeUpsertYieldAdjustmentCodes

operationId: changeUpsertYieldAdjustmentCodes parameters: - name: yieldAdjustmentCode in: path required: true description: Unique Code of yield adjustment. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/yieldAdjustmentCodesToBeChanged' description: Request object for changing existing Yield AdjustmentCodes Configurations. required: true servers: - url: /ent/config/v1 /upsert/hotels/{hotelId}/yieldCategories/{code}: put: summary: Create/Change Yield Category description: Use this API to update Yield Category.

OperationId:changeUpsertYieldCategories

operationId: changeUpsertYieldCategories parameters: - name: code in: path required: true description: Unique Code of yield category. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/yieldCategoriesToBeChanged' description: Request object for changing existing Yield Category Configurations. required: true servers: - url: /ent/config/v1 /upsert/yieldMarketTypes: put: summary: Create/Change Yield Market Types description: Use this API to update Yield Market Types.

OperationId:changeUpsertYieldMarketTypes

operationId: changeUpsertYieldMarketTypes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/yieldMarketTypesToBeChanged' description: Request object for changing existing Yield Market Types. required: true servers: - url: /ent/config/v1 /yieldMarketTypes: get: summary: Get Yield Market Types description: Use this API to get Yield Market Types.

OperationId:getYieldMarketTypes

operationId: getYieldMarketTypes parameters: - name: yieldMarketTypesCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: hotelId in: query required: false description: Hotel Codes criteria for which the yield market type belong to. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Yield Market Types. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/yieldMarketTypesDetails' '204': description: YieldMarketTypes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Yield Market Types description: Use this API to create Yield Market Types.

OperationId:postYieldMarketTypes

operationId: postYieldMarketTypes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/yieldMarketTypesCriteria' description: Request object for creating new Yield Market Types. required: true put: summary: Change Yield Market Types description: Use this API to update Yield Market Types.

OperationId:changeYieldMarketTypes

operationId: changeYieldMarketTypes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/yieldMarketTypesToBeChanged' description: Request object for changing existing Yield Market Types. required: true servers: - url: /ent/config/v1 /eventCodes: get: summary: Get Template Event Codes description: Use this API to get Template Event Codes.

OperationId:getTemplateEventCodes

operationId: getTemplateEventCodes parameters: - name: eventsCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: includeInactive in: query required: false description: If true, this flag will set the criteria to return only Inactive records. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching template Event Codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateEventCodesDetails' '204': description: TemplateEventCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Template Event Codes description: Use this API to update Template Event Codes.

OperationId:changeTemplateEventCodes

operationId: changeTemplateEventCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateEventCodesToBeChanged' description: Request object for modifying template Event Codes. required: true post: summary: Create Template Event Codes description: Use this API to create Template Event Codes.

OperationId:postTemplateEventCodes

operationId: postTemplateEventCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateEventCodesCriteria' description: Request object for creating new template Event Codes. required: true delete: summary: Delete Template Event Codes description: Use this API to delete Template Event Codes.

OperationId:removeTemplateEventCodes

operationId: removeTemplateEventCodes parameters: - name: templateEventCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /evm/config/v1 /functionSpaceRentalCodes: get: summary: Get Catering s Rental Codes description: Use this API to get Catering s Rental Codes.

OperationId:getCateringRentalCodes

operationId: getCateringRentalCodes parameters: - name: fetchInactive in: query required: false description: Determines wether to fetch inactive records or not. schema: type: boolean - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Catering Rental Code details. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cateringRentalCodesDetails' '204': description: CateringRentalCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Catering s Rental Codes description: Use this API to create Catering s Rental Codes.

OperationId:postCateringRentalCodes

operationId: postCateringRentalCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringRentalCodesCriteria' description: Request object which holds new Catering Rental Code Details. required: true servers: - url: /evm/config/v1 /functionSpaceRentalCodes/{cateringRentalId}: put: summary: Change Catering s Rental Codes description: Use this API to update Catering s Rental Codes.

OperationId:changeCateringRentalCodes

operationId: changeCateringRentalCodes parameters: - name: cateringRentalId in: path required: true description: Unique CateringRentalCode for functionSpace. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringRentalCodesToBeChanged' description: Request object which holds modified Catering Rental Codes. required: true delete: summary: Delete Catering s Rental Codes description: Use this API to delete Catering s Rental Codes.

OperationId:removeCateringRentalCodes

operationId: removeCateringRentalCodes parameters: - name: cateringRentalId in: path required: true description: Unique CateringRentalCode for functionSpace. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /evm/config/v1 /upsert/functionSpaceRentalCodes: put: summary: Create/Change Catering s Rental Codes description: Use this API to create/update Catering s Rental Codes.

OperationId:changeUpsertCateringRentalCodes

operationId: changeUpsertCateringRentalCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringRentalCodesToBeChanged' description: Request object which holds modified Catering Rental Codes. required: true servers: - url: /evm/config/v1 /functionspaceLocations: get: summary: Get Function space locations description: Use this API to get detail information of function space locations.

OperationId:getFunctionSpaceLocations

operationId: getFunctionSpaceLocations parameters: - name: hotelIds in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching function space locations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/functionSpaceLocationsDetails' '204': description: FunctionSpaceLocations not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /evm/config/v1 /functionspaceLocations/{functionspaceLocationCode}: post: summary: Create function space locations description: Use this API to create function space locations.

OperationId:postFunctionSpaceLocations

operationId: postFunctionSpaceLocations parameters: - name: functionspaceLocationCode in: path required: true description: Unique Code of function space locations. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/functionSpaceLocationsCriteria' description: Request object for adding function space location configurations to resort. required: true delete: summary: Delete function space locations description: Use this API to delete function space locations.

OperationId:removeFunctionSpaceLocations

operationId: removeFunctionSpaceLocations parameters: - name: functionspaceLocationCode in: path required: true description: Unique Code of function space locations. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: query description: Hotel where the code is configured. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change function space locations description: Use this API to update function space locations.

OperationId:changeFunctionSpaceLocations

operationId: changeFunctionSpaceLocations parameters: - name: functionspaceLocationCode in: path required: true description: Unique Code of function space locations. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/functionSpaceLocationsToBeChanged' description: Request object for modifying function space location(s) for resort. required: true servers: - url: /evm/config/v1 /functionspaceSetupStyles: get: summary: Get Function space setup styles description: Use this API to get Function space setup styles.

OperationId:getFunctionSpaceSetupStyles

operationId: getFunctionSpaceSetupStyles parameters: - name: fetchInactive in: query required: false description: Determines wether to fetch inactive records or not. schema: type: boolean - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching function space setup styles. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/functionSpaceSetupStylesDetails' '204': description: FunctionSpaceSetupStyles not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create function space setup styles description: Use this API to create function space setup styles.

OperationId:postFunctionSpaceSetupStyles

operationId: postFunctionSpaceSetupStyles parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/functionSpaceSetupStylesCriteria' description: Request object for adding function space setup styles. required: true servers: - url: /evm/config/v1 /functionspaceSetupStyles/{functionSpaceSetupStyleId}: delete: summary: Delete function space setup styles description: Use this API to delete function space setup styles.

OperationId:removeFunctionSpaceSetupStyles

operationId: removeFunctionSpaceSetupStyles parameters: - name: functionSpaceSetupStyleId in: path required: true description: Unique ID of function space setup styles. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change function space setup styles description: Use this API to update function space setup styles.

OperationId:changeFunctionSpaceSetupStyles

operationId: changeFunctionSpaceSetupStyles parameters: - name: functionSpaceSetupStyleId in: path required: true description: Unique ID of function space setup styles. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/functionSpaceSetupStylesToBeChanged' description: Request object for modifying function space setup style(s) required: true servers: - url: /evm/config/v1 /upsert/functionspaceSetupStyles: put: summary: Create/Change function space setup styles description: Use this API to create/update function space setup styles.

OperationId:changeUpsertFunctionSpaceSetupStyles

operationId: changeUpsertFunctionSpaceSetupStyles parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/functionSpaceSetupStylesToBeChanged' description: Request object for modifying function space setup style(s) required: true servers: - url: /evm/config/v1 /functionspaces/{functionSpaceCode}: get: summary: 'Get Function space ' description: Retrieve detailed information on function spaces, for example Meeting Room.

OperationId:getFunctionSpace

The maximum allowable limit for this API is 25.

operationId: getFunctionSpace parameters: - name: functionSpaceCode in: path required: true description: Unique code of function Space . schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: physical in: query required: false description: Is it a physical room type. schema: type: boolean - name: pseudo in: query required: false description: Is it a pseudo room type. schema: type: boolean - name: hotelId in: query required: false description: Hotel code of room to be searched. schema: type: string - name: roomClassCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: roomTypeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching complete information of existing function space room. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/functionSpaceDetails' '204': description: FunctionSpace not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /evm/config/v1 /upsert/hotels/{hotelId}/eventCodes: put: summary: Create/Change Hotel Event Codes description: Use this API to create/update Hotel Event Codes.

OperationId:changeUpsertEventCodes

operationId: changeUpsertEventCodes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/eventCodesToBeChanged' description: Request object for modifying Event Codes for a hotel. required: true servers: - url: /evm/config/v1 /upsert/functionspaceLocations/{functionspaceLocationCode}: put: summary: Create/Change function space locations description: Use this API to create/update function space locations.

OperationId:changeUpsertFunctionSpaceLocations

operationId: changeUpsertFunctionSpaceLocations parameters: - name: functionspaceLocationCode in: path required: true description: Unique Code of function space locations. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/functionSpaceLocationsToBeChanged' description: Request object for modifying function space location(s) for resort. required: true servers: - url: /evm/config/v1 /hotels/{hotelId}/eventCodes: get: summary: Get Hotel Event Codes description: Use this API to get Hotel Event Codes.

OperationId:getEventCodes

operationId: getEventCodes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: eventsCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: includeInactive in: query required: false description: If true, this flag will set the criteria to return only Inactive records. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Event Codes for a hotel. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/eventCodesDetails' '204': description: EventCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Hotel Event Codes description: Use this API to create Hotel Event Codes.

OperationId:postEventCodes

operationId: postEventCodes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/eventCodesCriteria' description: Request object for creating new Event Codes for a hotel. required: true delete: summary: Delete Hotel Event Codes description: Use this API to delete Hotel Event Codes.

OperationId:removeEventCodes

operationId: removeEventCodes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: eventCode in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Hotel Event Codes description: Use this API to update Hotel Event Codes.

OperationId:changeEventCodes

operationId: changeEventCodes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/eventCodesToBeChanged' description: Request object for modifying Event Codes for a hotel. required: true servers: - url: /evm/config/v1 /hotels/{hotelId}/functionSpaces: get: summary: Get Function Spaces description: This API fetches the configured function spaces of a specific property with possible search criteria of function space code, and space type. The result returns the function spaces that fit the search criteria with details about space name, short name, attributes such as shareable, combo, web bookable, and more.

OperationId:getFunctionSpaces

operationId: getFunctionSpaces parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: sortingBy in: query required: false description: A collection of supported sorting for Event Calendar Function Space. schema: type: string enum: - Name - AttendeeCapacity - AreaSize - CustomOrder1 - CustomOrder2 - CustomOrder3 uniqueItems: true - name: roomCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: roomType in: query required: false description: Room Type where function space belongs to schema: type: string - name: spaceType in: query required: false description: Space Type where function space belongs to schema: type: string - name: functionSpaceWildcard in: query required: false description: Wild search on Room Code and Function Name. schema: type: string - name: webBookable in: query required: false description: If true, will set the criteria to return Function Spaces configured as web bookable only. schema: type: boolean - name: floorCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: locationCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: If true this boolean will set the criteria to return Inactive records along with active records. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching function spaces summary info at the property level. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/functionSpacesDetails' '204': description: FunctionSpaces not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Function Spaces description: This API allows the creation of function spaces. Criteria that need to be supplied in the request body include function space code, description, space type, and min / max attendees. Optional details such as short name, shareable, combo, web bookable, and dimensions can also be included.

OperationId:postFunctionSpaces

operationId: postFunctionSpaces parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/functionSpacesCriteria' description: Request object for creating function spaces. required: true servers: - url: /evm/config/v1 /hotels/{hotelId}/functionSpaces/{functionSpaceCode}: put: summary: Change Function Spaces description: Use this API to update Function Spaces.

OperationId:changeFunctionSpaces

operationId: changeFunctionSpaces parameters: - name: functionSpaceCode in: path required: true description: Unique Code of functionSpace. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/functionSpacesToBeChanged' description: Request object for changing function spaces. required: true delete: summary: Delete Function Spaces description: Use this API to delete Function Spaces.

OperationId:removeFunctionSpaces

operationId: removeFunctionSpaces parameters: - name: functionSpaceCode in: path required: true description: Unique Code of functionSpace. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /evm/config/v1 /hotels/{hotelId}/functionSpaces/{functionSpaceCode}/configurations: get: summary: Get Function Space Configuration description: ' Use this get Function Space detailed information.

OperationId:getFunctionSpaceConfig

' operationId: getFunctionSpaceConfig parameters: - name: functionSpaceCode in: path required: true description: Unique Code of function space. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching function space config info. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/functionSpaceConfigDetails' '204': description: FunctionSpaceConfig not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /evm/config/v1 /hotels/{hotelId}/roomPools: get: summary: Fetch Room Type Pool description: This API allows you to Use this API to get Room Type Pool and the associated Room Types.

OperationId:getRoomTypePool

The maximum allowable limit for this API is 25.

operationId: getRoomTypePool parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: includeInactive in: query required: false description: Flag to indicate if inactive room types should be included. schema: type: boolean - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: physical in: query required: false description: Is it a physical sleep room type. schema: type: boolean - name: pseudo in: query required: false description: Is it a pseudo room type. schema: type: boolean - name: summaryInfo in: query required: false description: Flag to indicate if summary or detailed information should be fetched. schema: type: boolean - name: roomTypeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: roomClassCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: roomTypePoolCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetch room pool information. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomTypePoolDetails' '204': description: RoomTypePool not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Room Type Pools description: This API allows you to Use this API to create Room Type Pools.

OperationId:postRoomTypePool

operationId: postRoomTypePool parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomTypePoolCriteria' description: Request object for creating new room pool. required: true servers: - url: /evm/config/v1 /hotels/{hotelId}/roomPools/{roomPoolCode}: delete: summary: Delete Room Type Pool and Mappings description: Use this API to delete Room Type Pool and Mappings.

OperationId:removeRoomTypePool

operationId: removeRoomTypePool parameters: - name: roomPoolCode in: path required: true description: Unique Code of room type pool. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: description in: query description: The description of room pool type. required: false style: form explode: true schema: type: array items: type: string - name: defaultText in: query required: false description: Default text with Character length from 0 to 1000. schema: type: string - name: lang in: query description: Language code for the translation. required: false style: form explode: true schema: type: array items: type: string - name: sequence in: query description: Sequence for representing room type pool record. required: false style: form explode: true schema: type: array items: type: integer - name: inactive in: query description: Indicates the room type is inactive or not. required: false style: form explode: true schema: type: array items: type: boolean - name: numberOfRooms in: query description: Number of rooms for this room type. required: false style: form explode: true schema: type: array items: type: integer - name: roomType in: query required: false style: form explode: true schema: type: array items: type: string - name: roomClass in: query description: Room class for the room type code. required: false style: form explode: true schema: type: array items: type: string - name: shortDescription in: query description: Short Description of room type. required: false style: form explode: true schema: type: array items: type: string - name: activeDate in: query description: Active date of the room type. required: false style: form explode: true schema: type: array items: type: string format: date - name: pseudo in: query description: Indicates if room type is pseudo. required: false style: form explode: true schema: type: array items: type: boolean - name: accessible in: query description: Indicates if room type is accessible. required: false style: form explode: true schema: type: array items: type: boolean - name: sendToInterface in: query description: Indicates if room type is sent to interface. required: false style: form explode: true schema: type: array items: type: boolean - name: sellSequence in: query description: Indicates room types sell sequence. required: false style: form explode: true schema: type: array items: type: number - name: suite in: query description: Indicates room type is a suite. required: false style: form explode: true schema: type: array items: type: boolean - name: meetingRoom in: query description: Indicates room type is meeting room. This Can be Meeting room flag cannot be unmarked at the property level. Can only be marked for non pseudo room types. required: false style: form explode: true schema: type: array items: type: boolean - name: restricted in: query description: Indicates that the room pool cannot be used to allocate inventory to this room type. Inventory must be allocated directly to the room type itself. required: false style: form explode: true schema: type: array items: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: 'Change Room Type Pool ' description: Use this API to update Room Type Pool and Associated Room Types.

OperationId:changeRoomTypePool

operationId: changeRoomTypePool parameters: - name: roomPoolCode in: path required: true description: Unique Code of room type pool. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomTypePoolToBeChanged' description: Request object for changing existing room pool. required: true servers: - url: /evm/config/v1 /hotels/{sourceHotelId}/functionSpaces/copy: put: summary: Copy Function Spaces description: ' Use this API to copy Function Space.

OperationId:copyFunctionSpaces

' operationId: copyFunctionSpaces parameters: - name: sourceHotelId in: path required: true description: Unique ID of source hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyFunctionSpaces' description: Request object for creating multiple function spaces based on an existing function space. New function space may have different name, display name on function dairy, order of display and combo elements. The rest of the details will be copied from the source function space. required: true servers: - url: /evm/config/v1 /hotels/{sourceHotelId}/functionspaceLocations/copy: put: summary: Copy function space locations description: Use this API to copy function space locations.

OperationId:copyFunctionSpaceLocations

operationId: copyFunctionSpaceLocations parameters: - name: sourceHotelId in: path required: true description: Unique ID of source hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyFunctionSpaceLocations' description: List of function space location(s) to be copied. required: true servers: - url: /evm/config/v1 /hotels/{hotelId}/trackItActions: get: summary: Get Track it Actions description: Use this API to get Track it Actions.

OperationId:getTrackItActions

operationId: getTrackItActions parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: showInactive in: query required: false description: If true this boolean will set the criteria to only return Inactive records. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Track it Actions. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/trackItActionsDetails' '204': description: TrackItActions not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Track it Actions description: Use this API to create Track it Actions.

OperationId:postTrackItActions

operationId: postTrackItActions parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/trackItActionsCriteria' description: Request object for creating new Track it Actions. required: true servers: - url: /fof/config/v1 /hotels/{hotelId}/trackItActions/{actionCode}: put: summary: Change Track it Actions description: Use this API to update Track it Actions.

OperationId:changeTrackItActions

operationId: changeTrackItActions parameters: - name: actionCode in: path required: true description: Unique Code of action. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/trackItActionsToBeChanged' description: Request object for changing existing Track it Actions. required: true delete: summary: Delete Track it Actions description: Use this API to delete Track it Actions.

OperationId:removeTrackItActions

operationId: removeTrackItActions parameters: - name: actionCode in: path required: true description: Unique Code of action. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /fof/config/v1 /hotels/{hotelId}/trackItLocations: get: summary: Get Track it Locations description: Use this API to get Track it Locations.

OperationId:getTrackItLocations

operationId: getTrackItLocations parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: showInactive in: query required: false description: If true this boolean will set the criteria to only return Inactive records. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Track it Locations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/trackItLocationsDetails' '204': description: TrackItLocations not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Track it Locations description: Use this API to create Track it Locations.

OperationId:postTrackItLocations

operationId: postTrackItLocations parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/trackItLocationsCriteria' description: Request object for creating new Track it Locations. required: true servers: - url: /fof/config/v1 /hotels/{hotelId}/trackItLocations/{locationCode}: put: summary: Change Track it Locations description: Use this API to update Track it Locations.

OperationId:changeTrackItLocations

operationId: changeTrackItLocations parameters: - name: locationCode in: path required: true description: Unique Code of location. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/trackItLocationsToBeChanged' description: Request object for changing existing Track it Locations. required: true delete: summary: Delete Track it Locations description: Use this API to delete Track it Locations.

OperationId:removeTrackItLocations

operationId: removeTrackItLocations parameters: - name: locationCode in: path required: true description: Unique Code of location. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /fof/config/v1 /hotels/{hotelId}/trackItTypes: get: summary: Get Track it Types description: Use this API to get Track it Types.

OperationId:getTrackItTypes

operationId: getTrackItTypes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: showInactive in: query required: false description: If true this boolean will set the criteria to only return Inactive records. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Track it Types. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/trackItTypesDetails' '204': description: TrackItTypes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Track it Types description: Use this API to create Track it Types.

OperationId:postTrackItTypes

operationId: postTrackItTypes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/trackItTypesCriteria' description: Request object for creating new Track it Types. required: true servers: - url: /fof/config/v1 /hotels/{hotelId}/trackItTypes/{typeCode}: put: summary: Change Track it Types description: Use this API to update Track it Types.

OperationId:changeTrackItTypes

operationId: changeTrackItTypes parameters: - name: typeCode in: path required: true description: Unique Code of track it type. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/trackItTypesToBeChanged' description: Request object for changing existing Track it Types. required: true delete: summary: Delete Track it Types description: Use this API to delete Track it Types.

OperationId:removeTrackItTypes

operationId: removeTrackItTypes parameters: - name: typeCode in: path required: true description: Unique Code of track it type. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /fof/config/v1 /hotels/{sourceHotelId}/trackItActions/copy: put: summary: ' Copy Track it Actions' description: Copy Track it Actions.

OperationId:copyTrackItActions

operationId: copyTrackItActions parameters: - name: sourceHotelId in: path required: true description: Unique ID of source hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyTrackItActions' description: List of Track it Actions to be copied. required: true servers: - url: /fof/config/v1 /hotels/{sourceHotelId}/trackItLocations/copy: put: summary: ' Copy Track it Locations' description: Copy Track it Locations.

OperationId:copyTrackItLocations

operationId: copyTrackItLocations parameters: - name: sourceHotelId in: path required: true description: Unique ID of source hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyTrackItLocations' description: List of Track it Locations to be copied. required: true servers: - url: /fof/config/v1 /hotels/{sourceHotelId}/trackItTypes/copy: put: summary: ' Copy Track it Types' description: Copy Track it Types.

OperationId:copyTrackItTypes

operationId: copyTrackItTypes parameters: - name: sourceHotelId in: path required: true description: Unique ID of source hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyTrackItTypes' description: List of Track it Types to be copied. required: true servers: - url: /fof/config/v1 /buildingFloorMappings: get: summary: Get Hotel level floor mappings to buildings description: Use this API to get Hotel level floor mappings to buildings.

OperationId:getBuildingFloorMappings

operationId: getBuildingFloorMappings parameters: - name: hotelId in: query required: false description: Specifies the hotel code for which floor mappings have to be searched. schema: type: string - name: buildingsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching floor mappings to buildings. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/buildingFloorMappingsDetails' '204': description: BuildingFloorMappings not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Set Hotel level floor mappings to buildings description: You can use this API to set Hotel level floor mappings to buildings.

OperationId:setBuildingFloorMappings

operationId: setBuildingFloorMappings parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/setBuildingFloorMappings' description: Request object for setting floor mappings to buildings. required: true servers: - url: /rm/config/v1 /buildingGroups: get: summary: 'Get Housekeeping Building Group info ' description: Use this API to return housekeeping building groups based on search criteria such as hotelId, codes, wildCard, descriptionWildCard.

Building groups are used to group multiple building together for the purpose of housekeeping task assignment; allowing task sheets to be generated per building group.

OperationId:getBuildingGroups

operationId: getBuildingGroups parameters: - name: hotelId in: query required: false description: Hotel associated with the Building/Building Group schema: type: string - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: descriptionWildCard in: query required: false description: The description or a part of the description based on which results should be filtered. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object after fetching Building Groups of the Hotel. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/buildingGroupsDetails' '204': description: BuildingGroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Housekeeping Building Group description: Use this API to create housekeeping building groups.

Building groups are used to group multiple building together for the purpose of housekeeping task assignment; allowing task sheets to be generated per building group.

OperationId:postBuildingGroups

operationId: postBuildingGroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/buildingGroupsCriteria' description: Request object to create Building Group details of the Hotel. required: true delete: summary: Delete Housekeeping Building Group description: Use this API to delete housekeeping building groups based on hotelIds, hotelId.

Building groups are used to group multiple building together for the purpose of housekeeping task assignment; allowing task sheets to be generated per building group.

OperationId:deleteBuildingGroups

operationId: removeBuildingGroups parameters: - name: hotelIds in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - name: hotelId in: query description: Hotel where the code is configured. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Housekeeping Building Group description: Use this API to update housekeeping building groups based on buildingGroupsToBeChanged.

Building groups are used to group multiple building together for the purpose of housekeeping task assignment; allowing task sheets to be generated per building group.

OperationId:changeBuildingGroups

operationId: changeBuildingGroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/buildingGroupsToBeChanged' description: Request object to change the Building Group details of the Hotel. required: true servers: - url: /rm/config/v1 /buildings: get: summary: Get Building information description: Use this API to return buildings based on search criteria such as hotelId, codes, wildCard, descriptionWildCard, buildingGroupCodes, buildingGroupWildCard. Buildings are used for the purpose of housekeeping task assignment; allowing task sheets to be generated per building.

OperationId:getBuildings

operationId: getBuildings parameters: - name: hotelId in: query required: false description: Hotel associated with the Building/Building Group schema: type: string - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: descriptionWildCard in: query required: false description: The description or a part of the description based on which results should be filtered. schema: type: string - name: buildingGroupCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: buildingGroupWildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object after fetching Building details of the Hotel. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/buildingsDetails' '204': description: Buildings not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig delete: summary: Delete Buildings description: Use this API to delete buildings based on hotelIds, hotelId. Buildings are used for the purpose of housekeeping task assignment; allowing task sheets to be generated per building.

OperationId:removeBuildings

operationId: removeBuildings parameters: - name: hotelIds in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - name: hotelId in: query description: Hotel where the code is configured. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Buildings description: Use this API to update buildings based on buildingsToBeChanged. Buildings are used for the purpose of housekeeping task assignment; allowing task sheets to be generated per building.

OperationId:changeBuildings

operationId: changeBuildings parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/buildingsToBeChanged' description: Request object to change Building details of the Hotel. required: true post: summary: Create new Buildings description: Use this API to create new buildings. Buildings are used for the purpose of housekeeping task assignment; allowing task sheets to be generated per building.

OperationId:postBuildings

operationId: postBuildings parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/buildingsCriteria' description: Request object to create Building details of the Hotel. required: true servers: - url: /rm/config/v1 /floors: get: summary: Get floors description: Use this API to return floors based on search criteria such as hotelIds, floorCodes. Floor is referencing the story of a building that hotel rooms are located on.

OperationId:getFloors

operationId: getFloors parameters: - name: hotelIds in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: floorCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching floors at the hotel level. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/floorsDetails' '204': description: Floors not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create floors description: Use this API to create floors. Floor is referencing the story of a building that hotel rooms are located on.

OperationId:postFloors

operationId: postFloors parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/floorsCriteria' description: Request object for creating floors at the hotel level. required: true servers: - url: /rm/config/v1 /floors/{floorsId}: put: summary: Change floors description: Use this API to update floors based on floorsId, floorsToBeChanged.Floor is referencing the story of a building that hotel rooms are located on.

OperationId:changeFloors

operationId: changeFloors parameters: - name: floorsId in: path required: true description: Unique ID of floor. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/floorsToBeChanged' description: Request object for changing floors at the hotel level. required: true delete: summary: Delete floors description: Use this API to delete floors based on floorsId, hotelId. Floor is referencing the story of a building that hotel rooms are located on.

OperationId:deleteFloors

operationId: removeFloors parameters: - name: floorsId in: path required: true description: Unique ID of floor. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: query description: Hotel where the code is configured. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /hotels/{hotelId}/action/validate: put: summary: Validate room types room class is currently in use description: Use this API to validate room types room class is currently in use for a specific hotel based on search criteria such as hotelId, validateRoomClassInUse.

OperationId:validateRoomClassInUse

operationId: validateRoomClassInUse parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/validateRoomClassInUse' description: Request object to validate if room type's room class is currently in use. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/creditRules: get: summary: Get Housekeeping Credit Rules description: Use this API to return housekeeping credit rules for a specific hotel based on search criteria such as hotelId, ruleCodes, ruleType, includeInactive.

Housekeeping credit rules are used to add additional credits to the housekeeping tasks sheets depending on configured values i.e. travel credits between buildings, or floors, or inventory items i.e. cribs, rollaways.

OperationId:getHousekeepingCreditRules

operationId: getHousekeepingCreditRules parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: ruleCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: ruleType in: query required: false description: A Facility Rule will add extra credit to a task assignment sheet when certain task conditions exist. Multiple Facility Task Rules will be applied on top of each other if the conditions are met. A Miscellaneous Rule will add extra credit to a task assignment sheet when the attendants are occupied with anything other than cleaning a room, for example a team meeting. A Special Rule will add extra credit to a task assignment sheet when the defined Specials are attached to a reservation. A Traveling Rule will add extra credit to a task assignment sheet when rooms from multiple Buildings, Section Groups, Sections and/or Floors are assigned. An Inventory Item Rule will add extra credit to a task assignment sheet when the defined Items are attached to a reservation. schema: type: string enum: - FacilityTask - Miscellaneous - Special - Travelling - ItemInventory uniqueItems: true - name: includeInactive in: query required: false description: Flag to indicate if inactive credit rules should be included. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching housekeeping credit rules. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/housekeepingCreditRulesDetails' '204': description: HousekeepingCreditRules not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Housekeeping Credit Rules description: Use this API to create housekeeping credit rules for a specific hotel.

Housekeeping credit rules are used to add additional credits to the housekeeping tasks sheets depending on configured values i.e. travel credits between buildings, or floors, or inventory items i.e. cribs, rollaways.

OperationId:postHousekeepingCreditRules

operationId: postHousekeepingCreditRules parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/housekeepingCreditRulesCriteria' description: Request object for creating housekeeping credit rules. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/creditRules/{code}: put: summary: Change Housekeeping Credit Rules description: Use this API to update housekeeping credit rules for a specific hotel based on code, hotelId, housekeepingCreditRulesToBeChanged.

Housekeeping credit rules are used to add additional credits to the housekeeping tasks sheets depending on configured values i.e. travel credits between buildings, or floors, or inventory items i.e. cribs, rollaways.

OperationId:changeHousekeepingCreditRules

operationId: changeHousekeepingCreditRules parameters: - name: code in: path required: true description: Unique ID of rule code. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/housekeepingCreditRulesToBeChanged' description: Request object for changing housekeeping credit rules. required: true delete: summary: Delete Housekeeping Credit Rules description: Use this API to delete housekeeping credit rules for a specific hotel based on code, hotelId.

Housekeeping credit rules are used to add additional credits to the housekeeping tasks sheets depending on configured values i.e. travel credits between buildings, or floors, or inventory items i.e. cribs, rollaways.

OperationId:removeHousekeepingCreditRules

operationId: removeHousekeepingCreditRules parameters: - name: code in: path required: true description: Unique ID of Code. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /hotels/{hotelId}/housekeepingAttendants: get: summary: Get Housekeeping Attendants description: Use this API to return housekeeping attendants for a specific hotel based on search criteria such as hotelId, name, attendantsCodes, wildCard, includeInactive. OPERA Cloud enables you to store housekeeping attendant information, daily assignments, and tracks credits or number of rooms cleaned by each attendant.

OperationId:getHousekeepingAttendants

operationId: getHousekeepingAttendants deprecated: true parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: name in: query required: false description: Partial name of an attendant. schema: type: string - name: attendantsCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: includeInactive in: query required: false description: Indicator that tells whether to include inactive in search results. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Housekeeping Attendants. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/housekeepingAttendantsDetails' '204': description: HousekeepingAttendants not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create new housekeeping attendants configuration description: Use this API to create housekeeping attendants for a specific hotel. OPERA Cloud enables you to store housekeeping attendant information, daily assignments, and tracks credits or number of rooms cleaned by each attendant.

OperationId:postHousekeepingAttendants

operationId: postHousekeepingAttendants parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/housekeepingAttendantsCriteria' description: Add housekeeping attendant(S). required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/housekeepingAttendants/searches: post: summary: Search Housekeeping Attendants description: Use this API to return housekeeping attendants for a specific hotel based on search criteria such as hotelId, name, attendantsCodes, wildCard, includeInactive. OPERA Cloud enables you to store housekeeping attendant information, daily assignments, and tracks credits or number of rooms cleaned by each attendant.

OperationId:searchHousekeepingAttendants

operationId: searchHousekeepingAttendants parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Housekeeping Attendants. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/housekeepingAttendantsDetails' '204': description: HousekeepingAttendants not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/searchHousekeepingAttendantsRequest' servers: - url: /rm/config/v1 /hotels/{hotelId}/housekeepingAttendants/{attendantId}: put: summary: Change housekeeping attendants configuration description: Use this API to update housekeeping attendants for a specific hotel based on attendantId, hotelId, housekeepingAttendantsToBeChanged.

OPERA Cloud enables you to store housekeeping attendant information, daily assignments, and tracks credits or number of rooms cleaned by each attendant.

OperationId:changeHousekeepingAttendants

operationId: changeHousekeepingAttendants parameters: - name: attendantId in: path required: true description: Unique ID of attendant. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/housekeepingAttendantsToBeChanged' description: Modify housekeeping attendants required: true delete: summary: Delete housekeeping attendants configuration description: Use this API to delete housekeeping attendants for a specific hotel based on attendantId, hotelId, inactive.OPERA Cloud enables you to store housekeeping attendant information, daily assignments, and tracks credits or number of rooms cleaned by each attendant.

OperationId:removeHousekeepingAttendants

operationId: removeHousekeepingAttendants deprecated: true parameters: - name: attendantId in: path required: true description: Unique ID of attendant. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: inactive in: query description: Indicates whether the attendant is active or not. required: false style: form explode: true schema: type: array items: type: boolean - name: name in: query description: An attendant ID. required: false style: form explode: true schema: type: array items: type: string - name: phoneNo in: query description: An attendant's phone No. required: false style: form explode: true schema: type: array items: type: string - name: section in: query description: Section where the attendant is assigned. required: false style: form explode: true schema: type: array items: type: string - name: floor in: query description: Floor where the attendant is assigned. required: false style: form explode: true schema: type: array items: type: string - name: job in: query description: Job which the attendant is assigned. required: false style: form explode: true schema: type: array items: type: string - name: friday in: query required: false schema: type: boolean - name: monday in: query required: false schema: type: boolean - name: saturday in: query required: false schema: type: boolean - name: sunday in: query required: false schema: type: boolean - name: thursday in: query required: false schema: type: boolean - name: tuesday in: query required: false schema: type: boolean - name: wednesday in: query required: false schema: type: boolean - name: appUser in: query description: Application User ID assigned for the attendant. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /hotels/{hotelId}/housekeepingAttendants/{attendantId}/deletions: post: summary: Delete housekeeping attendants configuration description: Use this API to delete housekeeping attendants for a specific hotel based on attendantId, hotelId, inactive.OPERA Cloud enables you to store housekeeping attendant information, daily assignments, and tracks credits or number of rooms cleaned by each attendant.

OperationId:postDeleteHousekeepingAttendants

operationId: postDeleteHousekeepingAttendants parameters: - name: attendantId in: path required: true description: Unique ID of attendant. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/deleteHousekeepingAttendantsRequest' servers: - url: /rm/config/v1 /hotels/{hotelId}/housekeepingRoomSchedules: get: summary: Get housekeeping room schedules description: Use this API to return housekeeping room schedules for a specific hotel based on search criteria such as hotelId, roomTypeCodes, housekeepingRoomScheduleCodes.

Housekeeping room schedules reference housekeeping tasks and housekeeping codes associated to a room type.

OperationId:getHousekeepingRoomSchedules

operationId: getHousekeepingRoomSchedules parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: roomTypeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: housekeepingRoomScheduleCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching housekeeping tasks and housekeeping codes associated to a room type. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/housekeepingRoomSchedulesDetails' '204': description: HousekeepingRoomSchedules not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create housekeeping room schedules description: Use this API to create housekeeping room schedules for a specific hotel. Housekeeping room schedules reference housekeeping tasks and housekeeping codes associated to a room type.

OperationId:postHousekeepingRoomSchedules

operationId: postHousekeepingRoomSchedules parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/housekeepingRoomSchedulesCriteria' description: Request object for associating housekeeping tasks and housekeeping codes to a room type. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/housekeepingRoomSchedules/{roomScheduleId}: put: summary: Change housekeeping room schedules description: Use this API to update housekeeping room schedules for a specific hotel based on the roomScheduleId. Housekeeping room schedules reference housekeeping tasks and housekeeping codes associated to a room type.

OperationId:changeHousekeepingRoomSchedules

operationId: changeHousekeepingRoomSchedules parameters: - name: roomScheduleId in: path required: true description: Unique ID of room scheduled. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/housekeepingRoomSchedulesToBeChanged' description: Request object for changing housekeeping tasks and housekeeping codes associated to a room type. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/housekeepingSectionGroups: get: summary: Get Housekeeping Section Groups description: Use this API to return housekeeping section groups for a specific hotel based on search criteria such as hotelId, housekeepingSectionGroupsCodes.

Housekeeping section groups and sections can be used to group rooms into sections or divisions meaningful to the housekeeping attendants with respect to floor numbers, various buildings, and group of rooms typically cleaned by one attendant during the day or turndowns during the evening.

OperationId:getHousekeepingSectionGroups

operationId: getHousekeepingSectionGroups parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: List of Hotels. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: housekeepingSectionGroupsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching housekeeping section Groups. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/housekeepingSectionGroupsDetails' '204': description: HousekeepingSectionGroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Housekeeping Section Groups description: Use this API to create housekeeping section groups for a specific hotel.

Housekeeping section groups and sections can be used to group rooms into sections or divisions meaningful to the housekeeping attendants with respect to floor numbers, various buildings, and group of rooms typically cleaned by one attendant during the day or turndowns during the evening.

OperationId:postHousekeepingSectionGroups

operationId: postHousekeepingSectionGroups parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/housekeepingSectionGroupsCriteria' description: Request object to create House Keeping Section Groups for resort. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/housekeepingSectionGroups/{code}: delete: summary: Delete Housekeeping Section Groups description: Use this API to delete housekeeping section groups for a specific hotel based on hotelId, housekeepingSectionGroupsCode.

Housekeeping section groups and sections can be used to group rooms into sections or divisions meaningful to the housekeeping attendants with respect to floor numbers, various buildings, and group of rooms typically cleaned by one attendant during the day or turndowns during the evening.

OperationId:removeHousekeepingSectionGroups

operationId: removeHousekeepingSectionGroups parameters: - name: code in: path required: true description: Unique Code of house keeping section group. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: housekeepingSectionGroupsCode in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Housekeeping Section Groups description: Use this API to update housekeeping section groups for a specific hotel based on code, hotelId, housekeepingSectionGroupsToBeChanged.

Housekeeping section groups and sections can be used to group rooms into sections or divisions meaningful to the housekeeping attendants with respect to floor numbers, various buildings, and group of rooms typically cleaned by one attendant during the day or turndowns during the evening.

OperationId:changeHousekeepingSectionGroups

operationId: changeHousekeepingSectionGroups parameters: - name: code in: path required: true description: Unique Code of house keeping section group. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/housekeepingSectionGroupsToBeChanged' description: Request object for modifying housekeeping section groups in resort. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/housekeepingSections: get: summary: Get Housekeeping Sections description: Use this API to return housekeeping sections for a specific hotel based on search criteria such as hotelId, includeInactive, housekeepingSectionsCodes, description.

Housekeeping section groups and sections can be used to group rooms into sections or divisions meaningful to the housekeeping attendants with respect to floor numbers, various buildings, and group of rooms typically cleaned by one attendant during the day or turndowns during the evening.

OperationId:getHousekeepingSections

operationId: getHousekeepingSections parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: List of Hotels. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Indicates if the Section Code is active. schema: type: boolean - name: housekeepingSectionsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: description in: query required: false description: Description of the Section. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching housekeeping section codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/housekeepingSectionsDetails' '204': description: HousekeepingSections not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Housekeeping Sections description: Use this API to create housekeeping sections for a specific hotel. Housekeeping section groups and sections can be used to group rooms into sections or divisions meaningful to the housekeeping attendants with respect to floor numbers, various buildings, and group of rooms typically cleaned by one attendant during the day or turndowns during the evening.

OperationId:postHousekeepingSections

operationId: postHousekeepingSections parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/housekeepingSectionsCriteria' description: Add housekeeping section codes configurations for resort. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/housekeepingSections/{code}: delete: summary: Delete Housekeeping Sections description: Use this API to delete housekeeping sections for a specific hotel based on the code. Housekeeping section groups and sections can be used to group rooms into sections or divisions meaningful to the housekeeping attendants with respect to floor numbers, various buildings, and group of rooms typically cleaned by one attendant during the day or turndowns during the evening.

OperationId:removeHousekeepingSections

operationId: removeHousekeepingSections parameters: - name: code in: path required: true description: Unique Code of house keeping sections. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Housekeeping Sections description: Use this API to update housekeeping sections for a specific hotel based on code, hotelId. Housekeeping section groups and sections can be used to group rooms into sections or divisions meaningful to the housekeeping attendants with respect to floor numbers, various buildings, and group of rooms typically cleaned by one attendant during the day or turndowns during the evening.

OperationId:changeHousekeepingSections

operationId: changeHousekeepingSections parameters: - name: code in: path required: true description: Unique Code of house keeping sections. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/housekeepingSectionsToBeChanged' description: Modify housekeeping section codes in resort configurations. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/housekeepingSupplyCodes: get: summary: Get Housekeeping Codes description: Use this API to return housekeeping supply codes for a specific hotel based on search criteria such as hotelId, codes, wildCard. Housekeeping supplies such as pillow cases, hand towels, bath towels, shampoo can be used when scheduling housekeeping tasks.

OperationId:getHouseKeepingSupplyCodes

operationId: getHouseKeepingSupplyCodes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching housekeeping codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/housekeepingCodesDetails' '204': description: HouseKeepingSupplyCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Housekeeping Codes description: Use this API to create housekeeping supply codes for a specific hotel. Housekeeping supplies such as pillow cases, hand towels, bath towels, shampoo can be used when scheduling housekeeping tasks.

OperationId:postHousekeepingSupplyCodes

operationId: postHousekeepingSupplyCodes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/housekeepingCodesCriteria' description: Add housekeeping codes configurations for property. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/housekeepingSupplyCodes/{code}: delete: summary: Delete Housekeeping Codes description: Use this API to delete housekeeping supply codes for a specific hotel based on code, hotelId, housekeepingCodes, sequence. Housekeeping supplies such as pillow cases, hand towels, bath towels, shampoo can be used when scheduling housekeeping tasks.

OperationId:removeHousekeepingSupplyCodes

operationId: removeHousekeepingSupplyCodes parameters: - name: code in: path required: true description: Unique Code of house keeping. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: housekeepingCodes in: query required: false description: Code for the code type. schema: type: string - name: sequence in: query required: false description: Display sequence for the housekeeping task. schema: type: number - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Housekeeping Codes description: Use this API to update housekeeping supply codes for a specific hotel based on code, hotelId, housekeepingCodesToBeChanged. Housekeeping supplies such as pillow cases, hand towels, bath towels, shampoo can be used when scheduling housekeeping tasks.

OperationId:changeHousekeepingSupplyCodes

operationId: changeHousekeepingSupplyCodes parameters: - name: code in: path required: true description: Unique Code of house keeping. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/housekeepingCodesToBeChanged' description: Modify housekeeping codes in resort configurations. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/housekeepingTaskSheetRooms: get: summary: Get information related to housekeeping tasksheet rooms description: Use this API to return information related to housekeeping tasksheet rooms for a specific hotel based on search criteria such as hotelId, building, floor, roomType, daySection, eveningSection, fromRoom, toRoom. Task Sheets inform housekeeping room attendants about their daily work assignments; providing a list of rooms assigned to attendants, any special instructions about specific rooms, and related reservations details.

OperationId:getHousekeepingTaskSheetRooms

operationId: getHousekeepingTaskSheetRooms parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: building in: query required: false description: Building code for which the housekeeping rooms have to be searched. This criteria can be applied only if the BUILDINGS parameter is active. schema: type: string - name: floor in: query required: false description: Floor code for which the housekeeping rooms have to be searched schema: type: string - name: roomType in: query required: false description: Room type for which the housekeeping rooms have to be searched schema: type: string - name: daySection in: query required: false description: Day section code for which the housekeeping rooms have to be searched. This criteria can be applied only if the HOUSEKEEPING_SECTIONS parameter is active. schema: type: string - name: eveningSection in: query required: false description: Evening section code for which the housekeeping rooms have to be searched. This criteria can be applied only if the HOUSEKEEPING_SECTIONS parameter is active. schema: type: string - name: fromRoom in: query required: false description: From Room code for which the housekeeping rooms have to be searched schema: type: string - name: toRoom in: query required: false description: To Room code for which the housekeeping rooms have to be searched schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching details about housekeeping tasksheet rooms. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/housekeepingTaskSheetRoomsDetails' '204': description: HousekeepingTaskSheetRooms not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: ' set information related to housekeeping tasksheet rooms' description: Use this API to update information related to housekeeping tasksheet rooms for a specific hotel based on hotelId, setHousekeepingTaskSheetRooms.Task Sheets inform housekeeping room attendants about their daily work assignments; providing a list of rooms assigned to attendants, any special instructions about specific rooms, and related reservations details.

OperationId:setHousekeepingTaskSheetRooms

operationId: setHousekeepingTaskSheetRooms parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/setHousekeepingTaskSheetRooms' description: Request object for setting details about housekeeping tasksheet rooms. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/housekeepingTasks: get: summary: Get Housekeeping Tasks description: Use this API to return housekeeping tasks for a specific hotel based on search criteria such as hotelId, taskCodes, wildCard, includeInactive. Task codes enable you to create various housekeeping task sheets (for example, daily cleaning, mattress turning, inspections, turndown, etc.).

OperationId:getHousekeepingTasks

operationId: getHousekeepingTasks parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: taskCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: includeInactive in: query required: false description: Flag to indicate if inactive tasks should be included. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching housekeeping tasks. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/housekeepingTasksDetails' '204': description: HousekeepingTasks not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Housekeeping Tasks description: Use this API to create housekeeping tasks for a specific hotel. Task codes enable you to create various housekeeping task sheets (for example, daily cleaning, mattress turning, inspections, turndown, etc.).

OperationId:postHousekeepingTasks

operationId: postHousekeepingTasks parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/housekeepingTasksCriteria' description: Add housekeeping tasks configurations for resort. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/housekeepingTasks/{code}: delete: summary: Delete Housekeeping Tasks description: Use this API to delete housekeeping tasks for a specific hotel based on code, hotelId, forceRemove. Task codes enable you to create various housekeeping task sheets (for example, daily cleaning, mattress turning, inspections, turndown, etc.).

OperationId:removeHousekeepingTasks

operationId: removeHousekeepingTasks parameters: - name: code in: path required: true description: Unique Code of task. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: forceRemove in: query required: false description: Flag to indicate if records that are marked as "protected" can be removed. If false, any attempt to remove records that are protected will return an error. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Housekeeping Tasks description: Use this API to update housekeeping tasks for a specific hotel based on code, hotelId, housekeepingTasksToBeChanged. Task codes enable you to create various housekeeping task sheets (for example, daily cleaning, mattress turning, inspections, turndown, etc.).

OperationId:changeHousekeepingTasks

operationId: changeHousekeepingTasks parameters: - name: code in: path required: true description: Unique Code of task. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/housekeepingTasksToBeChanged' description: Modify housekeeping tasks in resort configurations. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/outOfOrderServiceReasons: get: summary: Get Out Of Order Service Reasons description: Use this API to return out of order service reasons for a specific hotel based on search criteria such as hotelId, includeInactive, limit offset, reasonCodes. Out of order (OO) and out of service (OS) are two additional housekeeping statuses. These options are used when changing the status for rooms that should not be sold due to damage, maintenance, low occupancy wing, etc.

OperationId:getOutOfOrderServiceReasons

The maximum allowable limit for this API is 1000.

operationId: getOutOfOrderServiceReasons parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: List of Hotels. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Indicator that tells whether to include inactive out of order/service reasons in search results. schema: type: boolean - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query 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. schema: type: integer default: 0 - name: reasonCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Out of Order/Service Reason(s). content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/outOfOrderServiceReasonsDetails' '204': description: OutOfOrderServiceReasons not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Out Of Order Service Reasons description: Use this API to create out of order service reasons for a specific hotel. Out of order (OO) and out of service (OS) are two additional housekeeping statuses. These options are used when changing the status for rooms that should not be sold due to damage, maintenance, low occupancy wing, etc.

OperationId:postOutOfOrderServiceReasons

operationId: postOutOfOrderServiceReasons parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/outOfOrderServiceReasonsCriteria' description: Request object for creating new out of order/service reasons for hotels. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/outOfOrderServiceReasons/{reasonCode}: put: summary: Change Out Of Order Service Reasons description: Use this API to update out of order service reasons for a specific hotel based on reasonCode, hotelId, outOfOrderServiceReasonsToBeChanged.Out of order (OO) and out of service (OS) are two additional housekeeping statuses. These options are used when changing the status for rooms that should not be sold due to damage, maintenance, low occupancy wing, etc.

OperationId:changeOutOfOrderServiceReasons

operationId: changeOutOfOrderServiceReasons parameters: - name: reasonCode in: path required: true description: Unique Code of reason. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/outOfOrderServiceReasonsToBeChanged' description: Request object for modifying out of order/service reasons for hotels. required: true delete: summary: Delete Out Of Order Service Reasons description: Use this API to delete out of order service reasons for a specific hotel based on reasonCode, hotelId. Out of order (OO) and out of service (OS) are two additional housekeeping statuses. These options are used when changing the status for rooms that should not be sold due to damage, maintenance, low occupancy wing, etc.

OperationId:removeOutOfOrderServiceReasons

operationId: removeOutOfOrderServiceReasons parameters: - name: reasonCode in: path required: true description: Unique Code of reason. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /hotels/{hotelId}/rateGroups: get: summary: Get Room Groups description: Use this API to get Room Groups.

OperationId:getRoomGroups

operationId: getRoomGroups parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: fetchInactive in: query required: false description: Determines wether to fetch inactive records or not. schema: type: boolean - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Room Groups. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomGroupsDetails' '204': description: RoomGroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Room Groups description: Use this API to create Room Groups.

OperationId:postRoomGroups

operationId: postRoomGroups parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomGroupsCriteria' description: Request object for creating Room Groups. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/rateGroups/{rateGroupCode}: put: summary: Change Room Groups description: Use this API to update Room Groups.

OperationId:changeRoomGroups

operationId: changeRoomGroups parameters: - name: rateGroupCode in: path required: true description: Unique Code of rate group. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomGroupsToBeChanged' description: Request object for changing Room Groups. required: true delete: summary: Delete Room Groups description: Use this API to delete Room Groups.

OperationId:removeRoomGroups

operationId: removeRoomGroups parameters: - name: rateGroupCode in: path required: true description: Unique Code of rate group. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: roomGroupsCode in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /hotels/{hotelId}/roomClasses: get: summary: Get Room Classes description: Retrieve a list of a properties Room Classes.

OperationId:getRoomClasses

operationId: getRoomClasses parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: List of Hotels. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: roomClassCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching existing hotel level room classes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomClassesDetails' '204': description: RoomClasses not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Room Class description: Use this API to create a new hotel level room class.

OperationId:postRoomClass

operationId: postRoomClass parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomClassCriteria' description: Request object for creating a new hotel level room class. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/roomClasses/{roomClassId}: put: summary: Update a Room Class description: Use this API to update an existing properties Room Class.

OperationId:putRoomClass

operationId: putRoomClass parameters: - name: roomClassId in: path required: true description: Unique ID of room class. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomClassToBeChanged' description: Request object for changing an existing hotel level room class. required: true delete: summary: Delete a Room Class description: Use this API to delete an existing properties Room Class.

OperationId:deleteRoomClass

operationId: deleteRoomClass parameters: - name: roomClassId in: path required: true description: Unique ID of room class. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: roomClass in: query required: false description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /hotels/{hotelId}/roomConditions: get: summary: 'Get room condition configuration ' description: Use this API to get room condition configuration .

OperationId:getResortRoomConditions

operationId: getResortRoomConditions parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: List of Hotels. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: roomConditionCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: inactive in: query required: false schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for information regarding room condition configuration in a resort. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/resortRoomConditionsDetails' '204': description: ResortRoomConditions not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: 'Create room condition configuration ' description: Use this API to create room condition configuration .

OperationId:postResortRoomCondition

operationId: postResortRoomCondition parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/resortRoomConditionCriteria' description: Request object for Create Room Condition. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/roomConditions/{roomConditionCode}: put: summary: 'Change room condition configuration ' description: Use this API to update room condition configuration .

OperationId:changeResortRoomCondition

operationId: changeResortRoomCondition parameters: - name: roomConditionCode in: path required: true description: Unique Code of template. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/resortRoomConditionToBeChanged' description: Request object for Modifying Room Condition configuration in a resort. required: true delete: summary: 'Delete room condition configuration ' description: Use this API to delete room condition configuration .

OperationId:removeResortRoomCondition

operationId: removeResortRoomCondition parameters: - name: roomConditionCode in: path required: true description: Unique Code of template. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /hotels/{hotelId}/roomFeatures: get: summary: Get Hotel Room Features description: Use this API to get Hotel Room Features.

OperationId:getRoomFeatures

operationId: getRoomFeatures parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: List of Hotels. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object to fetch room features of hotel. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomFeaturesDetails' '204': description: RoomFeatures not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Hotel Room Features description: Use this API to update Hotel Room Features.

OperationId:changeRoomFeatures

operationId: changeRoomFeatures parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomFeaturesToBeChanged' description: Request object for changing room features of hotel. required: true post: summary: Create Hotel Room Features description: Use this API to create Hotel Room Features.

OperationId:postRoomFeatures

operationId: postRoomFeatures parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomFeaturesCriteria' description: Request object for creating room features of hotel. required: true delete: summary: Delete Hotel Room Features description: Use this API to delete Hotel Room Features.

OperationId:removeRoomFeatures

operationId: removeRoomFeatures parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: genericHotelParentCodes in: query description: Specifies the code. required: false style: form explode: true schema: type: array items: type: string - name: genericHotelParentCodesGroup in: query description: Specifies the group. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /hotels/{hotelId}/roomMaintenanceReasons: get: summary: Get Hotel Room Maintenance Reasons description: Use this API to get Hotel Room Maintenance Reasons.

OperationId:getHotelRoomMaintenanceReasons

The maximum allowable limit for this API is 1000.

operationId: getHotelRoomMaintenanceReasons parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: List of Hotels. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query 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. schema: type: integer default: 0 - name: roomMaintenanceReasonCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: includeInactive in: query required: false description: Inactive flag - whether or not to display inactive records schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching room maintenance reasons for a hotel. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/hotelRoomMaintenanceReasonsDetails' '204': description: HotelRoomMaintenanceReasons not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Hotel Room Maintenance Reasons description: Use this API to create Hotel Room Maintenance Reasons.

OperationId:postHotelRoomMaintenanceReasons

operationId: postHotelRoomMaintenanceReasons parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelRoomMaintenanceReasonsCriteria' description: Request object for creating new room maintenance reasons for a hotel. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/roomMaintenanceReasons/{reasonCode}: put: summary: Change Hotel Room Maintenance Reasons description: Use this API to update Hotel Room Maintenance Reasons.

OperationId:changeHotelRoomMaintenanceReasons

operationId: changeHotelRoomMaintenanceReasons parameters: - name: reasonCode in: path required: true description: Unique Code of reason. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelRoomMaintenanceReasonsToBeChanged' description: Request object for modifying room maintenance reasons for a hotel. required: true delete: summary: Delete Hotel Room Maintenance Reasons description: Use this API to delete Hotel Room Maintenance Reasons.

OperationId:removeHotelRoomMaintenanceReasons

operationId: removeHotelRoomMaintenanceReasons parameters: - name: reasonCode in: path required: true description: Unique Code of reason. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /hotels/{hotelId}/roomSchedules/{sequenceId}: delete: summary: Delete housekeeping room schedules description: Use this API to remove the housekeeping room schedule for a specific property based on hotleId and sequence number of task.

OperationId: removeHousekeepinSchedule

operationId: removeHousekeepingSchedule parameters: - name: sequenceId in: path required: true description: Unique sequence number of room scheduled. schema: type: integer minimum: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 20 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /hotels/{hotelId}/roomType/{roomTypeCode}: get: summary: Get Room Type Information description: Use this API to get Room Type details of a Property. The search criteria can include a list of Room Types and the Property (hotelID).

OperationId:getRoomTypeInfo

operationId: getRoomTypeInfo parameters: - name: roomTypeCode in: path required: true description: Unique Code of room type. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching room type information. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomTypeInfoDetails' '204': description: RoomTypeInfo not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /hotels/{hotelId}/roomTypeCodes/{roomTypeCode}/housekeepingRoomSchedules/{roomScheduleId}: delete: summary: Delete housekeeping room schedules description: Use this API to delete housekeeping room schedules.

OperationId:removeHousekeepingRoomSchedules

operationId: removeHousekeepingRoomSchedules parameters: - name: roomScheduleId in: path required: true description: Unique ID of room scheduled. schema: type: string maxLength: 2000 minLength: 1 - name: roomTypeCode in: path required: true description: Unique ID of room Type Code. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /hotels/{hotelId}/roomTypes: get: summary: Get Room Types description: Fetch a properties Room Types. The request can be based on a properties Room class or Room Type. The operation returns a list of room types and a summary of the room types.

OperationId:getRoomTypes

The maximum allowable limit for this API is 1000.

operationId: getRoomTypes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: List of Hotels. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: accessible in: query required: false description: Flag to indicate if accessible room type should be fetched. schema: type: boolean - name: includeInactive in: query required: false description: Flag to indicate if inactive room types should be included. schema: type: boolean - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query 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. schema: type: integer default: 0 - name: physical in: query required: false description: Is it a physical sleep room type. schema: type: boolean - name: pseudo in: query required: false description: Is it a pseudo room type. schema: type: boolean - name: summaryInfo in: query required: false description: Flag to indicate if summary or detailed information should be fetched. schema: type: boolean - name: roomTypeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: roomClassCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for Fetching existing Room Types. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomTypesDetails' '204': description: RoomTypes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create a new room type description: Use this API to create new room types for a property. A list of new room types can be passed as part of the request to Use this API to create multiple rooms in one request.

OperationId:postRoomTypes

operationId: postRoomTypes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomTypesCriteria' description: Request object for Creating a new Room Type. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/roomTypes/{roomTypeId}: put: summary: Update a Room Type description: Use this API to update a Room Type from a property. A list of room types that need to be modified can also passed as part of the request.

OperationId:putRoomTypes

operationId: putRoomTypes parameters: - name: roomTypeId in: path required: true description: Unique ID of room types. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomTypesToBeChanged' description: Request object for Modifying Room Type. required: true delete: summary: Delete Room Types description: Use this API to delete a Room Type from a property.

OperationId:deleteRoomTypes

operationId: deleteRoomTypes parameters: - name: roomTypeId in: path required: true description: Unique ID of room types. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: roomType in: query required: false description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /hotels/{hotelId}/rooms: get: summary: Get list of hotel rooms description: Use this API to return rooms for a specific hotel based on search criteria such as roomClassCodes, roomTypeCodes, room, etc..

OperationId:getRooms

The maximum allowable limit for this API is 1000.

operationId: getRooms parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query 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. schema: type: integer default: 0 - name: physical in: query required: false description: Is it a physical room type. schema: type: boolean - name: pseudo in: query required: false description: Is it a pseudo room type. schema: type: boolean - name: roomClassCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: roomTypeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: room in: query required: false description: Room to be searched. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching complete information of existing rooms. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomsDetails' '204': description: Rooms not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create a new room description: Use this API to create a new room for a hotel.

OperationId:postRooms

operationId: postRooms parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomCriteria' description: Request object for creating a new room. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/rooms/{roomsId}: put: summary: Change an existing room description: Use this API to update an existing room.

OperationId:putRooms

operationId: putRooms parameters: - name: roomsId in: path required: true description: Unique ID of room. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomToBeChanged' description: Request object for changing details of an existing room. required: true delete: summary: Delete an existing room given hotel code and room description: Use this API to delete an existing room given hotel code and room.

OperationId:deleteRooms

operationId: deleteRooms parameters: - name: roomsId in: path required: true description: Unique ID of room. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: room in: query required: false description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /hotels/{hotelId}/rooms/{roomsId}/copy: put: summary: Copy Rooms description: Use this API to create new rooms based on an existing room. Component rooms are not allowed to be copied.

OperationId:copyRooms

operationId: copyRooms parameters: - name: roomsId in: path required: true description: Unique ID of room. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyRooms' description: Request object for creating multiple rooms based on an existing room. New rooms may have different floor preferences, room features, housekeeping credits and room sections. The rest of the details except for attached connecting rooms will be copied from the base existing room. Component rooms are not allowed to be copied. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/vacantRoomStatus: get: summary: Get vacant room status configuration. description: Use this API to retrieve vacant room status configuration.

OperationId:getVacantRoomStatus

This API allows a time span of 90 days.

operationId: getVacantRoomStatus parameters: - name: hotelId in: path required: true description: Hotel Code for which vacant room status needs to be fetched. schema: type: string maxLength: 20 minLength: 1 - name: roomTypes in: query required: false description: Room Type of the room. style: form explode: true schema: type: array items: type: string maxItems: 400 - name: beginDate in: query required: false description: The starting value of the date range. By default this would be the current business date. schema: type: string format: date - name: endDate in: query required: false description: The ending value of the date range. schema: type: string format: date - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query 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. schema: type: integer - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Vacant Room Status. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/vacantRoomStatusesList' '204': description: ' Device Configuration List not found.' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create vacant room status configuration. description: Create a new vacant room status for specific room type for a defined date range or number of days or both date range and number of days together.

OperationId:postVacantRoomStatus

operationId: postVacantRoomStatus parameters: - name: hotelId in: path required: true description: Hotel Code for which vacant room status needs to be fetched. schema: type: string maxLength: 20 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/vacantRoomStatusDetails' description: Request object for creating a vacant room housekeeping status details. required: true servers: - url: /rm/config/v1 /hotels/{hotelId}/vacantRoomStatus/{vacantRoomStatusId}: put: summary: Update the vacant room status configuration. description: Update an existing vacant rooms status configuration.

OperationId:putVacantRoomStatus

operationId: putVacantRoomStatus parameters: - name: hotelId in: path required: true description: Hotel Code for which vacant room status needs to be fetched. schema: type: string maxLength: 20 minLength: 1 - name: vacantRoomStatusId in: path required: true description: The unique ID of the vacant room configuration to which this record applies. schema: type: number - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/vacantRoomStatusDetails' description: Request object for creating a vacant room housekeeping details. required: true delete: summary: Delete vacant room status configuration. description: Delete vacant room status configuration.

OperationId:deleteVacantRoomStatus

operationId: deleteVacantRoomStatus parameters: - name: hotelId in: path required: true description: Hotel Code for which vacant room status needs to be fetched. schema: type: string maxLength: 20 minLength: 1 - name: vacantRoomStatusId in: path required: true description: The unique ID of the vacant room configuration to which this record applies. schema: type: number - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /hotels/{sourceHotelId}/buildingGroups/copy: put: summary: Copy Building Groups description: You can use this API to copy existing Housekeeping Building Groups from the source property to the target properties.

OperationId:copyBuildingGroups

operationId: copyBuildingGroups parameters: - name: sourceHotelId in: path required: true description: Unique ID of source hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyBuildingGroups' description: Request object to copy Building Group details to hotel(s). required: true servers: - url: /rm/config/v1 /hotels/{sourceHotelId}/buildings/copy: put: summary: ' copy existing Building from source property to target properties' description: Copy existing Building from source property to target properties.

OperationId:copyBuildings

operationId: copyBuildings parameters: - name: sourceHotelId in: path required: true description: Unique ID of source hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyBuildings' description: Request object for copying Building details to hotel(s). required: true servers: - url: /rm/config/v1 /hotels/{sourceHotelId}/housekeepingSectionGroups/copy: put: summary: ' copy Housekeeping Section Groups' description: Copy Housekeeping Section Groups.

OperationId:copyHousekeepingSectionGroups

operationId: copyHousekeepingSectionGroups parameters: - name: sourceHotelId in: path required: true description: Unique ID of source hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyHousekeepingSectionGroups' description: Request object for copying housekeeping section groups in resort. required: true servers: - url: /rm/config/v1 /hotels/{sourceHotelId}/housekeepingSections/copy: put: summary: ' copy Housekeeping Sections' description: Copy Housekeeping Sections.

OperationId:copyHousekeepingSections

operationId: copyHousekeepingSections parameters: - name: sourceHotelId in: path required: true description: Unique ID of source hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyHousekeepingSections' description: List of the housekeeping section code(s) to be copied. required: true servers: - url: /rm/config/v1 /hotels/{sourceHotelId}/housekeepingSupplyCodes/copy: put: summary: ' copy Housekeeping Codes' description: Copy Housekeeping Codes.

OperationId:copyHousekeepingSupplyCodes

operationId: copyHousekeepingSupplyCodes parameters: - name: sourceHotelId in: path required: true description: Unique ID of source hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyHousekeepingCodes' description: List of the housekeeping code(s) to be copied. required: true servers: - url: /rm/config/v1 /outOfOrderServiceReasons: get: summary: ' Get template Out Of Order Service Reasons' description: ' Use this API to get template Out Of Order Service Reasons.

OperationId:getTemplateOutOfOrderServiceReasons

' operationId: getTemplateOutOfOrderServiceReasons parameters: - name: includeInactive in: query required: false description: Indicator that tells whether to include inactive out of order/service reasons in search results. schema: type: boolean - name: reasonCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching template Out of order/service reason(s). content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateOutOfOrderServiceReasonsDetails' '204': description: TemplateOutOfOrderServiceReasons not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create a template Out Of Order Service Reason Code description: Use this API to create a template Out Of Order Service Reason Code.

OperationId:postTemplateOutOfOrderServiceReasons

operationId: postTemplateOutOfOrderServiceReasons parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateOutOfOrderServiceReasonsCriteria' description: Request object for creating new template out of order/service reasons. required: true servers: - url: /rm/config/v1 /outOfOrderServiceReasons/{reasonCode}: put: summary: Change a template Out Of Order Service Reason Code description: Use this API to update a template Out Of Order Service Reason Code.

OperationId:changeTemplateOutOfOrderServiceReasons

operationId: changeTemplateOutOfOrderServiceReasons parameters: - name: reasonCode in: path required: true description: Unique Code of reason. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateOutOfOrderServiceReasonsToBeChanged' description: Request object for modifying template out of order/service reasons. required: true delete: summary: Delete a template Out Of Order Service Reason Code description: Use this API to delete a template Out Of Order Service Reason Code.

OperationId:removeTemplateOutOfOrderServiceReasons

operationId: removeTemplateOutOfOrderServiceReasons parameters: - name: reasonCode in: path required: true description: Unique Code of reason. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /roomClass: post: summary: Create Room Class Template description: This API is used to create a new room class template.

OperationId:postRoomClassTemplates

operationId: postRoomClassTemplates parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomClassTemplateCriteria' description: Request object for creating a new room class template. required: true servers: - url: /rm/config/v1 /roomClasses: get: summary: Get Room Class Templates description: This API gets the room class templates that match the criteria in the request message.

OperationId:getRoomClassTemplates

operationId: getRoomClassTemplates parameters: - name: roomClassCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for information regarding template room classes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomClassTemplatesDetails' '204': description: RoomClassTemplates not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /roomClasses/{roomClassTemplateId}: put: summary: Change Room Class Template description: This API is used to update an existing room class template.

OperationId:putRoomClassTemplate

operationId: putRoomClassTemplate parameters: - name: roomClassTemplateId in: path required: true description: Unique ID of room class template. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomClassTemplateToBeChanged' description: Request object for modifying an existing room class template. required: true delete: summary: Delete Room Class Template description: Use this API to delete an existing room class template.

OperationId:deleteRoomClassTemplate

operationId: deleteRoomClassTemplate parameters: - name: roomClassTemplateId in: path required: true description: Unique ID of room class template. schema: type: string maxLength: 2000 minLength: 1 - name: roomClass in: query required: false description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /roomConditions: get: summary: Get room condition templates description: Use this API to get room condition templates.

OperationId:getRoomConditionTemplates

operationId: getRoomConditionTemplates parameters: - name: roomConditionCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: inactive in: query required: false schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for information regarding room condition template of a property. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomConditionTemplatesDetails' '204': description: RoomConditionTemplates not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create new room condition template description: Use this API to create new room condition template.

OperationId:postRoomConditionTemplate

operationId: postRoomConditionTemplate parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomConditionTemplateCriteria' description: Request object for creating a new Room Condition Template. required: true servers: - url: /rm/config/v1 /roomConditions/{templateCode}: put: summary: Change room condition template description: Use this API to update a room condition template.

OperationId:changeRoomConditionTemplate

operationId: changeRoomConditionTemplate parameters: - name: templateCode in: path required: true description: Unique Code of template. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomConditionTemplateToBeChanged' description: Request object for Modifying Room Condition Template. required: true delete: summary: Delete room condition template description: Use this API to delete room condition template.

OperationId:removeRoomConditionTemplate

operationId: removeRoomConditionTemplate parameters: - name: templateCode in: path required: true description: Unique Code of template. schema: type: string maxLength: 2000 minLength: 1 - name: roomConditionTemplateCode in: query required: false description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /roomFeatures: get: summary: Get template Room Features description: Use this API to get template Room Features.

OperationId:getTemplateRoomFeatures

operationId: getTemplateRoomFeatures parameters: - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object to fetch template room features. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateRoomFeaturesDetails' '204': description: TemplateRoomFeatures not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create template Room Features description: Use this API to create template Room Features.

OperationId:postTemplateRoomFeatures

operationId: postTemplateRoomFeatures parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateRoomFeaturesCriteria' description: Request object for creating template room features. required: true delete: summary: Delete template Room Features description: Use this API to delete template Room Features.

OperationId:removeTemplateRoomFeatures

operationId: removeTemplateRoomFeatures parameters: - name: genericTemplateParentCodes in: query description: Specifies the code. required: false style: form explode: true schema: type: array items: type: string - name: genericTemplateParentGroups in: query description: Specifies the group. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change template Room Features description: Use this API to update template Room Features.

OperationId:changeTemplateRoomFeatures

operationId: changeTemplateRoomFeatures parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateRoomFeaturesToBeChanged' description: Request object for changing template room features. required: true servers: - url: /rm/config/v1 /roomHierarchies: get: summary: Get Room Hierarchies description: Use this API to get Room Hierarchies.

OperationId:getRoomHierarchies

operationId: getRoomHierarchies parameters: - name: roomHierarchyType in: query required: false description: Provides the type of room hierarchy schema: type: string enum: - Type - Class uniqueItems: true - name: hotelIds in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: fromCode in: query required: false description: From code to process schema: type: string - name: toCode in: query required: false description: To code to process schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch room hierarchies content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomHierarchiesDetails' '204': description: RoomHierarchies not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Room Hierarchies description: Use this API to create Room Hierarchies.

OperationId:postRoomHierarchies

operationId: postRoomHierarchies parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomHierarchiesCriteria' description: Request to create room hierarchies required: true delete: summary: Delete Room Hierarchies description: Use this API to delete Room Hierarchies.

OperationId:removeRoomHierarchies

operationId: removeRoomHierarchies parameters: - name: roomHierarchyType in: query description: Provides the type of room hierarchy required: false style: form explode: true schema: type: array items: type: string enum: - Type - Class uniqueItems: true - name: hotelId in: query description: Resort code in which the hierarchy should exist required: false style: form explode: true schema: type: array items: type: string - name: fromCode in: query description: From code to process required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Room Hierarchies description: Use this API to update Room Hierarchies.

OperationId:changeRoomHierarchies

operationId: changeRoomHierarchies parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomHierarchiesToBeChanged' description: Request to change room hierarchies required: true servers: - url: /rm/config/v1 /roomHierarchies/copy: put: summary: ' copy Room Hierarchies' description: You can use this API to copy Room Hierarchies.

OperationId:copyRoomHierarchies

operationId: copyRoomHierarchies parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyRoomHierarchies' description: Request to copy room hierarchies required: true servers: - url: /rm/config/v1 /roomHierarchies/generate: post: summary: generate the room hierarchies description: Generate the room hierarchies.

OperationId:generateRoomHierarchy

operationId: generateRoomHierarchy parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response for Generate Room Hierarchy content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomHierarchiesDetails' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomHierarchiesToGenerate' description: Generates the room hierarchies based on the AI cost function required: true servers: - url: /rm/config/v1 /roomMaintenanceReasons: get: summary: Get Template Room Maintenance Reasons description: Use this API to get Template Room Maintenance Reasons.

OperationId:getTemplateRoomMaintenanceReasons

operationId: getTemplateRoomMaintenanceReasons parameters: - name: roomMaintenanceReasonCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: includeInactive in: query required: false description: Inactive flag - whether or not to display inactive records schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching template room maintenance reasons. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateRoomMaintenanceReasonsDetails' '204': description: TemplateRoomMaintenanceReasons not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Template Room Maintenance Reasons description: Use this API to create Template Room Maintenance Reasons.

OperationId:postTemplateRoomMaintenanceReasons

operationId: postTemplateRoomMaintenanceReasons parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateRoomMaintenanceReasonsCriteria' description: Request object for creating new template room maintenance reasons. required: true servers: - url: /rm/config/v1 /roomMaintenanceReasons/{reasonCode}: put: summary: Change Template Room Maintenance Reasons description: Use this API to update Template Room Maintenance Reasons.

OperationId:changeTemplateRoomMaintenanceReasons

operationId: changeTemplateRoomMaintenanceReasons parameters: - name: reasonCode in: path required: true description: Unique Code of reason. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateRoomMaintenanceReasonsToBeChanged' description: Request object for modifying template room maintenance reasons. required: true delete: summary: Delete Template Room Maintenance Reasons description: Use this API to delete Template Room Maintenance Reasons.

OperationId:removeTemplateRoomMaintenanceReasons

operationId: removeTemplateRoomMaintenanceReasons parameters: - name: reasonCode in: path required: true description: Unique Code of reason. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /roomSchedules/templates: get: summary: Get housekeeping room schedules configured at template level. description: Use this API to fetch housekeeping room schedule configured at template level for the given search criteria such Room Type, Housekeeping Room Schedule Codes.

OperationId:getTemplateHousekeepingRoomSchedules

operationId: getTemplateHousekeepingRoomSchedules parameters: - name: roomTypeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: housekeepingRoomScheduleCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object of fetch template housekeeping tasks and its associated housekeeping codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateHousekeepingRoomSchedulesDetails' '204': description: Template HousekeepingRoomSchedules not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create housekeeping room schedules at template level description: Use this API to create/configure housekeeping room schedule at template level for a given data like task code,room type,priority,sequence etc., and this operation is supported when either the Task Sheets or the Advance Task Sheets OPERA Control is active.

OperationId:postTemplateHousekeepingRoomSchedule

operationId: postTemplateHousekeepingRoomSchedule parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateHousekeepingRoomSchedulesCriteria' description: Request object to create housekeeping room schedules at template level required: true servers: - url: /rm/config/v1 /roomSchedules/templates/{sequenceId}: put: summary: Change housekeeping room schedules configured at template level description: Use this API to update housekeeping room schedule configured at template level for a given unique sequence ID of the scheduled task and this operation is supported when either the Task Sheets or the Advance Task Sheets OPERA Control is active.

OperationId:changeTemplateHousekeepingRoomSchedule

operationId: changeTemplateHousekeepingRoomSchedule parameters: - name: sequenceId in: path required: true description: Unique sequence number of room scheduled. schema: type: integer minimum: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateHousekeepingRoomSchedulesToBeChanged' description: Request object for changing housekeeping task schedules configured at template level. required: true delete: summary: Delete housekeeping room schedules configured at template level description: Use this API to delete the housekeeping room schedules configured at template level for a given unique sequence ID of the scheduled template task.

OperationId: deleteTemplateHousekeepingRoomSchedule

operationId: deleteTemplateHousekeepingRoomSchedule parameters: - name: sequenceId in: path required: true description: Unique sequence number of room scheduled. schema: type: integer minimum: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /roomTypes: get: summary: Get Room Type Templates description: This API accepts the room type template request search criteria and gets the Room Type templates.

OperationId:getRoomTypeTemplates

operationId: getRoomTypeTemplates parameters: - name: includeInactive in: query required: false description: Include inactive Room type in search result? schema: type: boolean - name: physical in: query required: false description: Is it a physical sleep room type. schema: type: boolean default: 'false' - name: pseudo in: query required: false description: Is it a pseudo room type. schema: type: boolean default: 'false' - name: summaryInfo in: query required: false schema: type: boolean - name: roomTypeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: roomClassCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for information regarding room type template of a property. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomTypeTemplatesDetails' '204': description: RoomTypeTemplates not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Room Type Templates description: This API is used to Use this API to create new Room Type templates.

OperationId:postRoomTypeTemplates

operationId: postRoomTypeTemplates parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomTypeTemplatesCriteria' description: Request object for creating a new Room Type Template. required: true servers: - url: /rm/config/v1 /roomTypes/text: post: summary: Generates the room type description based on the input parameters. description: This API allows you to generate description for room type automatically based on few input parameters.

OperationId:generateRoomTypeDescription

operationId: generateRoomTypeDescription parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/generateRoomTypeDescriptionResponse' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/generateRoomTypeDescriptionRequest' required: true servers: - url: /rm/config/v1 /roomTypes/text/{responseId}: put: summary: Saves the generated room type description to improve quality of room type description generations. description: This API allows you to save the final room type description to improve the auto generation process.

OperationId:putRoomTypeDescription

operationId: putRoomTypeDescription parameters: - name: responseId in: path required: true description: Response Id schema: type: string maxLength: 50 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/saveRoomTypeDescriptionResponse' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/saveRoomTypeDescriptionRequest' required: true servers: - url: /rm/config/v1 /roomTypes/{roomTypeTemplatesId}: put: summary: Change Room Type Templates description: This API is used to update a Room Type template. Use this API to updates can be made concurrently to multiple templates by passing Collection of Room Type templates with the new values.

OperationId:putRoomTypeTemplates

operationId: putRoomTypeTemplates parameters: - name: roomTypeTemplatesId in: path required: true description: Unique ID of room type. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomTypeTemplatesToBeChanged' description: Request object for Modifying existing Room Type Templates. required: true delete: summary: 'Delete new Room Type templates ' description: Use this API to delete new Room Type templates.

OperationId:deleteRoomTypeTemplates

operationId: deleteRoomTypeTemplates parameters: - name: roomTypeTemplatesId in: path required: true description: Unique ID of room type. schema: type: string maxLength: 2000 minLength: 1 - name: roomType in: query required: false description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /roomsSummary: get: summary: Get list of rooms and its summary description: This API returns a list of summary information on hotel rooms based on search criteria such as hotelId, roomClassCodes, roomTypeCodes, roomCodes, wildCard, etc..

OperationId:getRoomsSummary

The maximum allowable limit for this API is 1000.

operationId: getRoomsSummary parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query 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. schema: type: integer default: 0 - name: physical in: query required: false description: Is it a physical room type. schema: type: boolean - name: owner in: query required: false description: Is it a owner room type. schema: type: boolean - name: component in: query required: false description: Is it a component room type. schema: type: boolean - name: pseudo in: query required: false description: Is it a pseudo room type. schema: type: boolean - name: hotelId in: query required: false description: Hotel code of room to be searched. schema: type: string - name: roomClassCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: roomTypeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: roomCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: building in: query required: false description: Building associated with room to be searched. schema: type: string - name: ratingsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching summary information of existing rooms. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomsSummaryDetails' '204': description: RoomsSummary not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /templateFloors: get: summary: Get template floors description: Use this API to get template floors.

OperationId:getTemplateFloors

operationId: getTemplateFloors parameters: - name: floors in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching floors at the template level. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateFloorsDetails' '204': description: TemplateFloors not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create template floors description: Use this API to create template floors.

OperationId:postTemplateFloors

operationId: postTemplateFloors parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateFloorsCriteria' description: Request object for creating floors at the template level. required: true servers: - url: /rm/config/v1 /templateFloors/{templateFloorsId}: put: summary: Change template floors description: Use this API to update template floors.

OperationId:changeTemplateFloors

operationId: changeTemplateFloors parameters: - name: templateFloorsId in: path required: true description: Unique ID of template floors. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateFloorsToBeChanged' description: Request object for changing floors at the template level. required: true delete: summary: Delete template floors description: Use this API to delete template floors.

OperationId:removeTemplateFloors

operationId: removeTemplateFloors parameters: - name: templateFloorsId in: path required: true description: Unique ID of template floors. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rm/config/v1 /templateHousekeepingTasks: get: summary: Get Template Housekeeping Tasks description: Use this API to get template Housekeeping Tasks.

OperationId:getTemplateHousekeepingTasks

operationId: getTemplateHousekeepingTasks parameters: - name: taskCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Flag to indicate if inactive tasks should be included. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching housekeeping tasks. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateHousekeepingTasksDetails' '204': description: HousekeepingTasks not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Template Housekeeping Tasks description: Use this API to create template Housekeeping Tasks.

OperationId:postTemplateHousekeepingTasks

operationId: postTemplateHousekeepingTasks parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateHousekeepingTasksCriteria' description: Add housekeeping tasks configurations for resort. required: true servers: - url: /rm/config/v1 /templateHousekeepingTasks/{templateId}: delete: summary: Delete a template Housekeeping Task description: Use this API to delete a template Housekeeping Task.

OperationId:deleteTemplateHousekeepingTask

operationId: deleteTemplateHousekeepingTask parameters: - name: templateId in: path required: true description: Unique id for template task. schema: type: string maxLength: 2000 minLength: 1 - name: forceRemove in: query required: false description: Flag to indicate if records that are marked as "protected" can be removed. If false, any attempt to remove records that are protected will return an error. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change a template Housekeeping Task description: Use this API to update a template Housekeeping Task.

OperationId:putTemplateHousekeepingTask

operationId: putTemplateHousekeepingTask parameters: - name: templateId in: path required: true description: Unique id for template task schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateHousekeepingTaskToBeChanged' description: Modify housekeeping tasks in resort configurations. required: true servers: - url: /rm/config/v1 /upsert/buildingFloorMappings: put: summary: Set Upsert Hotel level floor mappings to buildings description: You can use this API to set Hotel level floor mappings to buildings.

OperationId:setUpsertBuildingFloorMappings

operationId: setUpsertBuildingFloorMappings parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/setBuildingFloorMappings' description: Request object for setting floor mappings to buildings. required: true servers: - url: /rm/config/v1 /upsert/hotels/{hotelId}/creditRules/{code}: put: summary: Create/Change Housekeeping Credit Rules description: Use this API to create/update housekeeping credit rules for a specific hotel based on code, hotelId, housekeepingCreditRulesToBeChanged.

Housekeeping credit rules are used to add additional credits to the housekeeping tasks sheets depending on configured values i.e. travel credits between buildings, or floors, or inventory items i.e. cribs, rollaways.

OperationId:changeUpsertHousekeepingCreditRules

operationId: changeUpsertHousekeepingCreditRules parameters: - name: code in: path required: true description: Unique ID of rule code. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/housekeepingCreditRulesToBeChanged' description: Request object for changing housekeeping credit rules. required: true servers: - url: /rm/config/v1 /upsert/hotels/{hotelId}/rooms/{roomsId}: put: summary: Create/Change an existing room description: Use this API to create/update an existing room.

OperationId:putUpsertRooms

operationId: putUpsertRooms parameters: - name: roomsId in: path required: true description: Unique ID of room. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomToBeChanged' description: Request object for changing details of an existing room. required: true servers: - url: /rm/config/v1 /upsert/roomHierarchies: put: summary: Create/Change Room Hierarchies description: Use this API to Create/update Room Hierarchies.

OperationId:changeUpsertRoomHierarchies

operationId: changeUpsertRoomHierarchies parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomHierarchiesToBeChanged' description: Request to change room hierarchies required: true servers: - url: /rm/config/v1 /cancelpolicies: get: summary: Get Cancellation policies in hotel level description: Use this API to get Cancellation policies in hotel level.

OperationId:getCancellationPolicy

operationId: getCancellationPolicy parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: policyCodeListCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Indicator that tells whether to include inactive in search results. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch Cancellation Policies. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cancellationPolicyDetails' '204': description: CancellationPolicy not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /cancelpolicy/{cancelpolicycode}: post: summary: Create Cancellation policies in hotel level description: Use this API to create Cancellation policies in hotel level.

OperationId:postCancellationPolicy

operationId: postCancellationPolicy parameters: - name: cancelpolicycode in: path required: true description: Unique Code of policy. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cancellationPolicyCriteria' description: Request object that holds the details of Cancellation Policy to be created. required: true delete: summary: Delete Cancellation policies in hotel level description: Use this API to delete Cancellation policies in hotel level.

OperationId:deleteCancellationPolicy

operationId: deleteCancellationPolicy parameters: - name: cancelpolicycode in: path required: true description: Unique Code of policy. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: query required: true description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Cancellation policies in hotel level description: Use this API to update Cancellation policies in hotel level.

OperationId:changeCancellationPolicy

operationId: changeCancellationPolicy parameters: - name: cancelpolicycode in: path required: true description: Unique Code of policy. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cancellationPolicyToBeChanged' description: Request object that holds the details of Cancellation Policy to be changed. required: true servers: - url: /rsv/config/v1 /cancelpolicytemplate/{cancelpolicytemplate}: post: summary: Create template Cancellation policies description: Use this API to create template Cancellation policies.

OperationId:postTemplateCancellationPolicy

operationId: postTemplateCancellationPolicy parameters: - name: cancelpolicytemplate in: path required: true description: Unique Code of policy template. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateCancellationPolicyCriteria' description: Request object that holds the details of template Cancellation Policy to be created. required: true delete: summary: Delete template Cancellation policies description: Use this API to delete template Cancellation policies.

OperationId:deleteTemplateCancellationPolicy

operationId: deleteTemplateCancellationPolicy parameters: - name: cancelpolicytemplate in: path required: true description: Unique Code of policy template. schema: type: string maxLength: 2000 minLength: 1 - name: policyCode in: query required: false description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change template Cancellation policies description: Use this API to update template Cancellation policies.

OperationId:changeTemplateCancellationPolicy

operationId: changeTemplateCancellationPolicy parameters: - name: cancelpolicytemplate in: path required: true description: Unique Code of policy template. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateCancellationPolicyToBeChanged' description: Request object that holds the details of template Cancellation Policy to be changed. required: true servers: - url: /rsv/config/v1 /cancelpolicytemplates: get: summary: Get template Cancellation policies description: Use this API to get template Cancellation policies.

OperationId:getTemplateCancellationPolicy

operationId: getTemplateCancellationPolicy parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: policyCodeListCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Indicator that tells whether to include inactive in search results. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch template Cancellation Policies. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateCancellationPolicyDetails' '204': description: TemplateCancellationPolicy not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /depositpolicies: get: summary: Get deposit policies in hotel level description: Use this API to get deposit policies in hotel level.

OperationId:getDepositPolicy

operationId: getDepositPolicy parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: policyCodeListCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Indicator that tells whether to include inactive in search results. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch Deposit Policies in hotel level. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/depositPolicyDetails' '204': description: DepositPolicy not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /depositpolicy/{depositpolicycode}: post: summary: Create deposit policy in hotel level description: Use this API to create deposit policy in hotel level.

OperationId:postDepositPolicy

operationId: postDepositPolicy parameters: - name: depositpolicycode in: path required: true description: Unique Code of deposit policy. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/depositPolicyCriteria' description: Request object that holds the details of hotel level Deposit Policy to be created. required: true delete: summary: Delete deposit policy in hotel level description: Use this API to delete deposit policy in hotel level.

OperationId:deleteDepositPolicy

operationId: deleteDepositPolicy parameters: - name: depositpolicycode in: path required: true description: Unique Code of deposit policy. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: query required: true description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change deposit policy in hotel level description: Use this API to update deposit policy in hotel level.

OperationId:changeDepositPolicy

operationId: changeDepositPolicy parameters: - name: depositpolicycode in: path required: true description: Unique Code of deposit policy. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/depositPolicyToBeChanged' description: Request object that holds the details of hotel level Deposit Policy to be changed. required: true servers: - url: /rsv/config/v1 /depositpolicytemplate/{depositpolicytemplate}: post: summary: Create template deposit policy description: Use this API to create template deposit policy.

OperationId:postTemplateDepositPolicy

operationId: postTemplateDepositPolicy parameters: - name: depositpolicytemplate in: path required: true description: Unique Code of deposit policy template. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateDepositPolicyCriteria' description: Request object that holds the details of template Deposit Policy to be created. required: true put: summary: Change template deposit policy description: Use this API to update template deposit policy.

OperationId:changeTemplateDepositPolicy

operationId: changeTemplateDepositPolicy parameters: - name: depositpolicytemplate in: path required: true description: Unique Code of deposit policy template. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateDepositPolicyToBeChanged' description: Request object that holds the details of template Deposit Policy to be changed. required: true delete: summary: Delete template deposit policy description: Use this API to delete template deposit policy.

OperationId:deleteTemplateDepositPolicy

operationId: deleteTemplateDepositPolicy parameters: - name: depositpolicytemplate in: path required: true description: Unique Code of deposit policy template. schema: type: string maxLength: 2000 minLength: 1 - name: policyCode in: query required: false description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /depositpolicytemplates: get: summary: Get template deposit policies description: Use this API to get template deposit policies.

OperationId:getTemplateDepositPolicy

operationId: getTemplateDepositPolicy parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: policyCodeListCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Indicator that tells whether to include inactive in search results. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch template Deposit Policies. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateDepositPolicyDetails' '204': description: TemplateDepositPolicy not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /guaranteeCodeTemplates: get: summary: Get template Guarantee Codes description: Use this API to get template Guarantee Codes.

OperationId:getTemplateGuaranteeCodes

operationId: getTemplateGuaranteeCodes parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: guaranteeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: inactive in: query required: false description: Is Guarantee Code Inactive? schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch template Guarantee Codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateGuaranteeCodesDetails' '204': description: TemplateGuaranteeCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /guaranteeCodeTemplates/{guaranteeCode}: post: summary: Create template Guarantee Code description: Use this API to create template Guarantee Code.

OperationId:postTemplateGuaranteeCode

operationId: postTemplateGuaranteeCode parameters: - name: guaranteeCode in: path required: true description: Unique Code of Guarantee. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateGuaranteeCodeCriteria' description: Request object that holds the details of template Guarantee Code to be created. required: true delete: summary: Delete template Guarantee Code description: Use this API to delete template Guarantee Code.

OperationId:deleteTemplateGuaranteeCode

operationId: deleteTemplateGuaranteeCode parameters: - name: guaranteeCode in: path required: true description: Unique Code of Guarantee. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change template Guarantee Code description: Use this API to update template Guarantee Code.

OperationId:changeTemplateGuaranteeCode

operationId: changeTemplateGuaranteeCode parameters: - name: guaranteeCode in: path required: true description: Unique Code of Guarantee. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateGuaranteeCodeToBeChanged' description: Request object that holds the details of template Guarantee Code to be changed. required: true servers: - url: /rsv/config/v1 /guaranteeCodes: get: summary: Get Guarantee Codes description: Use this API to get Guarantee Codes.

OperationId:getGuaranteeCodes

operationId: getGuaranteeCodes parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: hotelIds in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: guaranteeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: inactive in: query required: false description: Is Guarantee Code Inactive? schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch Guarantee Codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/guaranteeCodesDetails' '204': description: GuaranteeCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Guarantee Code description: Use this API to create Guarantee Code.

OperationId:postGuaranteeCode

operationId: postGuaranteeCode parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/guaranteeCodeCriteria' description: Request object that holds the details of Guarantee Code to be created. required: true servers: - url: /rsv/config/v1 /guaranteeCodes/{guaranteeCode}: put: summary: Change Guarantee Code description: Use this API to update Guarantee Code.

OperationId:changeGuaranteeCode

operationId: changeGuaranteeCode parameters: - name: guaranteeCode in: path required: true description: Unique Code of guarantee. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/guaranteeCodeToBeChanged' description: Request object that holds the details of Guarantee Code to be changed. required: true delete: summary: Delete Guarantee Code description: Use this API to delete Guarantee Code.

OperationId:deleteGuaranteeCode

operationId: deleteGuaranteeCode parameters: - name: guaranteeCode in: path required: true description: Unique Code of guarantee. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: query required: false description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /hotels/{hotelId}/guaranteeCodeSchedules: post: summary: 'Create schedule for guarantee codes ' description: Use this API to create schedule for guarantee codes.

OperationId:postGuaranteeCodeSchedule

operationId: postGuaranteeCodeSchedule parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/guaranteeCodeScheduleCriteria' description: Creates the Guarantee Code schedule based on the details provided by the request. required: true get: summary: 'Get schedules for guarantee codes ' description: Use this API to get schedules for guarantee codes.

OperationId:getGuaranteeCodeSchedules

operationId: getGuaranteeCodeSchedules parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: List of Hotels. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: ratePlanCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: duration in: query required: false schema: type: string - name: guaranteeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: creditRatingsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: seasonsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: inactive in: query required: false description: Is schedule Inactive? schema: type: boolean - name: override in: query required: false description: When set to true only schedules marked as Override will be returned. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Return response for fetch guarantee code schedules based on request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/guaranteeCodeSchedulesDetails' '204': description: GuaranteeCodeSchedules not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /hotels/{hotelId}/guaranteeCodeSchedules/{policyScheduleId}: put: summary: 'Change an schedule for guarantee codes ' description: Use this API to update an schedule for guarantee codes.

OperationId:changeGuaranteeCodeSchedule

operationId: changeGuaranteeCodeSchedule parameters: - name: policyScheduleId in: path required: true description: Unique ID of policy schedule. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Return object for change Guarantee Code schedule. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/guaranteeCodeScheduleToBeChanged' description: Changes the Guarantee Code schedule based on the details provided by the request. required: true delete: summary: 'Delete schedule for guarantee codes ' description: Use this API to delete schedule for guarantee codes.

OperationId:deleteGuaranteeCodeSchedule

operationId: deleteGuaranteeCodeSchedule parameters: - name: policyScheduleId in: path required: true description: Unique ID of policy schedule. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: idContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: type in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /hotels/{hotelId}/guaranteeCodeSchedules/{policyScheduleId}/copy: put: summary: 'Copy schedule s for guarantee codes ' description: Use this APU to copy schedules for guarantee codes.

OperationId:copyGuaranteeCodeSchedules

operationId: copyGuaranteeCodeSchedules parameters: - name: policyScheduleId in: path required: true description: Unique ID of policy schedule. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Return response for copy Guarantee Code schedules. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyGuaranteeCodeSchedules' description: Request object that provides the criteria to copy Guarantee Code schedules to different hotels. required: true servers: - url: /rsv/config/v1 /hotels/{hotelId}/marketCodes/{marketcode}: post: summary: Create a new Market Code description: Use this API to create a new Market Code.

OperationId:postMarketCode

operationId: postMarketCode parameters: - name: marketcode in: path required: true description: Unique Code of market. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/marketCodeCriteria' description: Request object that holds the details of Market Code to be created. required: true delete: summary: 'Delete a Market Code ' description: Use this API to delete a Market Code .

OperationId:removeMarketCode

operationId: removeMarketCode parameters: - name: marketcode in: path required: true description: Unique Code of market. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: 'Modify a Market Code ' description: You can use this API to modify a Market Code .

OperationId:changeMarketCode

operationId: changeMarketCode parameters: - name: marketcode in: path required: true description: Unique Code of market. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: forceOverride in: query description: Query param to override the property overridden configuration from EM. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/marketCodeToBeChanged' description: Request object that holds the details of Market Code to be changed. required: true servers: - url: /rsv/config/v1 /hotels/{hotelId}/marketGroups/{marketGroupCode}: post: summary: Create Market Group description: Use this API to create a new Market Group. Only one Market Code can be created at a time.

OperationId:postMarketGroup

operationId: postMarketGroup parameters: - name: marketGroupCode in: path required: true description: Unique Code of market group. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/marketGroupCriteria' description: Request object that holds the details of Market Group to be created. required: true put: summary: Change Market Group description: Use this API to modify a Market Group. Only one Market Group can be modified at a time.

OperationId:changeMarketGroup

operationId: changeMarketGroup parameters: - name: marketGroupCode in: path required: true description: Unique Code of market group. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/marketGroupToBeChanged' description: Request object that holds the details of Market Group to be changed. required: true delete: summary: 'Delete a Market Group ' description: Use this API to delete a Market Group .

OperationId:removeMarketGroup

operationId: removeMarketGroup parameters: - name: marketGroupCode in: path required: true description: Unique Code of market group. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /hotels/{hotelId}/policyschedules: get: summary: Get Policy Schedules description: Use this API to get schedules for deposit or cancel policies.

OperationId:getPolicySchedules

operationId: getPolicySchedules parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: List of Hotels. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: policyType in: query required: false description: Simple type for Policy type. schema: type: string enum: - Deposit - Cancellation uniqueItems: true - name: ratePlanCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: policyCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: duration in: query required: false schema: type: string - name: guaranteeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: creditRatingsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: seasonsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: id 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. schema: type: string - name: idContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: type in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: inactive in: query required: false description: Is schedule Inactive? schema: type: boolean - name: override in: query required: false description: When set to true only schedules marked as Override will be returned. schema: type: boolean - name: housePolicies in: query required: false description: When set to true only schedules which are house policies will be returned. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Return response for fetch policy schedules based on request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/policySchedulesDetails' '204': description: PolicySchedules not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create a Policy Schedule description: Use this API to create schedule for deposit or cancel policy.

OperationId:postNewPolicySchedule

operationId: postNewPolicySchedule parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/policyScheduleCriteria' description: Creates the Policy schedule based on the details provided by the request. required: true servers: - url: /rsv/config/v1 /hotels/{hotelId}/policyschedules/{policyscheduleId}: post: summary: Create a Policy Schedule description: Use this API to create schedule for deposit or cancel policy.

This API is deprecated. Please use createNewPolicySchedule instead

OperationId:postPolicySchedule

operationId: postPolicySchedule deprecated: true parameters: - name: policyscheduleId in: path required: true description: Unique ID of policy schedule. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/policyScheduleCriteria' description: Creates the Policy schedule based on the details provided by the request. required: true put: summary: Change a Policy Schedule description: Use this API to update an schedule for deposit or cancel policy.

OperationId:changePolicySchedule

operationId: changePolicySchedule parameters: - name: policyscheduleId in: path required: true description: Unique ID of policy schedule. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Return object for change policy schedule. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/policyScheduleToBeChanged' description: Changes the Policy schedule based on the details provided by the request. required: true delete: summary: Delete Policy Schedule description: Use this API to delete schedule for deposit or cancel policy.

OperationId:deletePolicySchedule

operationId: deletePolicySchedule parameters: - name: policyscheduleId in: path required: true description: Unique ID of policy schedule. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: idContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: type in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /hotels/{hotelId}/policyschedules/{policyscheduleId}/copy: put: summary: Copy a Policy Schedule description: Use this APU to copy schedules for deposit or cancel policy.

OperationId:copyPolicySchedules

operationId: copyPolicySchedules parameters: - name: policyscheduleId in: path required: true description: Unique ID of policy schedule. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Return response for copy policy schedules. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyPolicySchedules' description: Request object that provides the criteria to copy policy schedules to different hotels. required: true servers: - url: /rsv/config/v1 /hotels/{hotelId}/precheckinRules: get: summary: Get Pre Check In rules description: Use this API to get Pre Check In rules.

OperationId:getPreCheckInRules

operationId: getPreCheckInRules parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: date in: query required: false description: Date from which rule type is affected schema: type: string format: date - name: ruleType in: query required: false description: The rule type on which the Internet Pre Check-In Rule is based. If a reservation has any of the following code, Pre CheckIn rule gets active for that reservation schema: type: string enum: - Specials - MarketCodes - TimeLimit - RatePlans - ReservationTypes - VIPCodes - Memberships - OriginCodes uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for information regarding Pre Check-In Rule content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/preCheckInRulesDetails' '204': description: PreCheckInRules not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Pre Check In rules description: Use this API to update Pre Check In rules.

OperationId:changePreCheckInRules

operationId: changePreCheckInRules parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/preCheckInRulesToBeChanged' description: Request object for modifying an existing Pre Check-In Rule required: true delete: summary: Delete Pre Check In rules description: Use this API to delete Pre Check In rules.

OperationId:removePreCheckInRules

operationId: removePreCheckInRules parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: ruleType in: query description: The rule type on which the Internet Pre Check-In Rule is based. If a reservation has any of the following code, Pre CheckIn rule gets active for that reservation required: false style: form explode: true schema: type: array items: type: string enum: - Specials - MarketCodes - TimeLimit - RatePlans - ReservationTypes - VIPCodes - Memberships - OriginCodes uniqueItems: true - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: duration in: query required: false schema: type: string - name: newStartDate in: query required: false schema: type: string format: date - name: newEndDate in: query required: false schema: type: string format: date - name: newDuration in: query required: false schema: type: string - name: level in: query description: Description type for Rule Details required: false style: form explode: true schema: type: array items: type: string - name: type in: query description: Code type for Rule Details required: false style: form explode: true schema: type: array items: type: string - name: specialsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: marketCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: absoluteFlag in: query required: false description: Absolute Flag value for Time Limit Rule. schema: type: boolean - name: endTime in: query required: false description: The latest possible Internet check-in time for a reservation based on the Time rule type schema: type: string - name: startTime in: query required: false description: The earliest possible Internet check-in time for a reservation based on the Time rule type schema: type: string - name: daysBeforeArrival in: query required: false description: The number of days before the arrival date that the reservation can be checked in through the Internet. A zero will mean the day of arrival schema: type: integer - name: daysAfterBooking in: query required: false description: The number of days after the booking date that the reservation can be checked in over the Internet schema: type: integer - name: hoursPriorToCheckIn in: query required: false description: Enter the number of hours before the property's official check-in time that the reservation will be eligible for Internet check in schema: type: integer - name: hoursPostCheckIn in: query required: false description: Enter the number of hours after the property's official check-in time that the reservation will be eligible for Internet check in schema: type: integer - name: ratePlansCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: reservationTypesCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: vIPCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: originCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Pre Check In rules description: Use this API to create Pre Check In rules.

OperationId:postPreCheckInRules

operationId: postPreCheckInRules parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/preCheckInRulesCriteria' description: Request object for creating a Pre Check-In Rule required: true servers: - url: /rsv/config/v1 /hotels/{hotelId}/serviceRequestCodes: get: summary: Get service request codes description: Use this API to get service request codes.

This API is deprecated. Please use getServiceRequestCode instead

OperationId:getServiceRequestCodes

operationId: getServiceRequestCodes deprecated: true parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: serviceRequestCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: inactive in: query required: false description: This flag consider inactive/active Service Request codes to search for. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching the service request codes for given search criteria hotel, code, active/inactive. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/serviceRequestCodesDetails' '204': description: ServiceRequestCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create service request codes description: Use this API to create service request codes.

OperationId:postServiceRequestCodes

operationId: postServiceRequestCodes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/serviceRequestCodesCriteria' description: Request object for creating new service request codes. required: true delete: summary: Delete configuration service request codes description: Use this API to delete configuration service request codes.

OperationId:removeServiceRequestCodes

operationId: removeServiceRequestCodes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: serviceRequestCode in: query description: Service request code. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change configuration service request codes description: Use this API to update configuration service request codes.

OperationId:changeServiceRequestCodes

operationId: changeServiceRequestCodes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/serviceRequestCodesToBeChanged' description: Request object for changing existing service request codes. required: true servers: - url: /rsv/config/v1 /hotels/{hotelId}/serviceRequestCodes/{serviceRequestCode}/priorities: get: summary: Get Service Request Code Priorities description: Use this API to get Service Request Code Priorities.

This API is deprecated. Please use getServiceRequestCodePriority instead

OperationId:getServiceRequestCodePriorities

operationId: getServiceRequestCodePriorities deprecated: true parameters: - name: serviceRequestCode in: path required: true description: Unique Code of service request. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: fetchInactive in: query required: false description: Determines wether to fetch inactive records or not. schema: type: boolean - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Service Request Code Priorities. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/serviceRequestCodePrioritiesDetails' '204': description: ServiceRequestCodePriorities not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Service Request Code Priorities description: Use this API to update Service Request Code Priorities.

OperationId:changeServiceRequestCodePriorities

operationId: changeServiceRequestCodePriorities parameters: - name: serviceRequestCode in: path required: true description: Unique Code of service request. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/serviceRequestCodePrioritiesToBeChanged' description: Request object for changing Service Request Code Priorities. required: true delete: summary: Delete Service Request Code Priorities description: Use this API to delete Service Request Code Priorities.

OperationId:removeServiceRequestCodePriorities

operationId: removeServiceRequestCodePriorities parameters: - name: serviceRequestCode in: path required: true description: Unique Code of service request. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Service Request Code Priorities description: Use this API to create Service Request Code Priorities.

OperationId:postServiceRequestCodePriorities

operationId: postServiceRequestCodePriorities parameters: - name: serviceRequestCode in: path required: true description: Unique Code of service request. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/serviceRequestCodePrioritiesCriteria' description: Request object for creating Service Request Code Priorities. required: true servers: - url: /rsv/config/v1 /hotels/{hotelId}/sourceCodes/: get: summary: Get Source Codes description: Use this API to search for Source Codes based on criteria.

OperationId:getSourceCodes

operationId: getSourceCodes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: List of Hotels. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: sourceCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: sourceGroupsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Include inactive Source Codes or not. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch Source Codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/sourceCodesDetails' '204': description: SourceCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create a Source Code description: Use this API to create a new Source Code. Only one Source Code can be Use this API to created at a time.

OperationId:postSourceCode

operationId: postSourceCode parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/sourceCodeCriteria' description: Request object that holds the details of Source Code to be created. required: true servers: - url: /rsv/config/v1 /hotels/{hotelId}/sourceCodes/{sourceCode}: put: summary: Update a Source Code description: Use this API to modify a Source Code. Only one Source Code can be modified at a time.

OperationId:changeSourceCode

operationId: changeSourceCode parameters: - name: sourceCode in: path required: true description: Unique Code of source. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/sourceCodeToBeChanged' description: Request object that holds the details of Source Code to be changed. required: true delete: summary: Delete a Source Code description: Use this API to remove a Source Code. Only one Source Code can be Use this API to removed at a time.

OperationId:removeSourceCode

operationId: removeSourceCode parameters: - name: sourceCode in: path required: true description: Unique Code of source. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /hotels/{hotelId}/sourceGroups: get: summary: 'Search for Source Groups ' description: Search for Source Groups.

OperationId:getSourceGroups

operationId: getSourceGroups parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: List of Hotels. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: sourceCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: sourceGroupsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Include inactive Source Groups or not. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch Source Groups. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/sourceGroupsDetails' '204': description: SourceGroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create a Source Group description: This API is used to create a new Source Group. Only one Source Code can be Use this API to created at a time.

OperationId:postSourceGroup

operationId: postSourceGroup parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/sourceGroupCriteria' description: Request object that holds the details of Source Group to be created. required: true servers: - url: /rsv/config/v1 /hotels/{hotelId}/sourceGroups/{sourceGroupCode}: put: summary: Change a Source Group description: This API is used to modify a Source Group. Only one Source Group can be modified at a time.

OperationId:changeSourceGroup

operationId: changeSourceGroup parameters: - name: sourceGroupCode in: path required: true description: Unique Code of source group. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/sourceGroupToBeChanged' description: Request object that holds the details of Source Group to be changed. required: true delete: summary: Delete a Source Group description: Use this API to delete a Source Group. Only one Source Group can be Use this API to deleted at a time.

OperationId:removeSourceGroup

operationId: removeSourceGroup parameters: - name: sourceGroupCode in: path required: true description: Unique Code of source group. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /hotels/{sourceHotelId}/serviceRequestCodes/copy: put: summary: ' copy configuration service request codes' description: Copy configuration service request codes.

OperationId:copyServiceRequestCodes

operationId: copyServiceRequestCodes parameters: - name: sourceHotelId in: path required: true description: Unique ID of source hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyServiceRequestCodes' description: List of the template service request code(s) to be copied. required: true servers: - url: /rsv/config/v1 /marketCodeTemplates: get: summary: Search for Market codes Template description: This API is used to search for a Template Market Code. .

OperationId:getTemplateMarketCodes

operationId: getTemplateMarketCodes parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: templateMarketCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: templateMarketGroupsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: fetch inactive Market Codes. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch template Market Codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateMarketCodesDetails' '204': description: TemplateMarketCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Market Code Template description: This API is used to create a new Template Market Code. Only one template Market Code can be Use this API to created at a time.

OperationId:postTemplateMarketCode

operationId: postTemplateMarketCode parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateMarketCodeCriteria' description: Request object that holds the details of template Market Code to be created. required: true servers: - url: /rsv/config/v1 /marketCodeTemplates/{marketcode}: put: summary: Update a Market Code Template description: This API is used to modify a template Market Code. Only one template Market Code can be modified at a time.

OperationId:changeTemplateMarketCode

operationId: changeTemplateMarketCode parameters: - name: marketcode in: path required: true description: Unique Code of market. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateMarketCodeToBeChanged' description: Request object that holds the details of template Market Code to be changed. required: true delete: summary: Delete a Market Code Template description: This API is used to delete a Template Market Code. .

OperationId:removeTemplateMarketCode

operationId: removeTemplateMarketCode parameters: - name: marketcode in: path required: true description: Unique Code of market. schema: type: string maxLength: 2000 minLength: 1 - name: templateMarketCode in: query required: false description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /marketCodes: get: summary: Get Market codes description: Use this API to get Market codes.

OperationId:getMarketCodes

operationId: getMarketCodes parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: hotelIds in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: marketCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: marketGroupsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Search inactive Market Codes. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch Market Codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/marketCodesDetails' '204': description: MarketCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /marketGroupTemplate/{marketGroupCode}: post: summary: Create Market Group Template description: This API is used to create a new Template Market Group. Only one template Market Group can be Use this API to created at a time.

OperationId:postTemplateMarketGroup

operationId: postTemplateMarketGroup parameters: - name: marketGroupCode in: path required: true description: Unique Code of market group. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateMarketGroupCriteria' description: Request object that holds the details of template Market Group to be created. required: true delete: summary: Delete market Group Template description: You can use this API to delete a template Market Group.

OperationId:removeTemplateMarketGroup

operationId: removeTemplateMarketGroup parameters: - name: marketGroupCode in: path required: true description: Unique Code of market group. schema: type: string maxLength: 2000 minLength: 1 - name: templateMarketGroup in: query required: false description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Market Group Template description: This API is used to modify a Template Market Group. Only one Template Market Group can be modified at a time.

OperationId:changeTemplateMarketGroup

operationId: changeTemplateMarketGroup parameters: - name: marketGroupCode in: path required: true description: Unique Code of market group. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateMarketGroupToBeChanged' description: Request object that holds the details of template Market Group to be changed. required: true servers: - url: /rsv/config/v1 /marketGroupTemplates: get: summary: Get Market Group Templates description: Use this API to get Market Group Templates.

OperationId:getTemplateMarketGroups

The maximum allowable limit for this API is _.

operationId: getTemplateMarketGroups parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: templateMarketCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: templateMarketGroupsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Include inactive template Market Groups or not. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch template Market Groups. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateMarketGroupsDetails' '204': description: TemplateMarketGroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /marketGroups: get: summary: 'Get Market Groups ' description: This API is used to search for a Market Group. .

OperationId:getMarketGroups

operationId: getMarketGroups parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: hotelIds in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: marketCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: marketGroupsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Include inactive Market Groups or not. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch Market Groups. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/marketGroupsDetails' '204': description: MarketGroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /serviceRequestCodes: get: summary: Get service request codes description: Use this API to get service request codes.

OperationId:getServiceRequestCode

operationId: getServiceRequestCode parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: hotelIds in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: serviceRequestCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: inactive in: query required: false description: This flag consider inactive/active Service Request codes to search for. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching the service request codes for given search criteria hotel, code, active/inactive. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/serviceRequestCodesDetails' '204': description: ServiceRequestCode not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /serviceRequestCodes/priorities: get: summary: Get Service Request Code Priorities description: Use this API to get Service Request Code Priorities.

OperationId:getServiceRequestCodePriority

operationId: getServiceRequestCodePriority parameters: - name: fetchInactive in: query required: false description: Determines wether to fetch inactive records or not. schema: type: boolean - name: serviceRequestCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the code. schema: type: string - name: hotelIds in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Service Request Code Priorities. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/serviceRequestCodePrioritiesDetails' '204': description: ServiceRequestCodePriority not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /templates/sourceCodes: get: summary: Get template Source Codes description: Use this API to get template Source Codes.

OperationId:getTemplateSourceCodes

operationId: getTemplateSourceCodes parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: templateSourceCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: templateSourceGroupsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Include inactive template Source Codes or not. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch template Source Codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateSourceCodesDetails' '204': description: TemplateSourceCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create a Template Source Code description: Use this API to create a new Template Source Code. Only one template Source Code can be created at a time.

OperationId:postTemplateSourceCode

operationId: postTemplateSourceCode parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateSourceCodeCriteria' description: Request object that holds the details of template Source Code to be created. required: true servers: - url: /rsv/config/v1 /templates/sourceCodes/{sourceCode}: put: summary: Change a Template Source Code description: Use this API to Modify a Template Source Code. Only one Template Source Code can be modified at a time.

OperationId:changeTemplateSourceCode

operationId: changeTemplateSourceCode parameters: - name: sourceCode in: path required: true description: Unique Code of source. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateSourceCodeToBeChanged' description: Request object that holds the details of template Source Code to be changed. required: true delete: summary: Delete a Template Source Code description: ' Use this API to remove a Template Source Code.

OperationId:removeTemplateSourceCode

' operationId: removeTemplateSourceCode parameters: - name: sourceCode in: path required: true description: Unique Code of source. schema: type: string maxLength: 2000 minLength: 1 - name: templateSourceCode in: query required: false description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rsv/config/v1 /templates/sourceGroups: get: summary: Get Template Source Groups description: This API allows you to search for Template Source Groups based on the search criteria in the request.

OperationId:getTemplateSourceGroups

operationId: getTemplateSourceGroups parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: pageNumber in: query 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. schema: type: integer - name: templateSourceCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: templateSourceGroupsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Include inactive template Source Groups or not. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch template Source Groups. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateSourceGroupsDetails' '204': description: TemplateSourceGroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Template Source Group description: Use this API to Modify a Template Source Group. Only one Template Source Group can be modified at a time.

OperationId:changeTemplateSourceGroup

operationId: changeTemplateSourceGroup parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateSourceGroupToBeChanged' description: Request object that holds the details of template Source Group to be changed. required: true delete: summary: Delete a Template Source Group description: ' Use this API to remove a Template Source Group.

OperationId:removeTemplateSourceGroup

' operationId: removeTemplateSourceGroup parameters: - name: templateSourceGroup in: query required: false description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create a Template Source Group description: Use this API to create a new Template Source Group. Only one template Source Group can be created at a time.

OperationId:postTemplateSourceGroup

operationId: postTemplateSourceGroup parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateSourceGroupCriteria' description: Request object that holds the details of template Source Group to be created. required: true servers: - url: /rsv/config/v1 /upsert/hotels/{hotelId}/guaranteeCodeSchedules: put: summary: 'Create/Change an schedule for guarantee codes ' description: Use this API to create/update an schedule for guarantee codes.

OperationId:changeUpsertGuaranteeCodeSchedule

operationId: changeUpsertGuaranteeCodeSchedule parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Return object for change Guarantee Code schedule. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/guaranteeCodeScheduleToBeChanged' description: Changes the Guarantee Code schedule based on the details provided by the request. required: true servers: - url: /rsv/config/v1 /upsert/hotels/{hotelId}/policyschedules: put: summary: CCreate/hange a Policy Schedule description: Use this API to create/update an schedule for deposit or cancel policy.

OperationId:changeUpsertPolicySchedule

operationId: changeUpsertPolicySchedule parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Return object for change policy schedule. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/policyScheduleToBeChanged' description: Changes the Policy schedule based on the details provided by the request. required: true servers: - url: /rsv/config/v1 /hotels/{hotelId}/rateCategories: get: summary: Get Rate Category description: Search for Rate Categories. The search criteria can include a Rate category, the list of hotel Codes and the description of the Rate Category.

OperationId:getRateCategory

The maximum allowable limit for this API is 1000.

operationId: getRateCategory parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query 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. schema: type: integer default: 0 - name: rateCategoryListCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: rateCategoryDescription in: query required: false description: Rate Category description. Partial description searches are considered. schema: type: string - name: includeInactive in: query required: false description: Indicator that tells whether inactive rate category should be included in fetch result. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Rate Categories for a property. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/rateCategoryDetails' '204': description: RateCategory not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Rate Category description: This API can be used to Use this API to create a Rate Category e.g. RACK. Only one rate category can be Use this API to created at a time.

OperationId:postRateCategory

operationId: postRateCategory parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/rateCategoryCriteria' description: Request object for Creating a new Rate Category for a property. required: true delete: summary: Delete Rate Category description: Use this delete a Rate Category e.g. RACK.

OperationId:deleteRateCategory

operationId: deleteRateCategory parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: rateCategory in: query required: false description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig put: summary: Change Rate Category description: This API can be used to Modify a Rate Category e.g. RACK. Only one rate category can be modified at a time.

OperationId:changeRateCategory

operationId: changeRateCategory parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/rateCategoryToBeChanged' description: Request object for modifying a Rate Category for a property. required: true servers: - url: /rtp/v1 /hotels/{hotelId}/rateClasses: get: summary: Get rate classes description: Use this API to get rate classes.

OperationId:getRateClass

The maximum allowable limit for this API is 1000.

operationId: getRateClass parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query 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. schema: type: integer default: 0 - name: rateClassListCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: description in: query required: false description: Description of the rate class. schema: type: string - name: includeInactive in: query required: false description: Indicator which tells whether inactive rate class to be included or not. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch rate classes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/rateClassDetails' '204': description: RateClass not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create new rate class description: Use this API to create new rate class.

OperationId:postRateClass

operationId: postRateClass parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/rateClassCriteria' description: Request to create new rate class. required: true servers: - url: /rtp/v1 /hotels/{hotelId}/rateClasses/{rateClassCode}: put: summary: Changes to rate class description: Use this API to updates to rate class.

OperationId:changeRateClass

operationId: changeRateClass parameters: - name: rateClassCode in: path required: true description: Unique Code of rate class. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/rateClassToBeChanged' description: Request to save changes to rate class. required: true delete: summary: Delete rate class description: Use this API to delete rate class.

OperationId:deleteRateClass

operationId: deleteRateClass parameters: - name: rateClassCode in: path required: true description: Unique Code of rate class. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rtp/v1 /hotels/{hotelId}/rateSeasons: get: summary: Get Hotel Rate Seasons description: Use this API to get Hotel Rate Seasons.

OperationId:getRateSeasons

The maximum allowable limit for this API is 1000.

operationId: getRateSeasons parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query 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. schema: type: integer default: 0 - name: seasonsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching rate seasons for a hotel. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/rateSeasonsDetails' '204': description: RateSeasons not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Hotel Rate Seasons description: Use this API to create Hotel Rate Seasons.

OperationId:postRateSeasons

operationId: postRateSeasons parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/rateSeasonsCriteria' description: Request object for creating new rate seasons for a hotel. required: true servers: - url: /rtp/v1 /hotels/{hotelId}/rateSeasons/{seasonCode}: put: summary: Change Hotel Rate Seasons description: Use this API to update Hotel Rate Seasons.

OperationId:changeRateSeasons

operationId: changeRateSeasons parameters: - name: seasonCode in: path required: true description: Unique Code of season. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/rateSeasonsToBeChanged' description: Request object for modifying rate seasons for a hotel. required: true delete: summary: Delete Hotel Rate Seasons description: Use this API to delete Hotel Rate Seasons.

OperationId:removeRateSeasons

operationId: removeRateSeasons parameters: - name: seasonCode in: path required: true description: Unique Code of season. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rtp/v1 /templates/rateCategories: get: summary: Get Template Rate Categories description: Use this API to fetch a Template Rate Category. The search criteria can include rate category and the property code.

OperationId:getTemplateRateCategory

operationId: getTemplateRateCategory parameters: - name: rateCategoryListCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: rateCategoryDescription in: query required: false description: Rate Category description. Partial description searches are considered. schema: type: string - name: includeInactive in: query required: false description: Indicator that tells whether inactive rate category should be included in fetch result. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Rate Categories for a property. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateRateCategoryDetails' '204': description: TemplateRateCategory not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create a Template Rate Category description: Use this API to create a new Template Rate Category.

OperationId:postTemplateRateCategory

operationId: postTemplateRateCategory parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateRateCategoryCriteria' required: true servers: - url: /rtp/v1 /templates/rateCategories/{rateCategoryCode}: put: summary: Change Template Rate Category description: Use this API to Modify a Template Rate Category. Only one template can be updated at a time.

OperationId:changeTemplateRateCategory

operationId: changeTemplateRateCategory parameters: - name: rateCategoryCode in: path required: true description: Unique Code of rate category. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateRateCategoryToBeChanged' required: true delete: summary: Delete a Template Rate Category description: Use this API to delete a Template Rate Category. Only one rate category template can be sent as part of the request.

OperationId:deleteTemplateRateCategory

operationId: deleteTemplateRateCategory parameters: - name: rateCategoryCode in: path required: true description: Unique Code of rate category. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rtp/v1 /templates/rateClasses: get: summary: Get template rate classes description: Use this API to get template rate classes.

OperationId:getTemplateRateClass

operationId: getTemplateRateClass parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query 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. schema: type: integer default: 0 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: rateClassListCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: description in: query required: false description: Description of the rate class. schema: type: string - name: includeInactive in: query required: false description: Indicator which tells whether inactive rate class to be included or not. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch template rate classes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateRateClassDetails' '204': description: TemplateRateClass not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create new template rate class description: Use this API to create new template rate class.

OperationId:postTemplateRateClass

operationId: postTemplateRateClass parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateRateClassCriteria' description: Request to create new template rate class. required: true servers: - url: /rtp/v1 /templates/rateClasses/{rateClassCode}: put: summary: Change template rate class description: Use this API to modify template rate class.

OperationId:changeTemplateRateClass

operationId: changeTemplateRateClass parameters: - name: rateClassCode in: path required: true description: Unique Code of rate class. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateRateClassToBeChanged' description: Request to save changes to template rate class. required: true delete: summary: Delete template rate class description: Use this API to delete template rate class.

OperationId:deleteTemplateRateClass

operationId: deleteTemplateRateClass parameters: - name: rateClassCode in: path required: true description: Unique Code of rate class. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rtp/v1 /templates/rateSeasons: get: summary: Get Template Rate Seasons description: Use this API to get Template Rate Seasons.

OperationId:getTemplateRateSeasons

operationId: getTemplateRateSeasons parameters: - name: seasonCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching template rate seasons. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateRateSeasonsDetails' '204': description: TemplateRateSeasons not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig post: summary: Create Template Rate Seasons description: Use this API to create Template Rate Seasons.

OperationId:postTemplateRateSeasons

operationId: postTemplateRateSeasons parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateRateSeasonsCriteria' description: Request object for creating new template rate seasons. required: true servers: - url: /rtp/v1 /templates/rateSeasons/{seasonCode}: put: summary: Change Template Rate Seasons description: Use this API to update Template Rate Seasons.

OperationId:changeTemplateRateSeasons

operationId: changeTemplateRateSeasons parameters: - name: seasonCode in: path required: true description: Unique Code of season. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateRateSeasonsToBeChanged' description: Request object for modifying template rate seasons. required: true delete: summary: Delete Template Rate Seasons description: Use this API to delete Template Rate Seasons.

OperationId:removeTemplateRateSeasons

operationId: removeTemplateRateSeasons parameters: - name: seasonCode in: path required: true description: Unique Code of season. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig servers: - url: /rtp/v1 /upsert/hotels/{hotelId}/rateSeasons/{seasonCode}: put: summary: Create/Change Hotel Rate Seasons description: Use this API to create/update Hotel Rate Seasons.

OperationId:changeUpsertRateSeasons

operationId: changeUpsertRateSeasons parameters: - name: seasonCode in: path required: true description: Unique Code of season. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - HotelConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/rateSeasonsToBeChanged' description: Request object for modifying rate seasons for a hotel. required: true servers: - url: /rtp/v1 components: responses: '406': description: Not acceptable. '414': description: Request URI Too Large '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '403': description: Forbidden '413': description: Request Entity Too Large '415': description: Unsupported Media Type '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '502': description: Bad Gateway '500': description: System Error content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '503': description: Service Unavailable '401': description: Unauthorized '405': description: Method not allowed parameters: x-hotelid: name: x-hotelid description: Mandatory parameter to identify the hotel code where the end user is logged in in: header required: true schema: type: string x-app-key: name: x-app-key description: Client or Partner's Application Key in: header required: true schema: type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$ authKey: name: authorization description: Bearer token that needs to be passed which is generated post user authentication in: header required: true schema: type: string x-externalsystem: name: x-externalsystem description: External system code. in: header x-example: EXTERNALSYSTEMCODE schema: type: string maxLength: 40 externalData: name: externalData description: Pass this header as true, if payload needs DVM in: header schema: type: string x-originating-application: name: x-originating-application description: Customer's Integration Application Id in: header schema: type: string Accept-Language: name: Accept-Language description: Language code in: header schema: type: string x-request-id: name: x-request-id description: Request Id of an incoming request in: header schema: type: string pattern: ~*[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} schemas: communicationTypesDetails: type: object description: Response object for fetching Communication Types. properties: communicationTypes: description: Collection of Communication Types. $ref: '#/components/schemas/communicationTypesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' managedByOptions: description: Describes of the Configuration is Managed by Enterprise or Property. type: string enum: - EnterpriseManaged - PropertyManaged - EnterpriseEnforced - PropertyOverridden preferenceType: type: object description: Guest Preference details for the profile. properties: preferenceValue: description: Preference value for display purposes. type: string minLength: 0 maxLength: 200 description: description: Preference Description for display purposes. type: string minLength: 0 maxLength: 2000 global: description: Whether this preference is property specific or not. type: boolean source: description: Source of the preference. type: string minLength: 0 maxLength: 40 hotels: description: If specified preference belongs to the Hotels listed, otherwise it is a global preference. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 preferenceId: type: string minLength: 0 maxLength: 20 excludedPreferencesCount: description: Specifies the count of preferences excluded for the attached reservation preference. type: integer copyToProfile: description: Specifies whether to copy the reservation preference to the profile or not. type: boolean instanceLink: type: object description: Metadata describing link description objects that MAY appear in the JSON instance representation. properties: href: description: URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true. type: string rel: description: Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile. type: string templated: description: Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false. type: boolean default: false method: description: HTTP method for requesting the target of the link. type: string enum: - GET - POST - PUT - DELETE - PATCH - OPTIONS - HEAD targetSchema: description: Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.. type: string operationId: description: The operationId of the path you can call to follow this link. This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply. type: string title: description: Exact copy of the "summary" field on the linked operation. type: string errorInstance: title: Error Instance Details description: Complex type that contains error instance details for a REST call. type: object properties: type: type: string description: Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML). title: type: string description: Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization. status: type: integer description: HTTP status code for this occurrence of the problem, set by the origin server. detail: type: string description: Human-readable description specific to this occurrence of the problem. instance: type: string description: Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced. o:errorCode: type: string description: Application error code, which is different from HTTP error code. o:errorPath: type: string description: Path to the problem at the resource or property level. required: - type - title communicationRoleType: type: string description: Phone Number Communication Role. enum: - Email - Fax - EmailForRequest - Webpage - Phone communicationTypeCriteria: type: object description: Request object for creating a new Communication Type. properties: communicationType: description: Communication Type to be created. $ref: '#/components/schemas/communicationTypeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' warningType: type: object description: Used when a message has been successfully processed to report any warnings or business errors that occurred. properties: value: type: string description: Property Value shortText: description: An abbreviated version of the error in textual format. type: string maxLength: 2000 code: description: If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. type: string minLength: 0 maxLength: 20 docURL: description: If present, this URL refers to an online description of the error that occurred. type: string maxLength: 2000 status: description: If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration. type: string maxLength: 2000 tag: description: If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing]. type: string maxLength: 2000 recordId: description: If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction. type: string maxLength: 2000 type: description: The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown". type: string minLength: 0 maxLength: 20 language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' rph: description: Reference Place Holder used as an index for this warning. type: string minLength: 1 maxLength: 8 exceptionDetailType: title: Error Detail description: Complex type that contains error details for a REST call. type: object properties: type: type: string description: Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML). title: type: string description: Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization. status: type: integer description: HTTP status code for this occurrence of the problem, set by the origin server. detail: type: string description: Human-readable description specific to this occurrence of the problem. instance: type: string description: Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced. o:errorCode: type: string description: Application error code, which is different from HTTP error code. o:errorPath: type: string description: Path to the problem at the resource or property level. o:errorDetails: description: Details of the error message, consisting of a hierarchical tree structure. type: array items: $ref: '#/components/schemas/errorInstance' links: $ref: '#/components/schemas/links' required: - type - title availablePreferencesDetails: type: object description: Response object for fetching available preferences for a property. properties: preferenceCollection: description: A collection of preferences type: array items: $ref: '#/components/schemas/preferenceTypeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' status: type: object description: Response Body. properties: warnings: $ref: '#/components/schemas/warningsType' links: $ref: '#/components/schemas/links' communicationTypesType: type: array description: Communication Type details. maxItems: 4000 items: $ref: '#/components/schemas/communicationTypeType' preferenceTypeType: type: object description: Preference details for the profile. properties: preference: description: Collection of Preferences for the profile. type: array maxItems: 4000 items: $ref: '#/components/schemas/preferenceType' preferenceType: description: Preference group code. type: string minLength: 0 maxLength: 20 preferenceTypeDescription: description: Preference group description. type: string sequence: description: Preference Sequence. type: string maxQuantity: description: Maximum quantity of preferences allowed per preference group. type: integer availableQuantity: description: Available quantity of preferences (maximum quantity - Existing preferences)per preference group. type: integer maxResortUsedQuantity: description: Maximum quantity of preferences used by any resort per preference group. type: integer reservationPreference: description: Whether this preference is reservation preference or not. type: boolean createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 warningsType: type: array description: Used in conjunction with the Success element to define a business error. maxItems: 4000 items: $ref: '#/components/schemas/warningType' communicationTypeToBeChanged: type: object description: Request object for changing an existing Communication Type. properties: communicationType: description: Communication Type to be changed. $ref: '#/components/schemas/communicationTypeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' communicationTypeType: type: object description: Communication Type details. properties: role: description: Communication Role enumeration element. $ref: '#/components/schemas/communicationRoleType' description: description: Communication Type description. type: string minLength: 0 maxLength: 2000 textEnabled: description: Communication Type SMS Text Message enabled. type: boolean sequence: description: Communication Type sequence. type: integer code: description: Unique Communication Type Code. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' operaVersion: type: object description: Response for Ping operation. properties: operaVersion: description: Opera version number. $ref: '#/components/schemas/operaVersionNumberType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' links: type: array items: $ref: '#/components/schemas/instanceLink' operaVersionNumberType: type: string description: Current Opera Version Number minLength: 0 maxLength: 40 reservationQueueInformationType: type: object description: Information regarding the Date, Duration and Priority of the reservation on Queue for Check in. properties: timeSpan: description: Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date. type: object properties: startDate: type: string format: date maxLength: 8 endDate: type: string format: date maxLength: 8 duration: type: string durationInSeconds: description: The total duration, in seconds, the reservation is on Queue. type: integer guestTextInfo: description: Information for the message sent to the user $ref: '#/components/schemas/queueTextInfoType' priority: description: The Queue Priority given to this reservation. type: integer averageQueueTimeToCheckIn: description: The average time, in seconds, a reservation was on queue prior to Check-In. type: integer averageQueueTimeCurrentReservations: description: The average time, in seconds, of the reservations currently in queue. type: integer queueDate: description: The Business date on which the reservation was due to arrive and is currently placed on Queue for Check In. type: string format: date maxLength: 8 cardReIssueType: type: string description: Request to re issue a new card. enum: - Pending - NotApplicable - Requested resAccompanyGuestInfoType: type: object properties: firstName: description: Given name, first name or names type: string lastName: description: Family name, last name. type: string fullName: description: String representation of the full name type: string registrationCardNo: description: Unique identifier of the police registration card number. type: string minLength: 0 maxLength: 40 profileIdList: description: Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id. $ref: '#/components/schemas/profileIdList' stayInfoType: type: object description: Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties. properties: arrivalDate: type: string format: date departureDate: type: string format: date originalTimeSpan: description: The Original Time Span covers the Room Stay dates of the original reservation. $ref: '#/components/schemas/timeSpanType' expectedTimes: description: The expected arrival, return and departure times of the guest. $ref: '#/components/schemas/resExpectedTimesType' adultCount: description: A collection of Guest Counts associated with Room Stay. type: integer childCount: description: A collection of Child Counts associated with Room Stay. type: integer roomClass: description: Room class code type: string minLength: 0 maxLength: 20 roomType: description: Room type code type: string minLength: 0 maxLength: 20 componentRoomType: description: True indicates room type is a component type. type: boolean numberOfRooms: description: Room Id type: integer roomId: description: Room Id type: string minLength: 0 maxLength: 20 ratePlanCode: description: Rate plan code type: string minLength: 0 maxLength: 20 rateAmount: description: Rate amount $ref: '#/components/schemas/currencyAmountType' points: description: The Points contains the number of points used to book a particular room type. $ref: '#/components/schemas/pointsType' rateSuppressed: description: Whether this rate should be suppressed from view type: boolean reservationBlock: description: Key information about the block for this reservation. $ref: '#/components/schemas/reservationBlockType' bookingChannelCode: description: Booking channel code type: string minLength: 0 maxLength: 20 linkCode: description: Party code type: string maxLength: 2000 fixedRate: description: True if the rate is a fixed rate, otherwise false type: boolean totalAmount: description: The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount. $ref: '#/components/schemas/currencyAmountType' guarantee: description: The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context. $ref: '#/components/schemas/resGuaranteeType' promotion: description: Promotion Codes $ref: '#/components/schemas/promotionType' marketCode: description: Market code type: string minLength: 0 maxLength: 20 marketDescription: description: Description of Market code type: string minLength: 0 maxLength: 4000 sourceCode: description: Source of business type: string minLength: 0 maxLength: 20 sourceCodeDescription: description: Description of the source of business. type: string minLength: 0 maxLength: 4000 balance: description: Balance amount $ref: '#/components/schemas/currencyAmountType' compBalance: description: Comp Balance amount $ref: '#/components/schemas/currencyAmountType' roomTypeCharged: description: Room type code that was charged type: string minLength: 0 maxLength: 20 depositPayments: description: A collection of deposit and/or payments for the Room Stay. $ref: '#/components/schemas/currencyAmountType' guestServiceStatus: description: Service Status of In House guest like DND or MUP $ref: '#/components/schemas/guestHousekeepingServiceRequestType' scheduledCheckoutTime: description: Indicates that this reservation is scheduled for automated check out. type: string format: date roomNumberLocked: description: When true, indicates a room number cannot be changed. When false, indicates a room number may be changed. type: boolean pseudoRoom: description: True indicates as pseudo room type. This is usually used for a posting master reservation. type: boolean assignedByAI: description: Represents the room was assigned by AI Room Assignment. type: boolean upgradedByAI: description: Represents the room was assigned by AI Room Assignment. type: boolean salesInfoType: type: object description: Provides sales information about the profiles of type company, travel agent, source and contact. properties: scope: description: Defines the scope. type: string minLength: 0 maxLength: 2000 scopeCity: description: Defines the scope city. type: string minLength: 0 maxLength: 2000 accountType: description: Defines the account type. type: string minLength: 0 maxLength: 20 accountSource: description: Defines the account source. type: string minLength: 0 maxLength: 2000 industryCode: description: Defines the industry code. type: string minLength: 0 maxLength: 2000 businessSegments: description: Defines the Business segments. type: string minLength: 0 maxLength: 2000 priority: description: Defines the priority. type: string minLength: 0 maxLength: 4000 roomsPotential: description: Defines the rooms potential. type: string minLength: 0 maxLength: 4000 actionCode: description: Defines the action code. type: string minLength: 0 maxLength: 4000 competitionCode: description: Defines the competition code. type: string minLength: 0 maxLength: 4000 influence: description: Defines the influence for the contact profile. type: string minLength: 0 maxLength: 2000 preferredRoom: description: Defines the Preferred Room for profile. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel Code used to filter the sales information. type: string minLength: 0 maxLength: 20 marketingCitiesDetails: type: object description: Response object for fetching marketing cities configured for hotels. properties: marketingCities: description: Collection of marketing cities. $ref: '#/components/schemas/marketingCitiesType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' amenitiesToBeChanged: type: object description: Request object for changing amenities at the property level. properties: hotelAmenities: description: Collection containing details of amenities specified at the property level. $ref: '#/components/schemas/configHotelAmenitiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' colorType: type: string description: Color configuration type. This color configuration provides a visual category of entities. enum: - Red - DarkRed - Green - DarkGreen - LightGreen - Orange - White - Yellow - DarkYellow - Purple - Brown - Gray - Aqua - Chocolate - Blue - LightBlue - DarkBlue - Cyan - DarkCyan - Magenta - DarkMagenta - Black pointsType: type: object description: The Redeem Points contains the number of points required to book a room type. properties: awardsType: description: Awards type for the award type rate code. type: string points: description: No of points required to book this Room Stay. type: integer languagesDetails: type: object description: Response object for fetching languages. properties: languages: description: Collection of languages. $ref: '#/components/schemas/configLanguagesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' profileSubscriptionListType: type: array description: Details of the OPERA Profile subscription to external system maxItems: 4000 items: $ref: '#/components/schemas/profileSubscriptionType' negotiatedType: type: object description: This holds a list of NegotiatedInfoType. properties: negotiatedInfoList: type: array maxItems: 4000 items: $ref: '#/components/schemas/negotiatedInfoType' hotelId: description: Hotel code for the negotiated rate. type: string minLength: 0 maxLength: 20 rateCode: description: Rate plan code for the negotiated rate. type: string minLength: 0 maxLength: 20 characterUDFsType: type: array description: Used to hold collection of user defined fields of Character/String Type. maxItems: 4000 items: $ref: '#/components/schemas/characterUDFType' timeSpanType: type: object description: Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date. properties: startDate: type: string format: date maxLength: 8 endDate: type: string format: date maxLength: 8 duration: type: string templateDayTypeCodesType: type: array description: Details for day type code at template level. maxItems: 4000 items: $ref: '#/components/schemas/templateDayTypeCodeType' indicatorType: type: object description: Lamp indicator Type. properties: indicatorName: description: Name of the indicator. type: string minLength: 0 maxLength: 80 count: description: Indicates number of occurrences of the indicator. type: integer imageStyleType: type: string description: An enumeration of image styles. enum: - Full - Thumbnail - Icon - Square - Banner - Button - Lowres - Highres addressInfoType: type: object description: Provides address information. properties: address: description: Address details for the profile. $ref: '#/components/schemas/addressType' id: 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 minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 yieldAdjustmentCodesDetails: type: object description: Response object for fetching Yield AdjustmentCodes configurations. properties: yieldAdjustmentCodes: description: Collection of Yield AdjustmentCodes configurations. $ref: '#/components/schemas/yieldAdjustmentCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelNotesCriteria: type: object description: Request object for creating new Notes for the hotels properties: hotelNotes: description: Collection of hotel notes to be created. $ref: '#/components/schemas/hotelNotesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cardNumberTypeType: type: string description: Simple type for indicating if credit card number is tokenized. enum: - CardNumber - Token templateMarketingCitiesType: type: array description: Template marketing city details. maxItems: 4000 items: $ref: '#/components/schemas/templateMarketingCityConfigType' eCertificateInfoType: type: object description: E-Certificates details. properties: certificateType: description: User defined certificate code. type: string minLength: 0 maxLength: 20 membershipType: description: Membership type to which the certificate is linked to. type: string minLength: 0 maxLength: 20 awardCode: description: Award type to which the certificate is linked to. type: string minLength: 0 maxLength: 20 promotionCode: description: Promotion code to which certificate is attached to. type: string minLength: 0 maxLength: 20 voucherBenefitCode: description: Voucher benefit code attached to the certificate. type: string minLength: 0 maxLength: 40 hotels: description: Hotel to which certificate is attached to. type: object properties: code: type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 scope: description: 'Scope of e-cert: global,single property or multi property.' $ref: '#/components/schemas/eCertificateScopeType' description: description: Description about the certificate. type: string minLength: 0 maxLength: 200 longDescription: description: Detail description about the certificate. type: string minLength: 0 maxLength: 4000 label: description: Label for the certificate. type: string minLength: 0 maxLength: 40 maxExtensionAllowed: description: Number of times e-certificate can be extended. type: integer usageCriteria: $ref: '#/components/schemas/eCertificateUsageCriteriaType' value: description: Value of the certificate for the guest. $ref: '#/components/schemas/currencyAmountType' cost: description: Cost of certificate. $ref: '#/components/schemas/currencyAmountType' benefitSummary: description: Summary of Benefits attached to this ECertificate. type: string minLength: 0 maxLength: 4000 yieldCategoriesToBeChanged: type: object description: Request object for changing existing Yield Category Configurations. properties: hotelId: description: Code of the Hotel. type: string minLength: 0 maxLength: 20 code: description: Code of the Yield Category. type: string minLength: 0 maxLength: 20 description: description: Description of the Yield Category. type: string minLength: 0 maxLength: 40 links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' currencyAmountType: type: object description: A monetary value expressed with a currency code. properties: amount: description: A monetary amount. type: number currencyCode: description: Provides a currency code to reflect the currency in which an amount may be expressed. type: string minLength: 3 maxLength: 3 customerType: type: object description: Contains basic data on the customer's identity, location, relationships, finances, memberships, etc. properties: personName: description: Detailed name information for the customer. type: array maxItems: 5 items: $ref: '#/components/schemas/personNameType' anonymization: description: Provides information about the guest's anonymization status $ref: '#/components/schemas/anonymizationType' citizenCountry: description: Name of the (self-professed) country that is claimed for citizenship. $ref: '#/components/schemas/countryNameType' identifications: description: List of identification of the customer. type: object properties: identificationInfo: description: Collection of detailed information on the identification of the customer. type: array maxItems: 4000 items: $ref: '#/components/schemas/identificationInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer profession: description: Profession of a person. type: string minLength: 0 maxLength: 80 alienInfo: description: Immigration/visa information of a foreign person. $ref: '#/components/schemas/alienInfoType' birthCountry: description: Country of birth. $ref: '#/components/schemas/countryNameType' legalCompany: description: Name Of the company the individual is associated with. type: string minLength: 0 maxLength: 80 companyInfo: description: Company Information of the Profile. $ref: '#/components/schemas/companyInfoType' businessTitle: description: Business Title. type: string minLength: 0 maxLength: 80 gender: description: Identifies the profile gender code selected from Gender types List of values. Gender types LOV provides the values configured at gender configuration. type: string minLength: 0 maxLength: 20 birthDate: description: Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format. type: string format: date maxLength: 8 birthDateMasked: description: Indicates the date of birth as masked. type: string currencyCode: description: The code specifying a monetary unit. Use ISO 4217, three alpha code. type: string minLength: 0 maxLength: 20 currencySymbol: description: The symbol for the currency, e.g, for currencyCode USD the symbol is $. type: string minLength: 0 maxLength: 10 decimalPlaces: description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85). type: integer language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' nationality: description: Nationality code identification type: string minLength: 0 maxLength: 20 nationalityDescription: description: Nationality code description type: string minLength: 0 maxLength: 80 customerValue: description: The supplier's ranking of the customer (e.g., VIP, numerical ranking). type: string minLength: 0 maxLength: 20 creditRating: description: Credit Rating of the customer. type: string minLength: 0 maxLength: 20 vipStatus: description: VIP status of the customer. type: string minLength: 0 maxLength: 20 vipDescription: description: Description of the VIP status. type: string minLength: 0 maxLength: 2000 birthPlace: description: Place of birth. type: string minLength: 0 maxLength: 80 privateProfile: description: This element tells profile is property exclusive or not. type: boolean blacklist: description: This element tells if profile is blacklisted or not. type: boolean applicationSettingTypeType: type: string enum: - Function - Parameter - Setting housekeepingRoomStatusType: type: string 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. enum: - Clean - Dirty - Pickup - Inspected - OutOfOrder - OutOfService applicationSettingSimpleType: type: object description: Internal settings that is mainly used to get a quick information on the type. properties: configurations: description: This element is used for additional items (Key-Value-Pair) that has relevance to the operation. type: array maxItems: 4000 items: $ref: '#/components/schemas/applicationSettingSimpleType' name: type: string minLength: 0 maxLength: 80 levelType: $ref: '#/components/schemas/applicationSettingLevelType' levelCode: type: string minLength: 0 maxLength: 20 value: type: string minLength: 0 maxLength: 2000 amenityTypeType: type: string description: Simple type for storing amenity type. enum: - General - Meeting profileSubscriptionType: type: object description: Contains details of the profile subscription. The subscription represents the link between the OPERA profile and the external profile within a particular external system properties: profileId: description: OPERA Profile ID that this subscription record corresponds to. $ref: '#/components/schemas/profileId' externalProfileId: description: Profile ID within the external system. $ref: '#/components/schemas/uniqueID_Type' profileInfo: description: This provides name information for a person. type: object properties: name: description: Family name, last name or Company Name. type: string minLength: 0 maxLength: 40 fullName: description: Full display Name. type: string minLength: 0 maxLength: 200 namePrefix: description: Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) type: string minLength: 0 maxLength: 40 givenName: description: Given name, first name or names. type: string minLength: 0 maxLength: 40 middleName: description: The middle name of the person name. type: string minLength: 0 maxLength: 40 nameSuffix: description: Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.) type: string minLength: 0 maxLength: 40 nameTitle: description: Degree or honors (e.g., Ph.D., M.D.) type: string minLength: 0 maxLength: 80 nameType: description: Type of name of the individual, such as former, nickname, alternate or alias name. $ref: '#/components/schemas/personNameTypeType' profileType: description: OPERA profile type such as Individual or Company $ref: '#/components/schemas/profileTypeType' distributed: description: Indicates if the profile was distributed to the external system. type: boolean force: description: Indicates if the profile information should be overwritten by the external system. type: boolean subscriptionDate: description: Timestamp when the profile was subscribed to. type: string format: date-time lastDistributionDate: description: Timestamp of the most recent distribution of this profile to the external system. type: string format: date-time lastExternalUpdateDate: description: Timestamp of the most recent update of the subscription information by the external system. type: string format: date-time inactive: description: Indicates whether this subscription is active or inactive. type: boolean systemCode: description: Code of system where profile is subscribed to. type: string minLength: 0 maxLength: 40 systemType: description: Type of system where profile is subscribed to. type: string minLength: 0 maxLength: 40 transportationCriteria: type: object description: Request object for creating transportation. properties: transportationList: $ref: '#/components/schemas/transportationListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelPackagesType: type: array maxItems: 4000 items: $ref: '#/components/schemas/hotelPackageType' hotelNotesType: type: array description: List of Notes of the hotel. maxItems: 4000 items: $ref: '#/components/schemas/commentInfoType' profileDeliveryModuleType: type: string description: 'Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..' enum: - EfolioExport discountType: type: object description: Identifies and provides details about the discount. This allows for both percentages and flat amounts. If one field is used, the other should be zero/not specified since logically. properties: discountReason: type: string minLength: 0 maxLength: 2000 percent: description: Percentage discount. type: number amount: description: A monetary amount. type: number currencyCode: description: Provides a currency code to reflect the currency in which an amount may be expressed. type: string minLength: 3 maxLength: 3 discountCode: description: Specifies the type of discount (e.g., No condition, LOS, Deposit or Total amount spent). type: string minLength: 0 maxLength: 20 telephoneCategoryType: type: object description: This type definition of Telephone Category Type. properties: hotelId: type: string minLength: 0 maxLength: 20 code: type: string minLength: 0 maxLength: 80 description: type: string minLength: 0 maxLength: 2000 orderBy: type: integer generic: type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' hotelInterfaceType: type: object properties: interfaceId: description: Unique DB internal number of a Hotel Interface record. $ref: '#/components/schemas/uniqueID_Type' hotelId: description: Hotel Code type: string minLength: 0 maxLength: 20 interfaceName: description: Name of the Hotel Interface type: string minLength: 0 maxLength: 40 interfaceType: description: Three letter code for each interface that identifies the interface. $ref: '#/components/schemas/hotelInterfaceTypeType' logo: description: Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create. type: string minLength: 0 maxLength: 20 machineName: description: Unique machine name of the running IFC. type: string minLength: 0 maxLength: 80 status: description: The current status of the IFC. $ref: '#/components/schemas/hotelInterfaceStatusType' activeFlag: description: Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING. type: boolean cardProcessingType: type: string enum: - Eft - Manual reservationHistoryFutureInfoType: type: object description: Information of History and Future Reservation details attached to Profiles. properties: historyList: description: Refer to History list type document. $ref: '#/components/schemas/historyListType' futureList: description: Refer to Future list type document. $ref: '#/components/schemas/futureListType' attractionsDetails: type: object description: Response object for information regarding attraction. properties: attractions: description: Collection of attractions and their information. $ref: '#/components/schemas/attractionCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' alternateHotelType: type: object properties: address: $ref: '#/components/schemas/addressType' contactNumbers: type: array maxItems: 4000 items: $ref: '#/components/schemas/telephoneType' minRate: $ref: '#/components/schemas/currencyAmountType' maxRate: $ref: '#/components/schemas/currencyAmountType' relativePosition: $ref: '#/components/schemas/relativePositionType' hotelAmenities: type: array maxItems: 4000 items: $ref: '#/components/schemas/hotelAmenityType' event: description: True if the hotel has any scheduled events within the requested date range. type: boolean rateRoomDetails: description: Any additional information like membership, restriction status, room stay information of the requested hotels etc. $ref: '#/components/schemas/rateRoomDetailsType' channelSummaryInfo: description: Channel related information if availability request is send for a channel. $ref: '#/components/schemas/channelSummaryInfoType' sellMessages: description: Sell messages retrieved based on the Time Span criteria for all Rate Codes and Room Types of the requested hotel. $ref: '#/components/schemas/sellMessagesType' currencyExchangeRates: description: Exchange Rate information for currency codes of the requested hotel. $ref: '#/components/schemas/currencyExchangeRatesType' chainCode: description: The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute. type: string minLength: 0 maxLength: 20 hotelId: description: The code that uniquely identifies a single hotel property. The hotel code is decided between vendors. type: string minLength: 0 maxLength: 20 hotelCityCode: description: The IATA city code; for example DCA, ORD. type: string minLength: 0 maxLength: 40 hotelName: description: A text field used to communicate the proper name of the hotel. type: string minLength: 0 maxLength: 80 hotelCodeContext: description: A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes. type: string minLength: 0 maxLength: 40 chainName: description: The name of the hotel chain (e.g., Hilton, Marriott, Hyatt). type: string minLength: 0 maxLength: 80 hotelType: type: string minLength: 0 maxLength: 20 negotiated: type: boolean alternate: type: boolean displayOrder: type: number inventoryRooms: type: integer availableRooms: type: integer comments: description: Comments of alternate Hotel. type: string minLength: 0 maxLength: 2000 direction: description: Compass direction to the attraction from the hotel (North/South, etc). type: string minLength: 0 maxLength: 20 reciprocalRelationship: description: whether the alternate relationship should be applied to the alternate hotel as well. If this flag is true, not only will the AlternateHotelCode hotel be an alternate for HotelCode hotel, but HotelCode hotel will also be an alternate for AlternateHotelCode hotel. type: boolean alternateHotelCode: type: string minLength: 0 maxLength: 20 newAlternateHotelCode: type: string minLength: 0 maxLength: 20 attractionTemplateType: type: object description: Information about the attractions near the hotel. properties: name: description: Attraction name for the hotel. $ref: '#/components/schemas/translationTextType2000' type: description: The type of the attraction. type: string minLength: 0 maxLength: 60 class: description: The class of the attraction. type: string minLength: 0 maxLength: 60 generalDirections: description: Directions to the attraction from the hotel. type: string minLength: 0 maxLength: 2000 relativePosition: $ref: '#/components/schemas/relativePositionType' address: description: Address of the attraction. $ref: '#/components/schemas/addressType' website: description: Website for the attraction. $ref: '#/components/schemas/uRLType' priceRange: description: Price range for the attraction. type: string minLength: 0 maxLength: 40 operationHours: description: Price range for the attraction. type: string minLength: 0 maxLength: 20 displaySeq: description: Display sequence of the attraction. type: integer code: type: string minLength: 0 maxLength: 20 region: description: The region in which this attraction is located. type: string minLength: 0 maxLength: 20 inactiveDate: description: The date the record was marked as inactive. type: string format: date maxLength: 8 latitude: type: number minimum: -90 maximum: 90 longitude: description: The longitude of the location from which the organism or observation was collected, expressed in decimal degrees. Positive values are East of the Greenwich Meridian, negative values are West of the Greenwich Meridian. type: number minimum: -180 maximum: 180 managedBy: $ref: '#/components/schemas/managedByOptions' attractionTemplatesToBeChanged: type: object description: Request object for modifying the existing attraction attraction templates. properties: attractionTemplates: description: Attraction template group details to be changed. $ref: '#/components/schemas/attractionTemplatesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelContactRolesType: type: array description: Lists of HotelContactRoles of the hotel. maxItems: 4000 items: $ref: '#/components/schemas/hotelContactRoleType' configActivityType: type: object description: Changes log record to import/Export/Delete customization operations. properties: actionType: description: 'Action Type: MDS_IMP, MDS_EXP, MDS_DEL, MDS_EXP_UNENC, MDS_IMP_UNENC.' type: string minLength: 0 maxLength: 20 actionDescription: description: action, layer, org name, user name and screen name or file name or path. type: string minLength: 0 maxLength: 200 hotelId: description: Code that uniquely identifies the hotel belonging to the organization. type: string minLength: 0 maxLength: 20 restaurantCategoryType: type: string description: Simple type for Hotel Restaurant. enum: - Restaurant - Retail housekeepingTaskCodeType: type: object description: Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management. properties: description: description: Description of the Task Code. type: string minLength: 0 maxLength: 80 instructions: description: Instructions for this Task Code. type: string minLength: 0 maxLength: 2000 facilityDepartureTask: description: Indicates if this task code is the default departure task for Facility Tasks. This requires type: boolean linenChange: description: Indicates if a linen change is necessary. type: boolean hotelId: description: Property where this task code is configured. type: string minLength: 0 maxLength: 20 code: description: The Code for the task. type: string minLength: 0 maxLength: 20 sequence: description: Ordering sequence for display. type: integer resAccompanyGuestListType: type: array description: Collection of accompany guests maxItems: 4000 items: $ref: '#/components/schemas/resAccompanyGuestInfoType' centralConfigsResponse: type: object properties: configs: type: array description: Collection of Central Config Details maxItems: 4000 items: $ref: '#/components/schemas/centralConfig' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' resSharedGuestListType: type: array description: Collection of shared guest reservations. maxItems: 4000 items: $ref: '#/components/schemas/resSharedGuestInfoType' shareDistributionInstructionType: type: string description: The type of Rate Amount Change to be done on the Sharer reservation. This can be FULL -> Full Rate for each Sharer. SPLIT-> Split the Rate amount between Sharer Reservations. ENTIRE -> This Sharer will get the total amount of the rate code for all the Sharer Reservations. enum: - Full - Entire - Split - CustomSplit benefitsType: type: array description: Basic information about membership benefit. maxItems: 4000 items: $ref: '#/components/schemas/benefitType' facilityTaskType: type: object description: Information regarding facility task on a reservation. properties: task: description: The Task Code. $ref: '#/components/schemas/housekeepingTaskCodeType' supplies: description: Supplies associated with the task. $ref: '#/components/schemas/facilityCodesType' date: description: The Date on which the task is applicable. type: string format: date maxLength: 8 downgradeType: type: string description: Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace. enum: - Grace - Never - Period codeDescriptionType: type: object description: This contains a generic code and description information. properties: code: description: Code. type: string minLength: 0 maxLength: 20 description: description: description. type: string minLength: 0 maxLength: 2000 hotelTransportationsType: type: array maxItems: 4000 items: $ref: '#/components/schemas/hotelTransportationType' resAwardsType: type: object description: Membership Awards code applied on the reservation. properties: membershipNo: description: Membership program under which the award is applied. $ref: '#/components/schemas/uniqueID_Type' awardVouchers: $ref: '#/components/schemas/awardVouchersType' originalRoomType: description: Room Type before the Upgrade Award. type: string minLength: 0 maxLength: 20 upgradeRoomType: description: Room Type after the Upgrade Award. type: string minLength: 0 maxLength: 20 hotelEventSpaceSummariesType: type: array description: List of summary info of hotel event space maxItems: 4000 items: $ref: '#/components/schemas/hotelEventSpaceSummaryType' surnameType: type: string description: Family name, last name. minLength: 0 maxLength: 40 hotelAirportsType: type: array description: Collection of Airport details of the Hotel maxItems: 4000 items: $ref: '#/components/schemas/hotelAirportType' ownerType: type: object description: Generic type for information about an owner. properties: hotel: description: Hotel to which the owner belongs to. $ref: '#/components/schemas/codeDescriptionType' userId: description: Unique application user ID. $ref: '#/components/schemas/uniqueID_Type' userName: description: Unique application user name of the owner. type: string minLength: 0 maxLength: 40 ownerCode: description: Unique Code to identify the owner. type: string minLength: 0 maxLength: 20 profileId: description: Unique owner profile information. $ref: '#/components/schemas/profileId' name: description: Provides name information of the owner. $ref: '#/components/schemas/personNameType' department: description: Department to which the owner belongs to. $ref: '#/components/schemas/codeDescriptionType' email: description: Email information of the owner. $ref: '#/components/schemas/emailInfoType' phone: description: Information on the telephone number of the owner. $ref: '#/components/schemas/telephoneInfoType' relationship: description: Relationship of the owner within the profile or block. $ref: '#/components/schemas/codeDescriptionType' primary: description: When true, this is a primary owner. type: boolean hotelDetailsDetails: type: object description: Response object for fetching hotel details at the property level. properties: hotelDetails: description: Collection of hotel details specified at the property level. $ref: '#/components/schemas/hotelDetailsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' jobTitlesDetails: type: object description: Response object for fetching job titles configured for hotels. properties: jobTitles: description: Collection of job titles. $ref: '#/components/schemas/jobTitlesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' attractionTemplatesCriteria: type: object description: Request object for creating a new attraction code template. properties: attractionTemplates: description: Attraction template details to be created. $ref: '#/components/schemas/attractionTemplatesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateHotelDetailValuesType: type: array description: Collection of template level hotel detail values. maxItems: 4000 items: $ref: '#/components/schemas/templateHotelDetailValueType' hotelDetailDataType: type: string description: Simple type used for hotel details code field data type. enum: - CHAR - DATE - NUMBER hotelAirportType: type: object description: Airport details of the Hotel properties: description: description: Description of the airport type: string minLength: 0 maxLength: 2000 relativePosition: $ref: '#/components/schemas/relativePositionType' direction: description: Directions from the airport to the Hotel. type: string minLength: 0 maxLength: 2000 transportationList: description: List of Transportation available from Airport to Hotel. $ref: '#/components/schemas/transportationCodeListType' airportCode: type: string minLength: 0 maxLength: 20 orderSequence: description: Display Order sequence. type: number templateAmenitiesToBeChanged: type: object description: Request object for changing amenities at the template level. properties: templateAmenities: description: Collection containing details of amenities specified at the template level. $ref: '#/components/schemas/configTemplateAmenitiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateDayTypeCodesDetails: type: object description: Response object for fetching template day type codes. properties: templateDayTypeCodes: description: Collection of template level day type codes. $ref: '#/components/schemas/templateDayTypeCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' searchMatchType: type: object description: Search match indicating attribute and the matching value. properties: attribute: description: Search match attribute. type: string minLength: 0 maxLength: 2000 value: description: Search match value. type: string minLength: 0 maxLength: 2000 hotelAmenityType: type: object properties: description: type: string minLength: 0 maxLength: 2000 code: type: string minLength: 0 maxLength: 20 type: type: string minLength: 0 maxLength: 2000 displayOrder: type: number alternateHotelsToBeChanged: type: object description: Request object for changing hotel Alternate Hotels for hotels. properties: alternateHotels: description: Collection of Alternate Hotels to be modified. $ref: '#/components/schemas/alternateHotelsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' relativePositionType: type: object description: Defines the position of an entity in relation to another entity (e.g. from an airport to a hotel, the relationship is dependent on use). properties: distance: description: Defines the distance between two points. type: number distanceType: description: The unit of measure in a code format. type: string minLength: 0 maxLength: 20 drivingTime: description: The driving time in a free text format. type: string minLength: 0 maxLength: 20 hotelDayTypeCodesToBeChanged: type: object description: Request object for modifying day type codes for a hotel. properties: hotelDayTypeCodes: description: Collection of hotel day type codes to be changed. $ref: '#/components/schemas/hotelDayTypeCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' profileDeliveryMethod: type: object description: Delivery Information type to the profile. properties: deliveryId: description: Delivery ID. It will be empty in case of new delivery method. $ref: '#/components/schemas/uniqueID_Type' deliveryType: description: Delivery type can have a value EMAIL, ELECTRONIC etc and it depends on the parameter set in OPERA Control. type: string minLength: 0 maxLength: 20 deliveryValue: description: Delivery value holds the corresponding value of the delivery type.. type: string minLength: 0 maxLength: 2000 hotelId: description: Property that has delivery methods configured. type: string minLength: 0 maxLength: 20 deliveryModule: description: 'Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..' $ref: '#/components/schemas/profileDeliveryModuleType' primaryInd: description: When true, indicates a primary information. type: boolean orderSequence: description: Display Order sequence. type: number uniqueIDListType: type: array description: Unique Id that references an object uniquely in the system. maxItems: 4000 items: $ref: '#/components/schemas/uniqueID_Type' transportationDetails: type: object description: Response object for information regarding transportation. properties: transportationList: $ref: '#/components/schemas/transportationListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' primaryCodesType: type: array description: List of codes with primary flag maxItems: 4000 items: $ref: '#/components/schemas/primaryCodeType' commissionPaymentMethods: type: string description: Check enum: - Cent - Eft - Chk yieldMarketTypesDetails: type: object description: Response object for fetching Yield Market Types. properties: yieldMarketTypes: description: Collection of Yield Market Types. $ref: '#/components/schemas/yieldMarketTypesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelDayTypeCodesDetails: type: object description: Response object for fetching day type codes for a hotel. properties: hotelDayTypeCodes: description: Collection of hotel level day type codes. $ref: '#/components/schemas/hotelDayTypeCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' addressType: type: object description: Provides address information. properties: isValidated: description: Indicator to define if the Address is validated by the Address Validation System. type: boolean addressLine: description: When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence. type: array maxItems: 4 items: type: string minLength: 0 maxLength: 80 cityName: description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). type: string minLength: 0 maxLength: 40 postalCode: description: Post Office Code number. type: string minLength: 0 maxLength: 15 cityExtension: description: Post Office City Extension Code number. City Extension mainly used for UK addresses. type: string minLength: 0 maxLength: 20 county: description: County or District Name (e.g., Fairfax). This is read only. type: string minLength: 0 maxLength: 20 state: description: State or Province name (e.g., Texas). type: string minLength: 0 maxLength: 20 country: description: Country name (e.g., Ireland). $ref: '#/components/schemas/countryNameType' language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' type: description: Defines the type of address (e.g. home, business, other). type: string minLength: 0 maxLength: 20 typeDescription: description: Describes the type code type: string primaryInd: description: When true, indicates a primary information. type: boolean updateReservations: description: Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address. type: boolean barCode: description: The postal barcode for the address. type: string minLength: 0 maxLength: 100 createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 createConfigActivityLogCriteria: type: object description: Request object for creating Config Activity Logs. properties: configActivities: description: Confic Activity Logs to be created. $ref: '#/components/schemas/configActivitiesType' warnings: $ref: '#/components/schemas/warningsType' hotelRestaurantsCriteria: type: object description: Request object for creating new restaurants for hotels. properties: hotelRestaurants: description: Collection of restaurants to be created. $ref: '#/components/schemas/hotelRestaurantsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' airportsCriteria: type: object description: Request object for creating new airports for hotels. properties: airports: description: Collection of airports to be created. $ref: '#/components/schemas/airportsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' configActivitiesType: type: array description: Changes log record to import/Export/Delete customization operations. maxItems: 4000 items: $ref: '#/components/schemas/configActivityType' templateAirportsType: type: array description: Template airport details. maxItems: 4000 items: $ref: '#/components/schemas/templateAirportType' alternateHotelsCriteria: type: object description: Request object for creating new Alternate Hotels for hotels. properties: alternateHotels: description: Collection of Alternate Hotels to be created. $ref: '#/components/schemas/alternateHotelsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' totalType: type: object description: The total amount charged for the service including additional amounts and fees. properties: taxes: description: A collection of taxes. $ref: '#/components/schemas/taxesType' fees: description: A collection of fees or service charges. $ref: '#/components/schemas/feesType' description: type: string minLength: 0 maxLength: 2000 amountBeforeTax: description: The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). type: number amountAfterTax: description: The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). type: number currencyCode: description: The code specifying a monetary unit. Use ISO 4217, three alpha code. type: string minLength: 0 maxLength: 20 currencySymbol: description: The symbol for the currency, e.g, for currencyCode USD the symbol is $. type: string minLength: 0 maxLength: 10 decimalPlaces: description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85). type: integer code: description: Type of charge. type: string minLength: 0 maxLength: 20 rateOverride: description: When true indicates that the rate amount has been overridden. type: boolean taxesType: type: object description: A collection of taxes. properties: tax: description: An individual tax. type: array maxItems: 99 items: $ref: '#/components/schemas/taxType' amount: description: A monetary amount. type: number currencyCode: description: Provides a currency code to reflect the currency in which an amount may be expressed. type: string minLength: 3 maxLength: 3 yieldMarketTypesType: type: array description: List of Yield Market Type to be configured or fetched maxItems: 4000 items: $ref: '#/components/schemas/yieldMarketTypeType' hotelFeatureType: type: object description: Base details used for amenities. properties: description: description: The description about amenity of the hotel. type: string minLength: 0 maxLength: 2000 comments: description: The comments about amenity of the hotel. type: string minLength: 0 maxLength: 2000 featureCode: description: Specifies the feature code (aka amenity code). type: string minLength: 0 maxLength: 20 orderSequence: description: Display Order sequence. type: number hours: description: The hours of operation of the amenity in the hotel. type: string minLength: 0 maxLength: 1000 priceRange: description: The price range of the amenity in the hotel. type: string minLength: 0 maxLength: 40 stayFutureListType: type: object description: A collection of reservation history details attached to Profiles. properties: reservationInfo: description: 'Additional reservation information attached to the profile . Eg : Future reservation details' type: array maxItems: 4000 items: $ref: '#/components/schemas/stayReservationInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer countryNameType: type: object description: Code for a country or a nationality. properties: value: type: string description: Used for Character Strings, length 0 to 200. minLength: 0 maxLength: 200 code: description: Code for a country or a nationality. type: string minLength: 0 maxLength: 20 airportType: type: object description: Base details of the airport. properties: description: description: Description of the airport. type: string minLength: 0 maxLength: 2000 distance: description: Distance from the hotel to the airport. type: number distanceType: description: Unit of distance for the Distance measurement. type: string minLength: 0 maxLength: 20 drivingTime: description: Driving time from the hotel to the airport. type: string minLength: 0 maxLength: 20 direction: description: Direction of the airport in relation to the hotel. type: string minLength: 0 maxLength: 2000 website: description: URL of the airport's website. type: string minLength: 0 maxLength: 100 transportationOptions: description: Transportation option available for the airport. type: array maxItems: 8 items: $ref: '#/components/schemas/transportationInfoType' sequence: description: Sequence number for displaying the airport. type: integer code: description: Airport code identifying the airport. type: string minLength: 0 maxLength: 3 hotelId: description: Hotel code that the airport belongs to. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' userDefinedFieldsType: type: object description: A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc. properties: characterUDFs: description: Collection of user defined fields of Character/String Type. $ref: '#/components/schemas/characterUDFsType' numericUDFs: description: Collection of user defined fields of Numeric Type. $ref: '#/components/schemas/numericUDFsType' dateUDFs: description: Collection of user defined fields of Date Type. $ref: '#/components/schemas/dateUDFsType' operaSettingsDetails: type: object description: The result element containing the requested application settings. properties: activeFunctions: description: Count of active property services functions. type: integer groups: description: Contains a collection of application settings for a particular group. type: array items: $ref: '#/components/schemas/applicationSettingGroupType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' relationshipAddressType: type: object description: Provides address information for a Relationship. properties: addressLine: description: When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence. type: array maxItems: 4 items: type: string minLength: 0 maxLength: 80 city: description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). type: string minLength: 0 maxLength: 40 postalCode: description: Post Office Code number. type: string minLength: 0 maxLength: 15 state: description: State or Province name (e.g., Texas). type: string minLength: 0 maxLength: 20 country: description: Country name (e.g., Ireland). type: string minLength: 0 maxLength: 200 resExpectedTimesType: type: object description: Holds the Arrival and Departure Time Information properties: reservationExpectedArrivalTime: description: Arrival Time type: string format: date-time reservationExpectedDepartureTime: description: Departure Time type: string format: date-time hotelDetailValuesType: type: array description: Collection of property level hotel detail values. maxItems: 4000 items: $ref: '#/components/schemas/hotelDetailValueType' operaParametersDetails: type: object description: The result element containing a collection of the requested application parameters. properties: parameters: description: Represents a single application parameter and its value. type: array items: $ref: '#/components/schemas/applicationSettingSimpleType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' additionalGuestAmountType: type: object properties: amount: $ref: '#/components/schemas/totalType' ageQualifyingCode: type: string enum: - ADULT - CHILD - OTHER - CHILDBUCKET1 - CHILDBUCKET2 - CHILDBUCKET3 - CHILDBUCKET4 - CHILDBUCKET5 meetingRoomsType: type: array description: List of meeting rooms of the hotel. maxItems: 4000 items: $ref: '#/components/schemas/meetingRoomType' hotelCalendarDayType: type: object description: Details of calendar entries for a specific day for a specific hotel. properties: dayType: description: Details of Day Type of that calendar day. $ref: '#/components/schemas/hotelCalendarDayTypeType' events: description: Details of an event on that calendar day. $ref: '#/components/schemas/hotelCalendarEventsType' date: description: Indicates a specific hotel for which the calendar is being represented. type: string format: date maxLength: 8 aRAccountStatusType: type: object description: Type for the Account Status. Status can be restricted and a message/description added to the Account. properties: restriction: description: The Restriction Code added on the Account. This is available when the functionality for adding restriction codes is ON. type: string minLength: 0 maxLength: 20 description: description: User defined status message on the Account. type: string minLength: 0 maxLength: 2000 restricted: description: Flag to indicate if the Account is restricted. type: boolean benefitType: type: object description: Basic information about membership benefit. properties: code: description: Benefit code associated with a membership. type: string minLength: 0 maxLength: 20 message: description: Processing message for membership benefit. type: string minLength: 0 maxLength: 4000 inactive: description: Indicates whether membership benefit is active or inactive. type: boolean yieldAdjustmentCodesToBeChanged: type: object description: Request object for changing existing Yield AdjustmentCodes Configurations. properties: yieldAdjustmentCodes: description: Yield AdjustmentCodes Configurations to be changed. $ref: '#/components/schemas/yieldAdjustmentCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' billingPrivilegesType: type: object description: This stores the information for Bed Tax Reporting. Mainly used in Maldives. properties: postingRestriction: description: Flag used by interface program during check in. type: boolean preStayCharging: description: Indicates if the reservation has charging privileges before arrival. type: boolean postStayCharging: description: Indicates if the reservation has charging privileges after checkout. type: boolean folioCloseDate: description: Date when folio was closed. This works with PostStayCharging flag. type: string format: date maxLength: 8 scheduledCheckout: description: Indicates if the guest is scheduled for automatic check out. type: boolean scheduledCheckoutTime: description: Time of automatic check out if guest is schedule for automatic check out. type: string format: date maxLength: 8 directBillAuthorized: description: If Direct bill is authorized this will hold User ID who authorized it. type: boolean videoCheckout: description: Indicates if the guest can do video checkout type: boolean allowAutoCheckin: description: Indicated if a new reservation should be created and automatically checked in whenever the room is checked out. Available for pseudo room types only. type: boolean autoSettlement: description: Indicates if the is a candidate for auto folio settlement. type: boolean autoSettlementType: description: The folio settlement type for auto folio settlement. type: string minLength: 0 maxLength: 40 autoSettlementFreq: description: The interval of days between each auto folio settlement. type: integer creditLimitAutoPay: description: Indicates if the reservation will be included in the Automatic Credit Limit Overages process and also be listed in the Credit Limit Overages screen results. type: boolean reservationTaxTypeInfo: type: object description: Provides information about the Tax Type. properties: hotelId: description: Code of the Hotel. type: string minLength: 0 maxLength: 20 code: description: Code of the Tax Type. type: string minLength: 0 maxLength: 20 description: description: Description of the Tax Type. type: string minLength: 0 maxLength: 2000 collectingAgentTax: description: A boolean flag for Collecting Agent Tax type: boolean printAutoAdjust: description: Print auto adjust information for this tax type on the tax exempt report. type: boolean reportExemptDays: description: Number of days after which the guest will be tax exempt. Only used for tax exempt report. type: integer reportTaxPercentage: description: Tax percentage. Only used for tax exempt report. type: number minimum: 0 maximum: 100 minimumLengthOfStay: description: Minimun Length of Stay. type: integer taxExemptNo: description: Tax exempt number on the profile. type: string minLength: 0 maxLength: 20 departmentsCriteria: type: object description: Request object for creating new departments. properties: departments: description: Departments to be created. $ref: '#/components/schemas/departmentsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateCountriesType: type: array description: Template of country details. maxItems: 4000 items: $ref: '#/components/schemas/templateCountryType' transportationTemplatesCriteria: type: object description: Request object for creating transportation templates. properties: transportationTemplates: $ref: '#/components/schemas/transportationTemplatesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' yieldAdjustmentCodeType: type: object description: Provides information about the Adjustment Codes. properties: hotelId: description: Code of the Hotel. type: string minLength: 0 maxLength: 20 code: description: Code of the Adjustment Codes. type: string minLength: 0 maxLength: 20 description: description: Description of the Adjustment Codes. type: string minLength: 0 maxLength: 40 type: description: Yield Adjustment Type. e.g. Per Stay for ST $ref: '#/components/schemas/yieldAdjustmentTypeType' amount: description: A monetary amount. type: number currencyCode: description: Provides a currency code to reflect the currency in which an amount may be expressed. type: string minLength: 3 maxLength: 3 managedBy: $ref: '#/components/schemas/managedByOptions' privacyInfoType: type: object description: Defines Privacy related information for the profile. properties: marketResearchParticipation: description: Indicates if the profile participates in market research. type: boolean lastPrivacyPromptDate: description: Indicate the last privacy prompt date of the guest. type: string format: date maxLength: 8 infoFromThirdParty: description: Indicates if the profile is ok getting info from third parties. type: boolean autoEnrollLoyaltyProgram: description: Indicates if the profile wishes to be automatically enrolled in the property's loyalty program. type: boolean allowPhone: description: Indicates if the profile wishes to allow phone calls. type: boolean allowSMS: description: Indicates if the profile wishes to allow SMS. type: boolean allowEmail: description: Indicates if the profile wishes to allow Email. type: boolean optInMailingList: description: Indicates if the profile wishes to opt in for Mailing List. type: boolean optInMarketResearch: description: Indicates if the profile wishes to opt in for Market Research. type: boolean optInThirdParty: description: Indicates if the profile wishes to opt in for Third Party. type: boolean optInAutoEnrollmentMember: description: Indicates if the profile wishes to opt in for Auto Enrolment Member. type: boolean optInPhone: description: Indicates if the profile wishes to opt in for Phone. type: boolean optInSms: description: Indicates if the profile wishes to opt in for SMS. type: boolean optInEmail: description: Indicates if the profile wishes to opt in for Email. type: boolean mealPlanCodeType: type: object description: Meal plan codes associated with the rate codes. properties: code: description: Meal plan code. type: string minLength: 0 maxLength: 40 included: description: Represents if the meal plan code is included in rate code or not. type: boolean breakfastIncluded: description: Represents if the meal plan code is available for breakfast or not. type: boolean lunchIncluded: description: Represents if the meal plan code is available for lunch or not. type: boolean dinnerIncluded: description: Represents if the meal plan code is available for dinner or not. type: boolean formattedTextTextType: type: object description: Provides text and indicates whether it is formatted or not. properties: value: type: string description: Property Value language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' configHotelAmenityType: type: object description: Base details used for amenities. properties: description: description: The description about amenity of the hotel. type: string minLength: 0 maxLength: 2000 comments: description: The comments about amenity of the hotel. type: string minLength: 0 maxLength: 2000 featureCode: description: Specifies the feature code (aka amenity code). type: string minLength: 0 maxLength: 20 orderSequence: description: Display Order sequence. type: number amenityType: description: The type of amenity (general or meeting) selected from the list of values. $ref: '#/components/schemas/amenityTypeType' beginDate: description: The date the amenity is scheduled to become active. type: string format: date maxLength: 8 endDate: description: The date the amenity is scheduled to become inactive. type: string format: date maxLength: 8 newAmenityCode: description: The new amenity code which is used in the change method. type: string minLength: 0 maxLength: 20 newBeginDate: description: The new date the amenity is scheduled to become active. type: string format: date maxLength: 8 hours: description: The hours of operation of the amenity in the hotel. type: string minLength: 0 maxLength: 1000 priceRange: description: The price range of the amenity in the hotel. type: string minLength: 0 maxLength: 40 hotelId: description: Specifies the hotel code for which the amenity is specified. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' departmentsToBeChanged: type: object description: Request object for updating departments. properties: departments: description: Departments to be modified. $ref: '#/components/schemas/departmentsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' profileCashieringType: type: object description: Contains cashiering related details for the profile properties: directBillingList: description: Contains the direct billing related information for the profile. type: array maxItems: 4000 items: $ref: '#/components/schemas/directBillingType' autoFolioSettlementType: description: Contains the auto folio settlement type for the profile. type: string minLength: 0 maxLength: 40 paymentDueDays: description: Ability to define on the account, the number of days after which the invoice should be paid. type: integer taxPercent1: description: Tax1 Percentage for Collecting Agent. type: integer taxPercent2: description: Tax2 Percentage for Collecting Agent. type: integer taxPercent3: description: Tax3 Percentage for Collecting Agent. type: integer taxPercent4: description: Tax4 Percentage for Collecting Agent. type: integer taxPercent5: description: Tax5 Percentage for Collecting Agent. type: integer arNoCentral: description: Account Receivables Central Number. type: string minLength: 0 maxLength: 20 referenceCurrency: description: Reference Currency. type: string minLength: 0 maxLength: 20 vATOffsetYN: description: VAT Offset Flag. type: string minLength: 0 maxLength: 1 currencyCode: description: The code specifying a monetary unit. Use ISO 4217, three alpha code. type: string minLength: 0 maxLength: 20 currencySymbol: description: The symbol for the currency, e.g, for currencyCode USD the symbol is $. type: string minLength: 0 maxLength: 10 decimalPlaces: description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85). type: integer hotelCodeListType: type: array description: Hotel code. maxItems: 4000 items: type: string minLength: 0 maxLength: 20 relationshipInfoType: type: object description: Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles. properties: changeRelationship: description: Information about the changes in relationship for the profile $ref: '#/components/schemas/changeRelationsType' relationshipProfile: description: Refer to Relationship Profile type document. $ref: '#/components/schemas/relationshipProfileType' masterAccountInfo: description: Refer to Master Profile type document. $ref: '#/components/schemas/masterAccountInfoType' id: description: Relationship identifier. type: string minLength: 0 maxLength: 80 relation: description: Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile). type: string minLength: 0 maxLength: 20 relationDescription: description: Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile). type: string minLength: 0 maxLength: 200 targetRelation: description: Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile). type: string minLength: 0 maxLength: 20 targetRelationDescription: description: Displays the description of the target relation(Target Profile). type: string minLength: 0 maxLength: 200 generalNotesType: type: array description: Collection of general notes about the Hotel. maxItems: 4000 items: $ref: '#/components/schemas/generalNoteType' authorizationRuleType: type: object description: Configured rule for computing the amount to authorize. properties: code: description: The authorization rule code. type: integer pattern: '[0-9]{1,9}' amount: description: The amount applicable to the authorization rule. $ref: '#/components/schemas/currencyAmountType' percent: description: A percentage value if the authorization rule is percentage based. type: number templateHotelDetailsType: type: array description: Collection of template level hotel details. maxItems: 4000 items: $ref: '#/components/schemas/templateHotelDetailType' turndownStatusType: type: string description: Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Completed. enum: - Required - NotRequired - Compeleted guestHousekeepingServiceRequestType: type: string description: Possible values for the Guest Service Status. enum: - DoNotDisturb - MakeUpRoom - NoStatusSelected webUserHistoryType: type: object description: Creation date time, Creator Id, last modification date time and last Modifier Id. properties: createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 lastLogin: description: Last login date. type: string format: date maxLength: 8 lastPasswordChange: description: Last Password change date. type: string format: date maxLength: 8 inactiveDate: description: Inactive date. type: string format: date maxLength: 8 hotelEventSpacesType: type: object description: The Detail and Summary info of event space about the hotel properties: eventSpaceDetails: description: Even Space Detail information of the hotel. $ref: '#/components/schemas/hotelEventSpaceDetailsType' eventSpaceSummaries: description: Event Space Summary information of the hotel. $ref: '#/components/schemas/hotelEventSpaceSummariesType' setupStyles: description: List of hotel setup style codes of the hotel. $ref: '#/components/schemas/hotelSetupStylesType' hotelConferenceRoomType: type: object description: Information about the Conference rooms in the hotel. properties: roomName: description: The name of the Restaurant. type: string minLength: 0 maxLength: 1000 roomType: description: The Type of Restaurant. type: string minLength: 0 maxLength: 1000 roomCode: type: string minLength: 0 maxLength: 20 templateDayTypeCodesCriteria: type: object description: Request object for creating new template day type codes. properties: templateDayTypeCodes: description: Collection of template day type codes to be created. $ref: '#/components/schemas/templateDayTypeCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' creditCardTypesType: type: array description: List of Credit Card Types. maxItems: 4000 items: $ref: '#/components/schemas/creditCardTypeType' telephoneBookEntriesCriteria: type: object description: Request object for Telephone Book Entries. properties: telephoneBookEntries: description: Telephone Book Entries to be created. $ref: '#/components/schemas/telephoneBookEntriesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' negotiatedInfoType: type: object description: This provides information for a profile negotiated rate. properties: corporateAgreementId: description: The master identifier for multiple offices/locations under the same company profile. This is optional type: string minLength: 0 maxLength: 80 comissionCode: description: Informational purposes only in numeric format. type: string minLength: 0 maxLength: 20 order: description: The sell order. type: integer inactive: description: Negotiated Rate is inactive or not type: boolean start: description: The starting value of the date range. type: string format: date maxLength: 8 end: description: The ending value of the date range. type: string format: date maxLength: 8 hotelUserDefinedFieldType: type: object description: User defined information(UDF) for the hotel. properties: category: description: The UDF Category for this information. type: string minLength: 0 maxLength: 2000 infoType: description: The UDF Type for this information. type: string minLength: 0 maxLength: 60 information: description: The UDF attribute for this information. type: string minLength: 0 maxLength: 60 reservationInfoType: type: object description: The Reservation class contains the current reservation being created or altered. properties: reservationIdList: description: Unique identifiers for the reservation for both internal and external systems $ref: '#/components/schemas/reservationIdList' externalReferences: description: External Reference information for Reservation. $ref: '#/components/schemas/externalReferencesType' roomStay: description: Collection of room stays. $ref: '#/components/schemas/stayInfoType' reservationGuest: description: Collection of guests associated with the reservation. $ref: '#/components/schemas/resGuestInfoType' sharedGuests: description: Collection of guests who share this reservation. $ref: '#/components/schemas/resSharedGuestListType' attachedProfiles: description: List of attached profiles $ref: '#/components/schemas/resAttachedProfileListType' reservationPaymentMethod: description: Payment method used for this reservation $ref: '#/components/schemas/reservationPaymentMethodType' reservationFolioWindows: description: Collection of reservation folio windows. $ref: '#/components/schemas/reservationFolioWindowsType' specials: description: Set of reservation preferences which belongs to the Specials group. type: string minLength: 0 maxLength: 4000 lastPrivacyPromptDate: description: Last Privacy Prompt Date type: string format: date maxLength: 8 displayColor: description: Color setting of the reservation. type: string minLength: 0 maxLength: 20 reservationIndicators: description: Indicators of additional information attached to the reservation $ref: '#/components/schemas/indicatorsType' roomStatus: description: Current room status $ref: '#/components/schemas/housekeepingRoomStatusType' searchMatches: description: Super Search matching terms. $ref: '#/components/schemas/searchMatchesType' sourceOfSale: description: Point of Sale of reservation. Identifies the entity/channel who made the reservation. $ref: '#/components/schemas/sourceOfSaleType' waitlist: description: Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is not in Waitlist status anymore. $ref: '#/components/schemas/waitlistResType' queue: description: Information about the time and duration this reservation was on Queue for Checkin. $ref: '#/components/schemas/reservationQueueInformationType' housekeeping: description: Information regarding housekeeping for this reservation. $ref: '#/components/schemas/resHousekeepingType' cashiering: description: Holds cashiering related information for the reservation. $ref: '#/components/schemas/resCashieringType' taxType: description: This stores the code for the type of tax calculation especially with tax exemption, etc. $ref: '#/components/schemas/taxTypeType' deposit: description: Holds reservation deposit information. $ref: '#/components/schemas/reservationDepositType' allowedActions: description: Collection of reservation allowed actions. $ref: '#/components/schemas/reservationAllowedActionsType' revenuesAndBalances: description: Revenues and Balances Amount summary for the reservation. $ref: '#/components/schemas/resRevenueBalanceType' hotelInterfaceStatusList: description: Collection of Hotel Interfaces and rights, this is populated only when fetching interface status for rooms. type: array maxItems: 4000 items: $ref: '#/components/schemas/reservationInterfaceStatusType' guestPreferredCurrency: description: Currency code preferred by guest. type: string minLength: 0 maxLength: 20 turndownInfo: description: Currency code preferred by guest. $ref: '#/components/schemas/reservationTurndownInfoType' mobileNotifications: description: Denotes the status of Room Ready, Key Ready messages. $ref: '#/components/schemas/resMobileNotificationsType' reservationCommunication: description: Collection of reservation communication details. $ref: '#/components/schemas/resCommunicationType' advanceCheckIn: description: Information relating to Reservation's Advance Checked In state and Expected Time of Return $ref: '#/components/schemas/advanceCheckInType' welcomeOffer: description: This flag will determine wheather the reservation is eligible for Welcome Offer or not. type: boolean cancellationInfo: description: Information regarding why reservation has been/was cancelled. type: object properties: description: type: string minLength: 0 maxLength: 2000 code: type: string minLength: 0 maxLength: 20 date: description: Date when reservation was last cancelled. type: string format: date maxLength: 8 keyCount: description: Number of keys created for the reservation. type: integer hotelId: type: string minLength: 0 maxLength: 20 hotelName: type: string minLength: 0 maxLength: 80 expectedServiceTime: type: string minLength: 0 maxLength: 20 roomStayReservation: description: Boolean True if this reservation is reserving rooms. False if it is only reserving services. type: boolean createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 reservationStatus: description: Indicates the status of the reservation. $ref: '#/components/schemas/pMS_ResStatusType' computedReservationStatus: description: Indicates the status of the reservation. $ref: '#/components/schemas/pMS_ResStatusType' walkInIndicator: description: When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in. type: boolean accessRestriction: description: Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both. $ref: '#/components/schemas/resAccessRestrictionType' commissionPayoutTo: description: If not null, reservation is considered to pay out commission to either Travel Agent, Source or both. $ref: '#/components/schemas/commissionPayoutToType' paymentMethod: description: Payment Method. type: string minLength: 0 maxLength: 20 preRegistered: description: Defines if the reservation is pre-registered or not. type: boolean openFolio: description: Returns true when reservation has an open folio. type: boolean allowMobileCheckout: description: Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false. type: boolean allowMobileViewFolio: description: Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device. type: boolean optedForCommunication: description: Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation. type: boolean templateHotelDetailsToBeChanged: type: object description: Request object for changing hotel details at the template level. properties: templateHotelDetails: description: Collection containing information of hotel details to be changed at the template level. $ref: '#/components/schemas/templateHotelDetailsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' airportsType: type: array description: Airport details for a hotel. maxItems: 4000 items: $ref: '#/components/schemas/airportType' telephoneBookEntriesDetails: type: object description: Response object for fetch Telephone Book Entries. properties: telephoneBookEntries: description: Collection of telephone book entries. $ref: '#/components/schemas/telephoneBookEntriesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateAirportsToBeChanged: type: object description: Request object for modifying template airports. properties: templateAirports: description: Collection of template airports to be modified. $ref: '#/components/schemas/templateAirportsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipEarningPreferenceType: type: string description: The earning preference of a membership, it depends on the type of property. eg. when the property is a airline it should be Miles, other than Points. enum: - Points - Miles foreignExchangeType: type: object description: Foreign Exchange info. properties: type: description: Exchange Type for the postings. type: string minLength: 0 maxLength: 20 effectiveDate: description: Effective Exchange date for the foreign currency posting. type: string format: date maxLength: 8 hotelRestaurantsToBeChanged: type: object description: Request object for changing hotel restaurants for hotels. properties: hotelRestaurants: description: Collection of restaurants to be modified. $ref: '#/components/schemas/hotelRestaurantsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' eCertificateType: type: object description: E-Certificates details. properties: certificateId: description: System generated unique certificate id. type: integer voucherNo: description: System generated unique voucher number. type: string minLength: 0 maxLength: 40 certificateNo: description: Printed certificate no. This has to be unique. type: string minLength: 0 maxLength: 40 eCertificateInfo: $ref: '#/components/schemas/eCertificateInfoType' expiryDate: description: Date of expiry. type: string format: date maxLength: 8 newExpiryDate: description: New Date of expiry to extend e-certificate. type: string format: date maxLength: 8 profileId: description: NameId. $ref: '#/components/schemas/profileId' consumptionDetail: $ref: '#/components/schemas/eCertificateConsumptionType' status: description: Status of the certificate. $ref: '#/components/schemas/eCertificateStatusType' printed: description: Print status of the certificate. type: boolean inactiveDate: description: Date the record was marked as inactive. type: string format: date maxLength: 8 awardId: description: AwardID. $ref: '#/components/schemas/awardId' databaseId: description: External reference from which the record is created. type: string minLength: 0 maxLength: 20 source: description: Source of e-certificate. $ref: '#/components/schemas/eCertificateIssueSourceType' issueType: description: Process action issued the certificate. valid values are assigned (a),opt in (o) and purchased (p). $ref: '#/components/schemas/eCertificateIssueType' issueDate: description: Date when certificate was issued. type: string format: date maxLength: 8 awardPoints: description: Award points if any in case of certificate use membership award. type: integer generationDetail: $ref: '#/components/schemas/eCertificateGenerationType' originalVoucherNo: description: In case of in lieu of certificate this will contain the original voucher no. type: string minLength: 0 maxLength: 40 originalCertificateNo: description: In case of in lieu of certificate this will contain the original certificate no. type: string minLength: 0 maxLength: 40 inLieuSequence: description: Seq of the in lieu of certificate. 1..n. original certificate will be treated as null = 0. type: integer cancelRequestDate: description: Date on which the cancellation was requested. type: string format: date maxLength: 8 extensionCount: description: Number of times e-certificate is already extended. type: integer resCashieringType: type: object description: Cashiering Information for the reservation. properties: revenuesAndBalances: description: Revenues and Balances Amount summary for the reservation. $ref: '#/components/schemas/resRevenueBalanceType' billingPrivileges: description: Billing privileges set on the reservation. $ref: '#/components/schemas/billingPrivilegesType' taxType: description: This stores the code for the type of tax calculation especially with tax exemption, etc. $ref: '#/components/schemas/reservationTaxTypeInfo' bedTaxReporting: description: This stores the information for Bed Tax Reporting. Mainly used in Maldives. $ref: '#/components/schemas/bedTaxReportingType' folioTexts: description: Additional text fields to display on the folio. $ref: '#/components/schemas/folioTextsType' periodicFolio: description: Information regarding periodic folios set on the reservation. $ref: '#/components/schemas/resPeriodicFolioType' compAccounting: description: Information regarding comp accounting on the reservation. $ref: '#/components/schemas/resCompAccountingType' reservationPreConfiguredRoutingInstruction: description: Information regarding the selected preconfigured routing instruction on the reservation. $ref: '#/components/schemas/resPreConfiguredRoutingInstrType' financiallyResponsible: description: The guest from whom payment has to be recovered (direct guest). type: boolean proratedBilling: description: In case of Appartment style billing indicates whether a prorated amount should be used for an Apartment Style Billing rate. type: boolean lastRoomAndTaxPostedDate: description: Date of the last Room And Tax posting. Used primarily to know the date in case of Advance Billing. type: string format: date maxLength: 8 reverseCheckInAllowed: description: This attribute is to verify if reverse check-in is allowed for the reservation. type: boolean reverseAdvanceCheckInAllowed: description: This attribute is to verify if reverse advance check-in is allowed for the reservation. type: boolean transactionsPosted: description: Specifies whether reservation has a financial transaction associated with it. type: boolean meetingRoomType: type: object description: Information about the meeting rooms of the hotel. properties: code: description: the code of the meeting room type: string minLength: 0 maxLength: 20 charge: description: The charge for the meeting room. type: string minLength: 0 maxLength: 40 description: description: A description of the meeting room. type: string minLength: 0 maxLength: 200 reservationDepositType: type: object description: Reservation Deposit Type. properties: amountRequired: description: Deposit Amount Required. type: number amountPaid: description: Deposit Amount Paid. type: number amountOwed: description: Deposit Amount Owed. type: number dueDate: description: Deposit Due Date. type: string format: date maxLength: 8 postingDate: description: Deposit Posting Date. type: string format: date maxLength: 8 hasPaid: description: Resolves whether reservation has paid deposit. type: boolean hasOutstanding: description: Resolves whether reservation has outstanding deposit. type: boolean profileMembershipType: type: object description: Detailed information of the memberships. properties: comment: description: Additional comments regarding to the membership. $ref: '#/components/schemas/paragraphType' newMembershipNumber: description: Card Number of the membership. type: string nameOnCard: description: Name to be displayed on the membership card. type: string programDescription: description: Description of the membership program. type: string membershipLevel: description: Indicates the membership level. type: string membershipLevelDescription: description: Indicates the membership level description. type: string minLength: 0 maxLength: 200 membershipClass: description: Indicates the membership class. type: string earningPreference: description: Earning preference to the membership. $ref: '#/components/schemas/membershipEarningPreferenceType' inactive: description: Indicates whether membership is active or inactive. type: boolean benefits: description: benefits for the membership. $ref: '#/components/schemas/benefitsType' tierAdministration: description: Defines the degree of participation for this membership in the tier management portion of the program. $ref: '#/components/schemas/tierAdministrationType' downgrade: description: Defines how downgrading will be handled for this membership. $ref: '#/components/schemas/downgradeType' reIssueNewCard: description: The status of issuing new membership card to the member. $ref: '#/components/schemas/cardReIssueType' excludeFromBatch: description: True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false. type: boolean upgradeDescription: description: Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade. type: string minLength: 0 maxLength: 32000 downgradeDescription: description: Indicates information regarding the member's possible downgrades. type: string minLength: 0 maxLength: 32000 rating: description: Value Rating Type Description for this membership. type: string membershipEnrollmentCode: description: Indicates how the guest enrolled in the program. type: string minLength: 0 maxLength: 20 memberStatus: description: Indicates where the guest is in the membership enrollment process. type: string minLength: 0 maxLength: 20 currentPoints: description: Profile MemberShip Points. type: number pointsLabel: description: Label used to refer to points for this membership type type: string minLength: 0 maxLength: 20 enrollmentSource: description: Source from where the enrollment is done. type: string minLength: 0 maxLength: 20 enrollmentResort: description: Resort/CRO where enrollment is done. type: string minLength: 0 maxLength: 20 preferredCard: description: Preferred Card. type: boolean membershipId: description: Card Number of the membership. type: string membershipType: description: Type of membership. type: string primaryMembershipYn: description: Indicator if Membership is a Primary Membership. type: string minLength: 0 maxLength: 1 primaryMembership: description: Boolean indicator set to True implies membership is a Primary Membership. type: boolean membershipIdNo: description: Membership ID Number. type: integer playerRanking: description: Ranking assigned to the Player Profile by the Gaming system. type: integer centralSetup: description: Indicates how the award points for this membership type will be managed. type: boolean signupDate: description: Indicates when the member signed up for the loyalty program. type: string format: date maxLength: 8 effectiveDate: description: Indicates the starting date. type: string format: date maxLength: 8 expireDate: description: Indicates the ending date. type: string format: date maxLength: 8 expireDateExclusiveIndicator: description: When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14). type: boolean orderSequence: description: Display Order sequence. type: number createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 reservationPaymentMethodType: type: object properties: paymentCard: $ref: '#/components/schemas/resPaymentCardType' balance: $ref: '#/components/schemas/currencyAmountType' authorizationRule: $ref: '#/components/schemas/authorizationRuleType' emailFolioInfo: description: Information on an email for the customer. type: object properties: email: description: eMail deatils for the profile. $ref: '#/components/schemas/emailType' emailFolio: type: boolean id: 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 minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 paymentMethod: type: string minLength: 0 maxLength: 20 description: type: string minLength: 0 maxLength: 2000 folioView: type: integer mealPlansType: type: array description: Meal plan codes associated with the rate codes. maxItems: 4000 items: $ref: '#/components/schemas/mealPlanCodeType' hotelCorporateInformationsType: type: object description: Corporate information details of the property properties: brandCode: type: string minLength: 0 maxLength: 20 hotelCategory: type: string minLength: 0 maxLength: 20 businessUnit: $ref: '#/components/schemas/primaryCodesType' departmentCode: $ref: '#/components/schemas/primaryCodesType' division: $ref: '#/components/schemas/primaryCodesType' opertingUnit: $ref: '#/components/schemas/primaryCodesType' hotelCalendarEventType: type: object description: Details of event. properties: code: description: Code for a specific event. type: string minLength: 0 maxLength: 20 description: description: Description for a specific event. type: string minLength: 0 maxLength: 20 eventTitle: description: Event title for the event code. type: string minLength: 0 maxLength: 50 eventDetails: description: 'Details ' type: string minLength: 0 maxLength: 4000 startTime: description: Start time of the event.Uses the hotel's time zone. type: string format: date-time endTime: description: End time of the event.Uses the hotel's time zone. type: string format: date-time allDay: description: Indicates if it is an all day event type: boolean webLink: description: Stores the text and url values $ref: '#/components/schemas/webLinkDetails' location: description: 'Location value ' type: string minLength: 0 maxLength: 2000 availability: description: 'Availability of the slots for the events ' type: string minLength: 0 maxLength: 150 blackoutEvent: description: Indicates if it is a black out event type: boolean eventImage: type: string format: byte description: Image related to the event folioTextsType: type: array description: This stores the description for the type of tax calculation especially with tax exemption, etc. maxItems: 2 items: type: object properties: text: description: Additional text field to display on the folio. type: string minLength: 0 maxLength: 50 row: description: Row number of the additional text. type: integer hotelCalendarDetails: type: object description: Response object for fetching calendar entries for a hotel. properties: hotelCalendar: description: Collection of hotel level calendar entries. $ref: '#/components/schemas/hotelCalendarType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' directionType: type: object description: Direction details to get into Hotel. properties: description: description: Description about the Hotel direction. type: string minLength: 0 maxLength: 4000 title: description: Title of Hotel direction. type: string minLength: 0 maxLength: 200 telephoneInfoType: type: object description: Information on a telephone number for the customer. properties: telephone: description: Phone details for the profile. $ref: '#/components/schemas/telephoneType' id: 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 minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 currencyExchangeRateType: type: object description: Currency code configuration. properties: currencyCode: description: The code specifying a monetary unit. Use ISO 4217, three alpha code. type: string minLength: 0 maxLength: 20 currencySymbol: description: The symbol for the currency, e.g, for currencyCode USD the symbol is $. type: string minLength: 0 maxLength: 10 decimalPlaces: description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85). type: integer description: description: Description of the currency code. type: string minLength: 0 maxLength: 2000 exchangeRate: description: Exchange Rate for the currency code. Exchange rate is based on the current business date of the property. $ref: '#/components/schemas/currencyAmountType' templateMarketingCitiesCriteria: type: object description: Request object for creating new template marketing cities. properties: templateMarketingCities: description: Collection of template marketing cities to be created. $ref: '#/components/schemas/templateMarketingCitiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' timeSpanDaysOfWeekType: type: object description: Container for Time span with days of week. properties: timeSpan: $ref: '#/components/schemas/timeSpanType' sunday: type: boolean monday: type: boolean tuesday: type: boolean wednesday: type: boolean thursday: type: boolean friday: type: boolean saturday: type: boolean templateHotelDetailsDetails: type: object description: Response object for fetching hotel details at the template level. properties: templateHotelDetails: description: Collection of hotel details specified at the template level. $ref: '#/components/schemas/templateHotelDetailsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateMarketingCityConfigType: type: object description: Base details of the marketing city. properties: description: description: Description of the marketing city. type: string minLength: 0 maxLength: 2000 distance: description: Distance from the hotel to the marketing city. type: number distanceType: description: Unit of distance for the Distance measurement. type: string minLength: 0 maxLength: 20 drivingTime: description: Driving time from the hotel to the marketing city. type: string minLength: 0 maxLength: 100 direction: description: Direction of the marketing city in relation to the hotel. type: string minLength: 0 maxLength: 20 sequence: description: Sequence number for displaying the marketing city. type: integer inactive: description: Flag to indicate whether the marketing city is inactive or not. type: boolean marketingCity: description: Marketing city code. type: string minLength: 0 maxLength: 40 regionCode: description: Region that the marketing city belongs to. type: string minLength: 0 maxLength: 20 newRegionCode: description: New region code to change the marketing city to. Template marketing cities allow editing of the region code. Because this is a key field we need to retain the original region code to locate the appropriate record to update. The original region code element is located in MarketingCityBaseType. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' waitlistResType: type: object description: Information regarding why reservation is being /has been waitlisted. properties: reasonDescription: description: Waitlist Reason Description. type: string minLength: 0 maxLength: 2000 priorityDescription: description: Waitlist priority Description. type: string minLength: 0 maxLength: 2000 description: description: Description why the reservation is being /has been waitlisted. type: string minLength: 0 maxLength: 2000 reasonCode: description: Waitlist Reason Code. type: string minLength: 0 maxLength: 20 priorityCode: description: Waitlist Priority Code. type: string minLength: 0 maxLength: 20 telephone: description: Guest telephone number. type: string minLength: 0 maxLength: 40 copyConfigurationCodeType: type: object description: Information needed to copy configuration code from one property to the other. properties: targetHotelCode: description: Property to which configuration code type to be copied to. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 sourceHotelCode: description: Code that is to be copied. type: string minLength: 0 maxLength: 20 code: description: Source hotel code from which code is to be copied from. type: string minLength: 0 maxLength: 20 hotelPackageType: type: object description: Information about the packages of the hotel. properties: packageName: description: The name of the package. type: string minLength: 0 maxLength: 2000 beginDate: description: The begin date of the package. type: string format: date maxLength: 8 endDate: description: The end date of the package. type: string format: date maxLength: 8 packagePrice: description: The price of the package. type: number rateCode: description: Indicates the rate code for the package. type: string minLength: 0 maxLength: 20 pointsRequired: description: Indicates the required membership points for the package. type: number packageCode: type: string minLength: 0 maxLength: 20 hotelCalendarDayTypeType: type: object description: Details of Day Type. properties: code: description: Code of the Day Type type: string minLength: 0 maxLength: 20 description: description: Description of the Day Type. type: string minLength: 0 maxLength: 20 color: description: Associated color for the selected Day Type. $ref: '#/components/schemas/colorType' activityLogListType: type: object properties: activityLog: type: array maxItems: 4000 items: $ref: '#/components/schemas/activityLogType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer hotelNotesToBeChanged: type: object description: Request object for changing hotel Notes for hotels. properties: hotelNotes: description: Collection of Hotel Notes to be modified. $ref: '#/components/schemas/hotelNotesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelDayTypeCodesCriteria: type: object description: Request object for creating new day type codes for a hotel. properties: hotelDayTypeCodes: description: Collection of hotel day type codes to be created. $ref: '#/components/schemas/hotelDayTypeCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelCalendarType: type: object description: Represents the calendar with individual days having corresponding entries (day type, event, etc.) for a hotel. properties: calendarDay: description: Entries for a specific calendar day. type: array maxItems: 4000 items: $ref: '#/components/schemas/hotelCalendarDayType' hotelId: description: Indicates a specific hotel for which the calendar is being represented. type: string minLength: 0 maxLength: 20 hotelBrochureDetails: type: object description: Response object for fetching Basic Property information. properties: hotelBrochure: $ref: '#/components/schemas/hotelBrochureType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateDayTypeCodeType: type: object description: Base structure for Day Type Code at both template and hotel levels. properties: code: description: Code of a Day Type. type: string minLength: 0 maxLength: 20 description: description: Description of a Day Type. type: string minLength: 0 maxLength: 100 multiplier: description: Value by which the rates will be multiplied on a day. type: number adder: description: Value that will be added to rate on a day. type: number color: description: Color used to represent Day Type. $ref: '#/components/schemas/colorType' sellSequence: description: Sell sequence for a Day Type. type: number managedBy: $ref: '#/components/schemas/managedByOptions' identificationInfoType: type: object description: Information on the identification of the customer. properties: identification: description: Detailed information on the identification of the customer. $ref: '#/components/schemas/identificationType' id: 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 minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 yieldMarketTypesCriteria: type: object description: Request object for creating new Yield Market Types. properties: code: description: Yield Market Code. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel code for which the yield market type belong to. type: string minLength: 0 maxLength: 20 description: description: Description for the yield market code. type: string minLength: 0 maxLength: 200 alternativeCode: description: If the yield market code does not return a result, this alternative yield market code is used instead. type: string minLength: 0 maxLength: 20 default: description: Indicates the default yield market type. type: boolean links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' masterInfoCodeDetailType: type: string enum: - LongDescription - ShortDescription profileRestrictions: type: object properties: reason: description: Restriction reason associated with the current profile. type: string minLength: 0 maxLength: 20 reasonDescription: description: Description of restriction reason. type: string minLength: 0 maxLength: 2000 restricted: description: True indicates there are restrictions associated with the current profile. type: boolean marketingCitiesToBeChanged: type: object description: Request object for modifying marketing cities for hotels. properties: marketingCities: description: Collection of marketing cities to be modified. $ref: '#/components/schemas/marketingCitiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelEventCodesType: type: array description: Collection of hotel events. maxItems: 4000 items: $ref: '#/components/schemas/hotelEventCodeType' yieldMarketTypeType: type: object description: Details for Yield Market Type. properties: code: description: Yield Market Code. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel code for which the yield market type belong to. type: string minLength: 0 maxLength: 20 description: description: Description for the yield market code. type: string minLength: 0 maxLength: 200 alternativeCode: description: If the yield market code does not return a result, this alternative yield market code is used instead. type: string minLength: 0 maxLength: 20 default: description: Indicates the default yield market type. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' sellMessagesType: type: object description: The SellMessagesType is the list of message and attributes returned by web service. properties: sellMessage: description: This is the message text. type: array maxItems: 4000 items: $ref: '#/components/schemas/sellMessageType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer promotionType: type: object description: Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation. properties: promotionCode: description: Promotion code associated with the rate plan. type: string minLength: 0 maxLength: 20 promotionName: description: Promotion code Name associated with the rate plan. type: string minLength: 0 maxLength: 20 couponCode: description: Promotion Coupon Code when promotion is setup to have a valid coupon code. type: string minLength: 0 maxLength: 40 templateAirportType: type: object description: Base details of the airport. properties: description: description: Description of the airport. type: string minLength: 0 maxLength: 2000 distance: description: Distance from the hotel to the airport. type: number distanceType: description: Unit of distance for the Distance measurement. type: string minLength: 0 maxLength: 20 drivingTime: description: Driving time from the hotel to the airport. type: string minLength: 0 maxLength: 20 direction: description: Direction of the airport in relation to the hotel. type: string minLength: 0 maxLength: 2000 website: description: URL of the airport's website. type: string minLength: 0 maxLength: 100 transportationOptions: description: Transportation option available for the airport. type: array maxItems: 8 items: $ref: '#/components/schemas/transportationInfoType' sequence: description: Sequence number for displaying the airport. type: integer code: description: Airport code identifying the airport. type: string minLength: 0 maxLength: 3 managedBy: $ref: '#/components/schemas/managedByOptions' templateCountriesCriteria: type: object description: Request object for creating new template Countries. properties: templateCountries: description: Collection of template of Countries to be created. $ref: '#/components/schemas/templateCountriesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' jobTitlesType: type: array description: Job Title details for a hotel. maxItems: 4000 items: $ref: '#/components/schemas/jobTitleType' primaryCodeType: type: object description: Primary flag with code and description. properties: primary: type: boolean codeDescription: $ref: '#/components/schemas/codeDescriptionType' configLanguagesType: type: array description: This type holds a collection of languages. maxItems: 4000 items: $ref: '#/components/schemas/configLanguageType' setDayTypes: type: object description: Request object for setting day type for specified date range. properties: hotelDayTypes: description: Collection of day type entries to be created for specified date range. $ref: '#/components/schemas/hotelDayTypesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateJobTitlesCriteria: type: object description: Request object for creating new template job titles. properties: templateJobTitles: description: Collection of template job titles to be created. $ref: '#/components/schemas/templateJobTitlesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyDepartments: type: object properties: departments: type: array description: List of the departments to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' centralConfigRequest: type: object properties: configuration: $ref: '#/components/schemas/centralConfig' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyMarketingCitiesType: type: object description: Copy instructions for template marketing cities to hotel(s). properties: hotelCodes: description: Hotel codes to copy the marketing city templates to. $ref: '#/components/schemas/codeListType' templateMarketingCities: description: Marketing city template to be copied to the hotel(s). type: array maxItems: 4000 items: $ref: '#/components/schemas/templateMarketingCityInfoType' telephoneBookCategoriesToBeChanged: type: object description: Request object for Telephone Book Category. properties: telephoneCategories: description: Collection of telephone categories to change. $ref: '#/components/schemas/telephoneCategoriesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' transportationCodeType: type: object description: Transportation Code available from Airport to the Hotel. properties: code: type: string minLength: 0 maxLength: 20 channelSummaryInfoType: type: object description: Depicts channel information such as the type and code. properties: bookingChannel: $ref: '#/components/schemas/bookingChannelType' messageId: description: Indicates the transaction identifier. type: string summaryOnly: description: Used to indicate whether to return summarized or detailed rate room information. type: boolean operationResponse: type: object properties: configs: type: array description: Collection of Operation Details maxItems: 4000 items: $ref: '#/components/schemas/operation' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateMarketingCitiesToBeChanged: type: object description: Request object for modifying template marketing cities. properties: templateMarketingCities: description: Collection of template marketing cities to be modified. $ref: '#/components/schemas/templateMarketingCitiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' operaAppUrlResponse: type: object properties: configs: type: array description: Collection of application url maxItems: 4000 items: $ref: '#/components/schemas/applicationUrl' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' yieldCategoriesDetails: type: object description: Response object for fetching Yield Category configurations. properties: yieldCategories: description: Collection of Yield Category configurations. $ref: '#/components/schemas/yieldCategoriesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' relationshipInfoSummaryType: type: object description: RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles. properties: relationshipProfile: description: Refer to Relationship Profile Summary type document. $ref: '#/components/schemas/relationshipProfileSummaryType' masterAccountDetails: description: Refer to Master Profile type document. $ref: '#/components/schemas/masterAccountInfoType' relationshipID: description: Relationship identifier. type: string minLength: 0 maxLength: 80 sourceRelation: description: Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile). type: string minLength: 0 maxLength: 20 sourceRelationDescription: description: Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile). type: string minLength: 0 maxLength: 200 targetRelation: description: Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile). type: string minLength: 0 maxLength: 20 targetRelationDescription: description: Displays the description of the target relation(Target Profile). type: string minLength: 0 maxLength: 200 resPeriodicFolioType: type: object description: Information regarding periodic folios set on the reservation. properties: lastSettlementDate: description: Latest date when a direct bill settlement was automatically done using the "Direct Bill Batch Folios" option. type: string format: date maxLength: 8 lastFolioDate: description: Latest date when a folio was printed using the "Periodic Batch Folios" option type: string format: date maxLength: 8 frequency: description: Frequency in number of days when folios should be printed for this reservation. type: integer resAttachedProfileListType: type: array maxItems: 4000 items: $ref: '#/components/schemas/resAttachedProfileType' eCertificateConsumptionType: type: object description: E-Certificates details. properties: hotelId: description: Property where certificate was consumed for. type: string minLength: 0 maxLength: 20 source: description: Source of consumption. $ref: '#/components/schemas/eCertificateConsumeSourceType' surname: description: Last name of the person who consumed the certificate.. type: string minLength: 0 maxLength: 40 firstName: description: First name of the person who consumed the certificate. type: string minLength: 0 maxLength: 40 middleName: description: Middle name of the person who consumed the certificate. type: string minLength: 0 maxLength: 40 email: description: Email of the person who consumed the certificate. type: string minLength: 0 maxLength: 2000 date: description: Date the certificate was consumed. type: string format: date maxLength: 8 userName: description: Application user who created the consumption. type: string minLength: 0 maxLength: 2000 userNotes: description: Any notes on the certificate entered at time of consumption. type: string minLength: 0 maxLength: 4000 referenceId: description: Any reference like reservation no etc against which the certificate was consumed. $ref: '#/components/schemas/uniqueID_Type' locationType: description: Consumption location type. type: string minLength: 0 maxLength: 20 authorizationCode: description: Authorization code for consumption. type: string minLength: 0 maxLength: 100 serviceDate: description: Date on which the service is due (arrival date in case of reservation). type: string format: date maxLength: 8 resGuestExternalInfoType: type: object description: Specifies Company or Travel Agent profile using IATA or Corp. No. properties: givenName: description: Given name, first name or names $ref: '#/components/schemas/givenNameType' surname: description: Family name, last name. $ref: '#/components/schemas/surnameType' relationshipProfileSummaryType: type: object properties: customerName: description: Name of the customer type: string minLength: 0 maxLength: 40 companyName: description: Name of the company. type: string minLength: 0 maxLength: 40 telephoneNumber: description: Telephone number assigned to a single location type: string minLength: 0 maxLength: 40 address: description: Information on address details for the customer/company $ref: '#/components/schemas/relationshipAddressType' emailAddress: description: Defines the e-mail address. type: string minLength: 0 maxLength: 2000 ownerCode: description: Unique Code to identify the owner. type: string minLength: 0 maxLength: 20 profileIdList: description: Original profile details for which the relationships was created $ref: '#/components/schemas/uniqueIDListType' primary: description: Indicates if this relationship is the primary relationship. type: boolean profileStatus: description: Status of the profile. Active/Inactive $ref: '#/components/schemas/profileStatusType' primaryOwnerCode: description: When true, this is a primary owner. type: boolean profileType: description: Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact. $ref: '#/components/schemas/profileTypeType' ownerResTypeType: type: string enum: - Owner - AuthorizedUser givenNameType: type: string description: Given name, first name or names minLength: 0 maxLength: 40 attractionsToBeChanged: type: object description: Request object for modifying an existing attraction. properties: attractions: description: Attraction group to be changed. $ref: '#/components/schemas/attractionCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' advanceCheckInType: type: object description: Information relating to Reservation's Advance Checked In state and Expected Time of Return properties: advanceCheckedIn: description: Indicates if the reservation is marked as Advance Checked In type: boolean expectedReturnTime: description: Expected Return Time type: string format: date-time eTRComments: description: ETR Comments type: string minLength: 0 maxLength: 2000 templateHotelDetailIDType: type: object description: Base details used for uniquely identifying a hotel detail. properties: code: description: Specifies the hotel detail code. type: string minLength: 0 maxLength: 20 category: description: Specifies the hotel detail category. type: string minLength: 0 maxLength: 20 companyInfoType: type: object description: Company Information of the Profile. properties: legalCompany: description: Legal Company. type: string minLength: 0 maxLength: 20 department: description: Department of the Profile. type: string minLength: 0 maxLength: 20 position: description: Business Title or Position of the profile. type: string minLength: 0 maxLength: 40 resRevenueBalanceType: type: object description: Revenue and Balance Amount summary for the reservation. properties: totalFixedCharge: description: Total Fixed Charges on the reservation. $ref: '#/components/schemas/currencyAmountType' totalPayment: description: Total payment received for the reservation. $ref: '#/components/schemas/currencyAmountType' roomRevenue: description: Room Revenue generated by the reservation. $ref: '#/components/schemas/currencyAmountType' foodAndBevRevenue: description: Food and Beverage Revenue generated by the reservation. $ref: '#/components/schemas/currencyAmountType' otherRevenue: description: Other Revenue generated by the reservation. $ref: '#/components/schemas/currencyAmountType' nonRevenue: description: Total Non Revenue posted on the reservation. $ref: '#/components/schemas/currencyAmountType' totalRevenue: description: Total Revenue generated by the reservation. $ref: '#/components/schemas/currencyAmountType' balance: description: Balance amount on the reservation. $ref: '#/components/schemas/currencyAmountType' compBalance: description: Comp Balance amount $ref: '#/components/schemas/currencyAmountType' imageSetType: type: object description: Represents on image set record. properties: language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' imageSet: description: The image set name. type: string minLength: 0 maxLength: 800 sequenceId: description: The image set sequence ID. type: integer imageStyle: description: The image set enumerated style. $ref: '#/components/schemas/imageStyleType' imageType: description: The image set type. type: string minLength: 0 maxLength: 80 hotelId: description: The image set hotel code. type: string minLength: 0 maxLength: 20 chainCode: description: The image set chain code. type: string minLength: 0 maxLength: 20 imageURL: description: The image set URL. type: string minLength: 0 maxLength: 2000 description: description: The image set description. type: string minLength: 0 maxLength: 2000 imageOrder: description: The image set order. type: integer website: description: The image set website. type: string minLength: 0 maxLength: 2000 copyYieldCategories: type: object properties: yieldCategories: type: array description: List of the Yield Category to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateDayTypeCodesToBeChanged: type: object description: Request object for modifying template day type codes. properties: templateDayTypeCodes: description: Collection of template day type codes to be changed. $ref: '#/components/schemas/templateDayTypeCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' facilityCodeType: type: object description: Facility Housekeeping Code, its description and quantity. properties: description: description: Facility Code. type: string minLength: 0 maxLength: 80 quantity: description: Signifies the quantity. type: integer code: description: Facility code value. type: string minLength: 0 maxLength: 20 eCertificateUsageCriteriaType: type: object description: E-Certificates details. properties: reservation: description: Indicates if certificate is to be used against reservation or not. type: boolean web: description: Indicates if web certificate can be consumed in OWS. type: boolean webAllowed: description: Indicates if certificate consumption allowable on the web. type: boolean benefit: description: Indicates to attach a rate code to the e-certificate as a benefit. type: boolean hotel: description: Indicates if web certificate can be consumed in hotel. type: boolean verifyCertificateNo: description: Specify if the certificate number verification is required at time of consumption or not. type: boolean cancelAllowed: description: Identify if cancel is allowed or not. type: boolean generateInLieuCertificate: description: Identify if in lieu of certificate can be generated or not. type: boolean alienInfoType: type: object description: immigration/visa information of a foreign person. properties: alienRegistrationNo: description: Alien Registration Number. type: string immigrationStatus: description: Immigration Status on an Alien. type: string minLength: 0 maxLength: 40 visaValidityType: description: Visa Type of an Alien. type: string minLength: 0 maxLength: 40 currentRoomInfoType: type: object description: Room information of the reservation for the current day. properties: roomType: description: Current room type. type: string minLength: 0 maxLength: 20 roomId: description: Current room number. type: string minLength: 0 maxLength: 20 suggestedRoomNumbers: description: Suggested room numbers. $ref: '#/components/schemas/codeListType' roomDescription: description: Current room description. type: string minLength: 0 maxLength: 2000 roomViewCode: description: Represents the room view code like City view, River view, Ocean view etc. type: string minLength: 0 maxLength: 40 assignedByAI: description: Represents the room was assigned by AI Room Assignment. type: boolean upgradedByAI: description: Represents the room was upgraded by AI Room Assignment. type: boolean centralConfig: type: object description: Type that holds Central Config properties: config: description: Configuarion Classification type: string minLength: 0 maxLength: 2000 code: description: Unique identifier of Configuation Item type: string minLength: 0 maxLength: 2000 status: type: string description: Status of the Configuation Item. hotelDayTypeCodesType: type: array description: Details for day type code at hotel level. maxItems: 4000 items: $ref: '#/components/schemas/hotelDayTypeCodeType' rateRangeType: type: object description: Rate Range details like maximum rate amount and minimum rate amount in each available rate category. properties: base: description: The base amount charged for the accommodation or service. type: array maxItems: 4000 items: $ref: '#/components/schemas/totalType' rateChange: description: Rate Change Indicator. type: boolean amountType: type: object description: Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentages, total amount, and the rate description. properties: base: description: 'The base amount charged for the accommodation or service per unit of time (ex: Nightly, Weekly, etc). If TaxInclusive is set to True, then taxes are included in the base amount. Note that any additional charges should itemized in the other elements.' $ref: '#/components/schemas/totalType' additionalGuestAmounts: description: Collection of incremental charges per age qualifying code for additional guests. Amount charged for additional occupant is with respect to age group of the base guests. type: array maxItems: 4000 items: $ref: '#/components/schemas/additionalGuestAmountType' discount: description: Discount percentage and/or Amount, code and textual reason for discount $ref: '#/components/schemas/discountType' shareRatePercentage: description: Indicates the share rate percentage for the reservation if set to CUSTOMSPLIT. type: number minimum: 0 maximum: 100 shareDistributionInstruction: description: Last rate share distribution instruction applied on share reservation daily rate segment. $ref: '#/components/schemas/shareDistributionInstructionType' total: description: The total amount charged for this rate including additional occupant amounts and fees. $ref: '#/components/schemas/totalType' requiredPoints: description: The Points contains the number of points required to book a particular room type. $ref: '#/components/schemas/pointsType' effectiveRate: description: The reservation effective amount charged for the accommodation or service (i.e. base amount + amount for Add to Rate Combine Line packages) per unit of time $ref: '#/components/schemas/totalType' start: description: The starting value of the date range. type: string format: date maxLength: 8 end: description: The ending value of the date range. type: string format: date maxLength: 8 languagesCriteria: type: object description: Request object for creating new language records. properties: languages: description: Collection containing details of languages to be created. $ref: '#/components/schemas/configLanguagesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' bedTaxReportingType: type: object description: This stores the information for Bed Tax Reporting. Mainly used in Maldives. properties: taxRegistrationNo: description: Tax Registration Number for Maldives Bed Tax Reporting. type: number visaNumber: description: Visa number used for Maldives Bed Tax Reporting type: string minLength: 0 maxLength: 40 visaIssueDate: description: Visa Issue Date used for Maldives Bed Tax Reporting. type: string format: date maxLength: 8 visaExpiryDate: description: Visa Expiration Date used for Maldives Bed Tax Reporting type: string format: date maxLength: 8 taxableDays: description: Number of days for which the Maldives tax is applicable. type: integer hotelRateRangeType: type: object description: The rate rage information of the hotel. properties: timeSpan: description: The Start Date and End Date of the Hotel rate range. $ref: '#/components/schemas/timeSpanType' minRate: description: Minimum Rate offered by the hotel. type: number maxRate: description: Maximum Rate offered by the hotel. type: number currencyCode: description: The base currency code for rate range(The currency code used by the hotel which the rate range belongs to). type: string minLength: 0 maxLength: 20 hotelId: type: string minLength: 0 maxLength: 20 eCertificateIssueSourceType: type: string description: Indicates that OPERA E-Certificate is issued by external system. enum: - Opera - Web - Interface templateAirportsDetails: type: object description: Response object for fetching template airports. properties: templateAirports: description: Collection of template airports. $ref: '#/components/schemas/templateAirportsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' amenitiesDetails: type: object description: Response object for fetching amenities at the property level. properties: hotelAmenities: description: Collection of amenities specified at the property level. $ref: '#/components/schemas/configHotelAmenitiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' interfaceRightsStatusType: type: object properties: right: description: Internal code for each allowed right of a Hotel Interface record. type: integer statusCode: description: User defined code for an Interface Right. type: string minLength: 0 maxLength: 5 description: description: User defined description for an Interface Right. type: string minLength: 0 maxLength: 80 category: description: Category code of this interface right. type: string minLength: 0 maxLength: 1 transportationTemplatesDetails: type: object description: Response object for fetching transportation templates. properties: transportationTemplates: $ref: '#/components/schemas/transportationTemplatesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateJobTitleType: type: object description: Base details common between both template and hotel job titles. properties: code: description: Job Title Code. type: string minLength: 0 maxLength: 20 description: description: Description of the job title. $ref: '#/components/schemas/translationTextType80' displayClosingScript: description: Flag to indicate if display reservation closing script. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' hotelDayTypesType: type: array description: Collection of type details. maxItems: 4000 items: $ref: '#/components/schemas/hotelDayTypeType' directionsType: type: array description: Collection of direction details to get into Hotel. maxItems: 4000 items: $ref: '#/components/schemas/directionType' stayReservationInfoType: type: object description: The Reservation class contains the current reservation being created or altered. properties: reservationIdList: description: Unique identifiers for the reservation for both internal and external systems $ref: '#/components/schemas/reservationIdList' roomStay: description: Collection of room stays. $ref: '#/components/schemas/stayInfoType' attachedProfiles: description: List of attached profiles $ref: '#/components/schemas/resAttachedProfileListType' hotelId: type: string minLength: 0 maxLength: 20 reservationStatus: description: Indicates the status of the reservation. $ref: '#/components/schemas/pMS_ResStatusType' computedReservationStatus: description: Indicates the status of the reservation. $ref: '#/components/schemas/pMS_ResStatusType' mailingActionsType: type: object description: Defines mailing action list for the profile. properties: mailingAction: description: Defines mailing action code and description. type: array maxItems: 4000 items: $ref: '#/components/schemas/codeDescriptionType' active: description: When true indicates that profile has subscribed to the mailing list. type: boolean hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer transportationTemplatesToBeChanged: type: object description: Request object for modifying transportation templates. properties: transportationTemplates: $ref: '#/components/schemas/transportationTemplatesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' departmentsType: type: array description: Collection of departments. maxItems: 4000 items: $ref: '#/components/schemas/departmentType' resGuestInfoType: type: object description: Specifies Company or Travel Agent profile using IATA or Corp. No. properties: membership: description: The Membership object identifying the frequent customer reward program. $ref: '#/components/schemas/membershipInfoType' namePrefix: description: Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.) $ref: '#/components/schemas/namePrefixType' givenName: description: Given name, first name or names $ref: '#/components/schemas/givenNameType' alternateGivenName: description: Alternate given name, first name or names type: string minLength: 0 maxLength: 40 middleName: description: The middle name of the person name type: string minLength: 0 maxLength: 40 surnamePrefix: description: e.g "van der", "von", "de" type: string minLength: 0 maxLength: 20 surname: description: Family name, last name. $ref: '#/components/schemas/surnameType' alternateSurname: description: Alternate family name, last name. type: string minLength: 0 maxLength: 40 nameSuffix: description: Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.). type: string minLength: 0 maxLength: 20 nameTitle: description: Degree or honors (e.g., Ph.D., M.D.) type: string minLength: 0 maxLength: 20 fullName: description: Full display name type: string alternateFullName: description: Altername full display name type: string phoneNumber: description: Phone number $ref: '#/components/schemas/phoneNumberType' email: description: Email address $ref: '#/components/schemas/basicEmailType' birthDate: description: Date of birth type: string format: date maxLength: 8 language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' nationality: description: Affiliation or ethnicity to a particular country. $ref: '#/components/schemas/countryNameType' vip: description: The supplier's ranking of the customer (e.g., VIP, numerical ranking). $ref: '#/components/schemas/vIPType' address: description: Address information that is attached to the reservation guest $ref: '#/components/schemas/addressSearchType' anonymization: description: Provides information about the guest's anonymization status $ref: '#/components/schemas/anonymizationType' accompanyGuests: description: List of guest names that are accompanying the reservation guest $ref: '#/components/schemas/resAccompanyGuestListType' externalInfo: description: External information about the guest associated with the reservation. $ref: '#/components/schemas/resGuestExternalInfoType' guestLastStayInfo: description: Contains information regarding the last stay of this guest. $ref: '#/components/schemas/guestLastStayInfoType' guestRestrictedCode: description: Guest profile restricted reason code type: string guestRestrictedReasonDesc: description: Guest profile restricted reason description type: string guestRestricted: description: True indicates there are restrictions associated with the current profile. type: boolean registrationCardNo: description: Unique identifier of the police registration card number. type: string minLength: 0 maxLength: 40 nameType: $ref: '#/components/schemas/nameTypeType' id: 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 minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 countryType: type: object description: Base details of the country. properties: name: description: Name for the country. type: string minLength: 0 maxLength: 80 statisticCode: description: Statistic code for the country. type: string minLength: 0 maxLength: 3 guestAddressFormat: description: Guest Address format Codes for confirmation letter. type: string minLength: 0 maxLength: 20 addressDoctorMode: description: Defines the mode used to invoke address doctor service. type: string minLength: 0 maxLength: 20 mainGroup: description: Main Group of Country. Used in statistic reports. type: string minLength: 0 maxLength: 20 regionCode: description: Regin to which the Country belongs. type: string minLength: 0 maxLength: 3 isoCode: description: ISO standard code for country. type: string minLength: 0 maxLength: 20 iso3Code: description: ISO standard 3 letter code for country. type: string minLength: 0 maxLength: 3 isoName: description: ISO standard name for country. type: string minLength: 0 maxLength: 200 displaySequence: description: Sequence number for displaying the countries. type: number printSequence: description: Print Sequence number for report. type: number displayFlag: description: Indicates if the country flag should be displayed. type: boolean countryCode: description: Country code identifying the country. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel code the country belongs to. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' reservationFolioWindowType: type: object description: Folio window view which holds the set of folios for a reservation. properties: payeeInfo: description: The window's configured payee information. $ref: '#/components/schemas/payeeInfoType' balance: description: Running balance of the window. $ref: '#/components/schemas/currencyAmountType' paymentMethod: description: Payment Method Type type: string minLength: 0 maxLength: 20 folioWindowNo: type: integer profileId: type: object description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). properties: url: description: URL that identifies the location associated with the record identified by the UniqueID. type: string type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 20 instance: description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated. type: string minLength: 0 maxLength: 80 idContext: description: Used to identify the source of the identifier (e.g., IATA, ABTA). type: string minLength: 0 maxLength: 80 id: 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 minLength: 0 maxLength: 80 idExtension: description: Additional identifying value assigned by the creating system. type: integer profileStatusType: type: string enum: - Active - Inactive masterRestrictionStatusesType: type: string enum: - Closed - ClosedForArrival - ClosedForDeparture - MinimumStayThrough - MaximumStayThrough - MinimumLengthOfStay - MaximumLengthOfStay - LOSNotAvailable - MinimumAdvanceBooking - MaximumAdvanceBooking - Open - OpenForArrival - OpenForDeparture - Hurdle - MinimumOccupancy - MaximumOccupancy - RateStrategy - RateDetailsNotSet - InventoryItemNotAvailable - RankRestriction - MaximumAuth - InventoryNotAvailable - RoomClassNotAvailable - RoomTypeNotAvailable - BlockSellLimit - OnRequest yieldAdjustmentCodesType: type: array description: Holds Yield AdjustmentCodes details. maxItems: 4000 items: $ref: '#/components/schemas/yieldAdjustmentCodeType' marketingCityConfigType: type: object description: Base details of the marketing city. properties: description: description: Description of the marketing city. type: string minLength: 0 maxLength: 2000 distance: description: Distance from the hotel to the marketing city. type: number distanceType: description: Unit of distance for the Distance measurement. type: string minLength: 0 maxLength: 20 drivingTime: description: Driving time from the hotel to the marketing city. type: string minLength: 0 maxLength: 100 direction: description: Direction of the marketing city in relation to the hotel. type: string minLength: 0 maxLength: 20 sequence: description: Sequence number for displaying the marketing city. type: integer inactive: description: Flag to indicate whether the marketing city is inactive or not. type: boolean marketingCity: description: Marketing city code. type: string minLength: 0 maxLength: 40 regionCode: description: Region that the marketing city belongs to. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel the marketing city belongs to. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' reservationInterfaceStatusType: type: object description: Hotel Interface Type for a reservation and status of the various services properties: roomExtension: description: Identifier for the room extension type: string minLength: 0 maxLength: 20 hotelInterface: description: Hotel interface information for the reservation $ref: '#/components/schemas/hotelInterfaceType' interfaceRights: description: Contains a list of status/rights for the various services under this interface type: array maxItems: 4000 items: $ref: '#/components/schemas/interfaceRightsStatusType' addressSearchType: type: object description: Address Details such as city, state, country, postal code etc. properties: cityName: description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). type: string minLength: 0 maxLength: 40 postalCode: description: Post Office Code number. type: string minLength: 0 maxLength: 15 state: description: State or Province name (e.g., Texas). type: string minLength: 0 maxLength: 20 country: description: Country name (e.g., Ireland). $ref: '#/components/schemas/countryNameType' streetAddress: description: First Line of Street Address. For profile search it matches the first Address line. type: string minLength: 0 maxLength: 80 excludeNoCity: description: When true indicates that only profiles with city will be fetched. type: boolean commissionPayoutToType: type: string enum: - TravelAgent - Source - TravelAgentSource - None childAgesType: type: array description: Age of a child in years. maxItems: 4000 items: $ref: '#/components/schemas/childAgeType' hotelAttractionType: type: object description: Information about the attractions near the hotel. properties: name: description: Attraction name for the hotel. $ref: '#/components/schemas/translationTextType2000' type: description: The type of the attraction. type: string minLength: 0 maxLength: 60 class: description: The class of the attraction. type: string minLength: 0 maxLength: 60 generalDirections: description: Directions to the attraction from the hotel. type: string minLength: 0 maxLength: 2000 relativePosition: $ref: '#/components/schemas/relativePositionType' address: description: Address of the attraction. $ref: '#/components/schemas/addressType' website: description: Website for the attraction. $ref: '#/components/schemas/uRLType' priceRange: description: Price range for the attraction. type: string minLength: 0 maxLength: 40 operationHours: description: Price range for the attraction. type: string minLength: 0 maxLength: 20 displaySeq: description: Display sequence of the attraction. type: integer code: type: string minLength: 0 maxLength: 20 currencyExchangeRatesType: type: array description: Exchange Rate information for a currency code. maxItems: 4000 items: $ref: '#/components/schemas/currencyExchangeRateType' hotelUserDefinedFieldsType: type: array maxItems: 4000 items: $ref: '#/components/schemas/hotelUserDefinedFieldType' hotelBanquetSpaceType: type: object description: Defines the Banquet and Meeting Area of the Hotel properties: banquetSeats: type: integer meetingRooms: type: integer banquetArea: description: Defines the BanquetArea of the Hotel type: string minLength: 0 maxLength: 50 meetingArea: description: Defines the Meeting Area of the hotel type: number unitOfMeasureCode: description: The unit of measure in a code format. type: string minLength: 0 maxLength: 20 lastStayInfoType: type: object description: Contains last stay related details for the profile properties: lastVisit: description: Used to hold last stay information for the profile. type: string format: date maxLength: 8 lastRoom: description: Used to hold last room information for the profile. type: string lastRate: description: Used to hold last rate information for the profile. $ref: '#/components/schemas/currencyAmountType' totalStay: description: The total number of previous stay of the profile. type: integer cardTypeType: type: string description: This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method. enum: - Ab - Am - Ax - Cb - Dc - Ds - Dt - Ec - Er - Jc - Jl - Mc - Nb - So - St - Sw - Va - Xy - Zz - Cp - Cu profileSharedLevelType: type: string description: Simple types for Shared level. enum: - Global - Property - Cro hotelRestaurantType: type: object description: Information about the Restaurants in the hotel. properties: restaurantName: description: The name of the Restaurant. type: string minLength: 0 maxLength: 1000 restaurantType: description: The Type of Restaurant. type: string minLength: 0 maxLength: 1000 hours: description: The Hours of Operation of the Restaurant. type: string minLength: 0 maxLength: 1000 priceRange: description: The price range of the Restaurant. type: string minLength: 0 maxLength: 40 comments: description: Comments about the Restaurant. type: string minLength: 0 maxLength: 2000 category: description: The category that the Restaurant belongs to. $ref: '#/components/schemas/restaurantCategoryType' timeSpan: description: The Start Date and End Date of the Restaurant. $ref: '#/components/schemas/timeSpanType' newRestaurantCode: description: The new Restaurant Code which is used in the change method. type: string minLength: 0 maxLength: 20 restaurantCode: type: string minLength: 0 maxLength: 20 orderBy: type: integer hotelId: type: string minLength: 0 maxLength: 20 onSite: type: boolean description: This flag will determine wheather the establishment is type of onsite or offsite. website: type: string description: This field stores the establishment's website. minLength: 0 maxLength: 2000 reservationFolioWindowsType: type: array description: Collection of reservation folio windows. maxItems: 4000 items: $ref: '#/components/schemas/reservationFolioWindowType' resAccessRestrictionType: type: string description: Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed. enum: - Change - Cancel - ChangeOrCancel commentInfoType: type: object description: Comment related to the profile/reservation. properties: comment: description: Comment details for the comment. It will be empty in case of delete comment. $ref: '#/components/schemas/commentType' createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 id: 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 minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 reservationIdList: type: array description: Unique Id that references an object uniquely in the system. maxItems: 4000 items: $ref: '#/components/schemas/uniqueID_Type' hotelContactRoleType: type: string description: The contact's role in the hotel. Possible values are Lead, General, and Contract. enum: - Lead - General - Contract configTemplateAmenityType: type: object description: Base details used for amenities. properties: description: description: The description about amenity of the hotel. type: string minLength: 0 maxLength: 2000 comments: description: The comments about amenity of the hotel. type: string minLength: 0 maxLength: 2000 featureCode: description: Specifies the feature code (aka amenity code). type: string minLength: 0 maxLength: 20 orderSequence: description: Display Order sequence. type: number amenityType: description: The type of amenity (general or meeting) selected from the list of values. $ref: '#/components/schemas/amenityTypeType' beginDate: description: The date the amenity is scheduled to become active. type: string format: date maxLength: 8 endDate: description: The date the amenity is scheduled to become inactive. type: string format: date maxLength: 8 newChainCode: description: The new chain code which is used in the change method. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' directBillingType: type: object description: This is the preconfigured routing instruction type. properties: hotelId: description: Hotel Code for which the details of direct billing is provided for a profile. type: string minLength: 0 maxLength: 20 aRNumber: description: Hotel Code for which the details of direct billing is provided for a profile. type: string minLength: 0 maxLength: 20 eCertificateStatusType: type: string description: Indicates that OPERA E-Certificate is reserved. enum: - Cancelled - Consumed - Deleted - Expired - Issued - Reserved eCertificateScopeType: type: string description: Indicates that OPERA E-Certificate is available for a specific list of hotels. enum: - Global - Hotel - MultiHotel queueTextInfoType: type: object description: Information regarding the message sent to guest. properties: sentTime: description: Time the text was last sent to the user. type: string format: date-time sentBy: description: User name of the user who sent message. type: string minLength: 0 maxLength: 40 countriesDetails: type: object description: Response object for fetching Countries. properties: countries: description: Collection of Countries. $ref: '#/components/schemas/countriesType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' gdsNegotiatedInfoType: type: object description: This provides information for a channel negotiated rate. properties: accessCode: description: The GDS negotiated rate code. type: string minLength: 0 maxLength: 20 order: description: The sell order. type: integer inactive: description: The GDS Negotiated Rate is inactive or not type: boolean start: description: The starting value of the date range. type: string format: date maxLength: 8 end: description: The ending value of the date range. type: string format: date maxLength: 8 eCertificateGenerationType: type: object description: E-Certificates details. properties: ruleId: description: Key to identify the generation rule id. $ref: '#/components/schemas/uniqueID_Type' generationDetail: description: Reason for which e-certificate was generated. type: string minLength: 0 maxLength: 4000 referenceValue: description: Type of value that is in the certificate.valid values are membership_level. type: string minLength: 0 maxLength: 20 attractionCodeType: type: object description: Information about the attractions near the hotel. properties: name: description: Attraction name for the hotel. $ref: '#/components/schemas/translationTextType2000' type: description: The type of the attraction. type: string minLength: 0 maxLength: 60 class: description: The class of the attraction. type: string minLength: 0 maxLength: 60 generalDirections: description: Directions to the attraction from the hotel. type: string minLength: 0 maxLength: 2000 relativePosition: $ref: '#/components/schemas/relativePositionType' address: description: Address of the attraction. $ref: '#/components/schemas/addressType' website: description: Website for the attraction. $ref: '#/components/schemas/uRLType' priceRange: description: Price range for the attraction. type: string minLength: 0 maxLength: 40 operationHours: description: Price range for the attraction. type: string minLength: 0 maxLength: 20 displaySeq: description: Display sequence of the attraction. type: integer code: type: string minLength: 0 maxLength: 20 region: description: The region in which this attraction is located. type: string minLength: 0 maxLength: 20 inactiveDate: description: The date the record was marked as inactive. type: string format: date maxLength: 8 latitude: type: number minimum: -90 maximum: 90 longitude: description: The longitude of the location from which the organism or observation was collected, expressed in decimal degrees. Positive values are East of the Greenwich Meridian, negative values are West of the Greenwich Meridian. type: number minimum: -180 maximum: 180 hotelId: description: Hotel Code for attraction. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' eCertificatesType: type: array description: List of e-certificates for the profile. maxItems: 4000 items: $ref: '#/components/schemas/eCertificateType' keywordType: type: object properties: keywordDetail: description: The keyword new value, in case keyword value is modified. $ref: '#/components/schemas/keywordDetailType' type: description: The type of keyword type: string minLength: 0 maxLength: 20 keyword: description: The keyword value. type: string minLength: 0 maxLength: 80 childBucketsType: type: object description: Defines children counts with Age Qualifying Group(Child Bucket) classification. properties: bucket1Count: description: Number of children classified under the first Age Qualifying Group(Child Bucket#1). type: integer bucket2Count: description: Number of children classified under the second Age Qualifying Group(Child Bucket#2). type: integer bucket3Count: description: Number of children classified under the third Age Qualifying Group(Child Bucket#3). type: integer bucket4Count: description: Number of children classified under the fourth Age Qualifying Group(Child Bucket#4). type: integer bucket5Count: description: Number of children classified under the fifth Age Qualifying Group(Child Bucket#5). type: integer profileTaxInfoType: type: object description: Profile information related to tax. properties: tax1No: description: The tax id of this profile. Usually issued by a government agency. Used by 1099 printing. type: string minLength: 0 maxLength: 40 tax2No: description: Tax 2 id of this profile. type: string minLength: 0 maxLength: 40 taxCategory: description: Tax Category to be changed. type: string minLength: 0 maxLength: 20 taxOffice: description: Tax Office to be changed. type: string minLength: 0 maxLength: 30 taxType: description: Tax type to be changed. type: string minLength: 0 maxLength: 20 businessId: description: Business ID. The maximum length of this element should not exceed 120 characters. type: string minLength: 0 maxLength: 128 businessRegistration: description: Business Registration Code. The maximum length of this element should not exceed 120 characters. type: string minLength: 0 maxLength: 128 aRAccountShortInfoType: type: object description: Accounts Receivabales Account details type charged for batched posting. properties: accountName: description: Name of the AR Account. type: string minLength: 0 maxLength: 200 accountId: description: The unique ID for the Account. $ref: '#/components/schemas/uniqueID_Type' accountNo: description: The Account Number for the Account. type: string minLength: 0 maxLength: 20 status: description: The status of the account. $ref: '#/components/schemas/aRAccountStatusType' generalNoteType: type: object description: General note/information about the Hotel. properties: note: description: The body of the note. type: string minLength: 0 maxLength: 4000 title: description: The note's title. type: string minLength: 0 maxLength: 200 roomRateType: type: object properties: total: $ref: '#/components/schemas/totalType' totalPoints: $ref: '#/components/schemas/pointsType' rates: $ref: '#/components/schemas/ratesType' packages: type: array maxItems: 4000 items: $ref: '#/components/schemas/packageElementType' stayProfiles: description: Profile associated with the room Stay. type: array maxItems: 4000 items: $ref: '#/components/schemas/reservationProfileType' guestCounts: description: A collection of Guest Counts associated with the room rate. $ref: '#/components/schemas/guestCountsType' taxFreeGuestCounts: description: A collection of Tax Free Guest Counts associated with the room rate. This list does not add to the guest count but just indicates number of tax free guests out of guest counts. $ref: '#/components/schemas/guestCountsType' awards: description: Membership Awards code applied on the reservation. $ref: '#/components/schemas/resAwardsType' foreignExchange: description: Exchange Type information for the postings. $ref: '#/components/schemas/foreignExchangeType' reservationBlock: description: Key information about the block for this reservation. $ref: '#/components/schemas/reservationBlockType' roomRateInfo: description: Information about the Room Rate Combination. type: string minLength: 0 maxLength: 2000 mealPlans: description: Meal plan codes for rate plan code. $ref: '#/components/schemas/mealPlansType' roomType: type: string minLength: 0 maxLength: 20 ratePlanCode: type: string minLength: 0 maxLength: 20 promotionCode: type: string minLength: 0 maxLength: 20 start: description: The starting value of the date range. type: string format: date maxLength: 8 end: description: The ending value of the date range. type: string format: date maxLength: 8 availability: description: Used to specify an availability status for the room rate. When available value could be either not specified or "Available". $ref: '#/components/schemas/roomRateAvailReasonType' suppressRate: type: boolean marketCode: description: The code that relates to the market being sold to (e.g., the corporate market, packages). type: string minLength: 0 maxLength: 20 marketCodeDescription: description: Description of the market code. type: string minLength: 0 maxLength: 4000 sourceCode: description: To specify where the business came from e.g. radio, newspaper ad, etc. type: string minLength: 0 maxLength: 20 sourceCodeDescription: description: Description of the source of business. type: string minLength: 0 maxLength: 4000 numberOfUnits: description: The number of rooms. type: integer roomId: description: A string value representing the unique identification of a room. type: string minLength: 0 maxLength: 20 pseudoRoom: description: True indicates as pseudo room type. This is usually used for a posting master reservation. type: boolean roomTypeCharged: description: Room Type used for the Rate calculation. type: string minLength: 0 maxLength: 20 commissionCode: description: Commission Code applicable for commission calculation for Travel Agent/Company. type: string minLength: 0 maxLength: 20 commissionable: description: Indicates Commission is applicable for commission calculation for Travel Agent/Company. type: boolean houseUseOnly: description: Indicates this reservation is for House use. type: boolean complimentary: description: Indicates this reservation rate is complimentary. type: boolean inventoryLender: description: Indicates whether the room type inventory was taken from the allotment or House availability. type: string fixedRate: description: Fixed Rate Indicator. type: boolean barRanking: description: Best Available rates ranking. type: integer rateGroup: description: For RatePlanSet equals BESTAVAILABLERATE, in case Rate Groups are enabled the element provides the rate group for the rate plan code. type: string minLength: 0 maxLength: 20 discountAllowed: description: Indicates if the Rate Code is discountable i.e discounts are allowed on the rate code. type: boolean bogoDiscount: description: Indicates if the Rate Code has BOGO(Bye one Get one) indicator. type: boolean rateLevel: description: Rate plan type like Corporate,Regular,Military,Weekend etc. type: string minLength: 0 maxLength: 20 commissionPercentage: description: Indicates commission percentage used by the rate plan. type: integer commissionAmount: description: Indicates commission amount used by the rate plan. type: integer credentialsRequired: description: If true, indicates that credentials is required to sell the rate code. type: boolean taxIncluded: description: If true, indicates if tax is included in the rate code. type: boolean rateDescription: description: Rate code description. type: string minLength: 0 maxLength: 4000 reservationTurndownInfoType: type: object description: Turndown information for a reservation properties: allowed: description: Indicates if turndown is allowed or not type: boolean status: description: Indicates turndown status, values could be required, not required, completed $ref: '#/components/schemas/turndownStatusType' airportsDetails: type: object description: Response object for fetching airports configured for hotels. properties: airports: description: Collection of airports. $ref: '#/components/schemas/airportsType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' resProfileTypeType: type: string enum: - Guest - Company - Group - TravelAgent - Source - ReservationContact - BillingContact - Addressee hotelDetailValueType: type: object description: This type holds the base information of the hotel detail value which will be associated with a hotel detail. properties: code: description: Specifies the hotel detail value code. type: string minLength: 0 maxLength: 20 description: description: Specifies the description of the hotel detail value. type: string minLength: 0 maxLength: 2000 sequence: description: Specifies the sorting sequence number for the hotel detail value. type: integer newCode: description: Specifies the new hotel detail value code. type: string minLength: 0 maxLength: 20 hotelDetailsType: type: array description: Collection of property level hotel details. maxItems: 4000 items: $ref: '#/components/schemas/hotelDetailType' codeListType: type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 templateMarketingCitiesDetails: type: object description: Response object for fetching template marketing cities. properties: templateMarketingCities: description: Collection of template marketing cities. $ref: '#/components/schemas/templateMarketingCitiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' futureListType: type: object description: A collection of reservation history details attached to Profiles. properties: reservationInfo: description: 'Additional reservation information attached to the profile . Eg : Future reservation details' type: array maxItems: 4000 items: $ref: '#/components/schemas/reservationInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer sellMessageType: type: object description: The SellMessagesType defines the standard attributes that will be retrieved with the sell message. properties: message: description: This is the message text. type: string minLength: 0 maxLength: 2000 croCode: description: This is the Central Reservation office code. type: string minLength: 0 maxLength: 20 chainCode: description: This is the chain code. type: string minLength: 0 maxLength: 20 hotelId: description: This is the hotel code or resort. type: string minLength: 0 maxLength: 20 roomType: description: This represents the room type code. type: string minLength: 0 maxLength: 20 ratePlanCode: description: This represents the rate plan code of the room type. type: string minLength: 0 maxLength: 20 languageCode: description: This is the language code. type: string minLength: 0 maxLength: 20 stickyFlagYn: description: Flag which tells if this message is Sticky (Y/N). type: string minLength: 0 maxLength: 1 usedInModule: description: This represents the correct moduletype which should be used for fetching SellMessages. $ref: '#/components/schemas/usedInModuleType' beginDate: description: This is the Begin date for the configured SellMessage. type: string format: date maxLength: 8 url: description: URL that identifies the location associated with the record identified by the UniqueID. type: string type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 20 instance: description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated. type: string minLength: 0 maxLength: 80 idContext: description: Used to identify the source of the identifier (e.g., IATA, ABTA). type: string minLength: 0 maxLength: 80 id: 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 minLength: 0 maxLength: 80 idExtension: description: Additional identifying value assigned by the creating system. type: integer hotelsSummaryType: type: array description: Lists of Hotel summary information. maxItems: 4000 items: $ref: '#/components/schemas/hotelSummaryType' hotelSetupStylesType: type: array description: List of event space setup style codes. maxItems: 5 items: type: string minLength: 0 maxLength: 20 applicationUrl: type: object description: Type that consists of url type and url value properties: urlType: description: URL type type: string minLength: 0 maxLength: 2000 urlValue: description: URL value type: string minLength: 0 maxLength: 4000 jobTitlesCriteria: type: object description: Request object for creating new job titles for hotels. properties: jobTitles: description: Collection of job titles to be created. $ref: '#/components/schemas/jobTitlesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' reservationStayHistoryFutureInfoType: type: object description: Information of History and Future Reservation details attached to Profiles. properties: historyList: description: Refer to History list type document. $ref: '#/components/schemas/stayHistoryListType' futureList: description: Refer to Future list type document. $ref: '#/components/schemas/stayFutureListType' commentType: type: object description: An indication of a new paragraph for a sub-section of a formatted text message. properties: text: description: Formatted text content. $ref: '#/components/schemas/formattedTextTextType' image: description: An image for this paragraph. type: string url: description: A URL for this paragraph. type: string commentTitle: description: Specifies Comment's Title. type: string minLength: 0 maxLength: 4000 notificationLocation: description: Notification Location associated with the Note. type: string minLength: 0 maxLength: 20 type: description: Specifies type of the comment. type: string minLength: 0 maxLength: 20 typeDescription: description: Comment type Description. type: string minLength: 0 maxLength: 200 internal: description: When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer. type: boolean confidential: description: When true, the comment may be confidential. type: boolean overrideInternal: description: When true, the note internal could be modified. type: boolean protectDescription: description: When true, the note title will be populated from the note type description and couldn't be modified. type: boolean hotelId: description: If specified comment belongs to the Hotel, otherwise it is a global comment. type: string minLength: 0 maxLength: 20 actionType: description: Specifies type of action described in the comments. type: string minLength: 0 maxLength: 20 actionDate: description: Indicates at which date an action described in the comment must be taken. type: string format: date maxLength: 8 createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 copyHotelDetails: type: object description: Request object for copying template hotel details to hotel(s). properties: copyInstructions: description: List of the template hotel details to be copied to hotel(s). $ref: '#/components/schemas/copyHotelDetailsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' translationTextType80: type: object description: Contains Multiple translated texts and language codes. properties: defaultText: description: Default text with Character length from 0 to 80. type: string minLength: 0 maxLength: 80 translatedTexts: description: List of translated text and language codes. $ref: '#/components/schemas/translationsTextType' hotelContactsType: type: array description: Lists of contacts of the hotel. maxItems: 4000 items: $ref: '#/components/schemas/hotelContactType' nameTypeType: type: string enum: - Guest - Company - Agent - Contact - Source - Group - Employee - Hotel - Purge membershipInfoType: type: object description: The Membership object identifies the frequent customer reward program. properties: membershipId: description: Membership ID (Unique ID from the memberships table). type: number programCode: description: The code or name of the membership program ('Hertz', 'AAdvantage', etc.). type: string minLength: 0 maxLength: 20 bonusCode: description: The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.) type: string minLength: 0 maxLength: 20 membershipTypeDesc: description: The description of the ProgramCode.(Delta Previlige for code DP) type: string minLength: 0 maxLength: 2000 membershipLevelDesc: description: The description of the Bonus Code.(Platinum for code P) type: string minLength: 0 maxLength: 2000 accountId: description: The account identification number for this particular member in this particular program. type: string minLength: 0 maxLength: 50 membershipLevel: description: The code or name of the membership level and indicates the level of membership (Gold Club, Platinum member, etc.). This is same as the BonusCode. type: string minLength: 0 maxLength: 20 playerRanking: description: Ranking assigned to the Player Profile by the Gaming system. type: integer copyTemplateType: type: string description: 'Template name for template copy operation. Eg: RateCategory' enum: - RateCategory - PromotionCode - RateClass - DepositPolicy - CancellationPolicy - GuaranteeCode - MarketCode - MarketGroup - SourceCode - SourceGroup - RoomType - RoomClass - CustomNumbers - AlertCode - AttractionCode - Transportation - RoomCondition - RateSeason - Amenity - TransactionCode - CompTransactionCode - PkgForecastGroup - RoomMaintenance - DayTypeCode - TurnawayCodes - EventCode - MessageCode - Airport - OutOfService - Floor - TransactionGroup - LocatorCode - RoomFeatures - JobTitle - DeviceLocations - ShiftDropLocations - HousekeepingTasks - HousekeepingRoomSchedules - PackageCategory - ServiceOrderSkills - ServiceOrderPriority - ServiceOrderTask - ServiceOrderResourceGroup - ServiceOrderSpecialties - ServiceOrderStatuses - ServiceOrderTypes telephoneCategoriesType: type: array description: This type holds collection of Telephone Categories with complete information. maxItems: 4000 items: $ref: '#/components/schemas/telephoneCategoryType' payeeInfoType: type: object description: Payee information. properties: payeeId: description: Opera name id of the payee. $ref: '#/components/schemas/uniqueID_Type' payeeName: description: Name of the payee. type: string minLength: 0 maxLength: 80 payeeAddress: description: Address of the payee. $ref: '#/components/schemas/addressInfoType' payeeAddressCount: description: Payee multiple address count. type: integer payeeReferenceCurrency: description: Reference currency of the payee. type: string minLength: 0 maxLength: 20 payeeAccountInfo: description: AR account short info of the payee. $ref: '#/components/schemas/aRAccountShortInfoType' payeeTaxNumber: description: The tax number of the payee. type: string minLength: 0 maxLength: 40 blockIdList: type: array description: Unique Id that references an object uniquely in the system. maxItems: 4000 items: $ref: '#/components/schemas/uniqueID_Type' hotelCalendarEventsType: type: array description: Details of hotel events maxItems: 4000 items: $ref: '#/components/schemas/hotelCalendarEventType' languagesToBeChanged: type: object description: Request object for changing details of existing language records. properties: languages: description: Collection containing details of languages to be changed. $ref: '#/components/schemas/configLanguagesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelSummaryType: type: object description: A brief summary of information about a hotel. properties: hotelId: description: Code identifying the hotel. type: string minLength: 0 maxLength: 20 hotelName: description: The name of the hotel. type: string minLength: 0 maxLength: 80 activeDate: description: Date when the hotel becomes valid for use. type: string format: date maxLength: 8 inactiveDate: description: Date when the hotel becomes invalid for use. type: string format: date maxLength: 8 chainCode: description: Hotels Chain Code. This attribute uniquely assign Hotel to a single chain. type: string minLength: 0 maxLength: 20 propertyType: description: Property Type Description. The property type defined for the hotel type: string minLength: 0 maxLength: 2000 brandCode: description: Property brand code. type: string minLength: 0 maxLength: 20 hotelFeaturesType: type: array description: Collection of Features in the Hotel maxItems: 4000 items: $ref: '#/components/schemas/hotelFeatureType' hotelContactType: type: object description: Contact identification details. properties: nameId: description: Contact or employee identifier.. $ref: '#/components/schemas/uniqueID_Type' hotelId: description: The code of the hotel. type: string minLength: 0 maxLength: 20 name: description: Name of the hotel contact. type: string minLength: 0 maxLength: 2000 roles: description: List of HotelContactType. $ref: '#/components/schemas/hotelContactRolesType' ownerCode: description: The contact's code in the hotel. type: string minLength: 0 maxLength: 20 communicationMethod: description: The preferred method of communication for the contact. type: string minLength: 0 maxLength: 20 communicationAddress: description: 'Details about the preferred communication method. Example: email address, fax number, etc.' type: string minLength: 0 maxLength: 80 primary: description: Primary flag. type: boolean resMobileNotificationsType: type: object description: Contains the status of Room Ready and Key Ready messages. properties: roomReady: description: Denotes the status of Room Ready message. It can have one of the values:PENDING, COMPLETED or FAILED $ref: '#/components/schemas/communicationStatusType' keyReady: description: Denotes the status of Key Ready message. It can have one of the values:PENDING, COMPLETED or FAILED $ref: '#/components/schemas/communicationStatusType' checkoutMessageReceived: description: Indicates if the Mobile checkout message is received. type: boolean requiresAction: description: Indicates if user action is required. The action could be for sending Room Ready or Key Ready Notification. It could also be for initiating Checkout type: boolean errorMessage: description: Error message when Mobile Notification has failed. type: string sourceOfSaleType: type: object description: Point of Sale of reservation. Identifies the entity/channel who made the reservation. properties: sourceType: description: Type of entity/channel who made the reservation.. type: string minLength: 0 maxLength: 40 sourceCode: description: The entity/channel who made the reservation. type: string minLength: 0 maxLength: 20 alternateHotelsType: type: array maxItems: 4000 items: $ref: '#/components/schemas/alternateHotelType' templateCountriesDetails: type: object description: Response object for fetching template Countries. properties: templateCountries: description: Collection of template Countries. $ref: '#/components/schemas/templateCountriesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' historyListType: type: object description: A collection of reservation history details attached to Profiles. properties: reservationInfo: description: 'Additional reservation information attached to the profile . Eg : History reservation details' type: array maxItems: 4000 items: $ref: '#/components/schemas/reservationInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer hotelAttractionsType: type: array maxItems: 4000 items: $ref: '#/components/schemas/hotelAttractionType' usedInModuleType: type: string description: Simple type for indicating the module for which user wants to create the SellMessage. Valid module types are Look To Book Sales,Reservations,Blocks,Function Diary and Group Rooms Control. enum: - Blocks - Reservations - FunctionDiary - LookToBookSales - GroupRoomsControl hotelContactsCriteria: type: object description: Request object for creating new Contacts for hotels. properties: hotelContacts: description: Collection of hotel contacts to be created. $ref: '#/components/schemas/hotelContactsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomStayType: type: object properties: registrationNumber: description: Registration Number of the reservation for the current day. $ref: '#/components/schemas/uniqueID_Type' currentRoomInfo: description: Room information of the reservation for the current day. $ref: '#/components/schemas/currentRoomInfoType' roomRates: description: A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can have multiple rates. Example King room, Rack rate plan, Monday through Thursday, weekday amount, Friday and Saturday, weekend amount. type: array maxItems: 4000 items: $ref: '#/components/schemas/roomRateType' guestCounts: $ref: '#/components/schemas/guestCountsType' arrivalDate: type: string format: date departureDate: type: string format: date expectedTimes: description: The Expected Arrival and Departure Times. $ref: '#/components/schemas/resExpectedTimesType' originalTimeSpan: description: The Original Time Span(Arrival, Departure) which covers the Room Stay. In case of Rolling No Show TimeSpan's StratDate moves forward but OriginalTimeSpan's StratDate remains the same. $ref: '#/components/schemas/timeSpanType' guarantee: description: The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context. $ref: '#/components/schemas/resGuaranteeType' promotion: description: Promotions applied to the reservation to get the promotional rate. $ref: '#/components/schemas/promotionType' suiteWith: description: Connecting Rooms. type: string minLength: 0 maxLength: 200 total: description: The total amount charged for the Room Stay. $ref: '#/components/schemas/totalType' totalPoints: description: The total number of Points charged for the Room Stay. $ref: '#/components/schemas/pointsType' multiValueAttrs: description: Informative indicators indicating different values of an attribute exists over the stay. type: array maxItems: 4000 items: type: string maxLength: 2000 upsellInfo: description: Indicates Upsell Information to be applied on Reservation. $ref: '#/components/schemas/upsellInfoType' mobileNotifications: description: Denotes the status of Room Ready and Key Ready messages. $ref: '#/components/schemas/resMobileNotificationsType' roomNumberLocked: description: When true, indicates a room number cannot be changed. When false, indicates a room number may be changed. type: boolean printRate: description: This control whether rate info will be printed in confirmation letter. type: boolean ownerReservationType: description: Indicates whether reservation is for Unit/Room Owner or Authorized User. If this attribute is not define it is a regular/rental reservation. $ref: '#/components/schemas/ownerResTypeType' primaryShareType: description: This is populated in case of primary share scenario. This indicates whether this reservation is primary or non primary. Changes or postings to the 'non-primary' share reservation is not allowed. $ref: '#/components/schemas/primaryShareTypeType' remoteCheckInAllowed: description: Indicates whether the reservation is pre-registered for internet check-in or not. type: boolean bookingMedium: description: Classifies the medium(Channel field on reservation screen) through which the reservation is made. type: string minLength: 0 maxLength: 20 bookingMediumDescription: description: Description of the booking medium. type: string minLength: 0 maxLength: 2000 availableUpsellOfferCount: description: Number of Upsell Offers Available for this stay. This will only be populated if the Upsell Instruction is included in the Allowed Instruction request type: integer webUserAccountsType: type: array description: Web User Accounts List. maxItems: 4000 items: $ref: '#/components/schemas/webUserAccountType' guestLastStayInfoType: type: object description: Contains last stay related details of the guest. properties: lastStayDate: description: Guest's last stay date. type: string format: date maxLength: 8 lastStayRoom: description: Room Number where the guest stayed. type: string minLength: 0 maxLength: 20 lastStayRate: description: The Rate amount of the guest's last stay. $ref: '#/components/schemas/currencyAmountType' totalStay: description: The total number of previous stay of the guest. type: integer emailInfoType: type: object description: Information on an email for the customer. properties: email: description: eMail deatils for the profile. $ref: '#/components/schemas/emailType' id: 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 minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 ratesType: type: object description: Individual rate amount. properties: rate: description: The Rate contains a collection of elements that define the amount of the rate, associated fees, additional occupant amounts. Taxes can be broken out or included within the various amounts. A currency can be associated to each amount. type: array maxItems: 4000 items: $ref: '#/components/schemas/amountType' rateRange: description: Rate Range details like maximum rate amount and minimum rate amount in each available rate category. type: array maxItems: 4000 items: $ref: '#/components/schemas/rateRangeType' hotelBrochureType: type: object description: Contains the basic configuration information about a Hotel. properties: primaryDetails: description: Primary Information of the hotel. type: object properties: legalOwner: description: Legal owner of the hotel. type: string minLength: 0 maxLength: 80 generalInformation: description: General Information of the hotel. type: object properties: hotelType: description: The type of the Hotel. type: string minLength: 0 maxLength: 20 roomCount: description: The total number of rooms in the Hotel. type: integer bedCount: description: The total number of beds in the Hotel. type: integer floorCount: description: The total number of floors of the Hotel. type: integer checkInTime: description: The official check in time of the Hotel. type: string format: date-time checkOutTime: description: The official check out time of the Hotel. type: string format: date-time hotelInfoWebsite: description: URL where property information is located. $ref: '#/components/schemas/uRLType' longitude: description: Longitude of the hotel. type: number latitude: description: Latitude of the hotel. type: number baseLanguage: description: The base language of the Hotel. $ref: '#/components/schemas/languageType' accommodationDetails: description: Accommodation Details of the hotel. type: object properties: singleRooms: description: The number of Single Rooms of the Hotel. type: integer doubleRooms: description: The number of Double Rooms of the Hotel. type: integer twinRooms: description: The number of Twin Rooms of the Hotel. type: integer familyRooms: description: The number of Family Rooms of the Hotel. type: integer connectingRooms: description: The number of Connecting Rooms of the Hotel. type: integer accessibleRooms: description: The number of Accessible Rooms of the Hotel. type: integer nonSmokingRooms: description: The number of Non-Smoking Rooms of the Hotel. type: integer maxAdultsInFamilyRoom: description: Maximum Adults for Family Room Type. type: integer maxChildrenInFamilyRoom: description: Maximum Children for Family Room Type. type: integer guestRoomFloors: description: The total number of the Guest Room Floors. type: integer guestRoomElevators: description: The number of Guest Room Elevators. type: integer suites: description: The number of Suites of the Hotel. type: integer executiveFloorNo: description: The floor number of Executive Floors of the Hotel. type: string minLength: 0 maxLength: 1000 roomAmenties: description: The information about the Room Amenities. type: string minLength: 0 maxLength: 2000 shopDescription: description: The Description of the shops in the Hotel. type: string minLength: 0 maxLength: 2000 propertyControls: description: Property controls information configuration of the hotel. type: object properties: sellControls: description: The sell controls information configuration of the hotel. type: object properties: startDate: description: Date when the hotel become valid for use. type: string format: date maxLength: 8 endDate: description: The end date of the hotel. type: string format: date maxLength: 8 hotelId: description: The hotel code. type: string minLength: 0 maxLength: 80 currencyFormatting: description: Currency Formatting information configuration of the hotel. type: object properties: currencyCode: description: The base currency code for this hotel.. type: string minLength: 0 maxLength: 20 currencyFormat: description: Format for the local currency. type: string minLength: 0 maxLength: 80 currencySymbol: description: Symbol to designate the default currency of the hotel. type: string minLength: 0 maxLength: 20 decimalPositions: description: Number of decimal positions used for this currency type. type: integer cateringCurrencyFormatting: description: Catering Currency Formatting information configuration of the hotel. type: object properties: currencyCode: description: The base currency code for this hotel.. type: string minLength: 0 maxLength: 20 currencyFormat: description: Format for the local currency. type: string minLength: 0 maxLength: 80 dateTimeFormatting: description: Date Time Formatting information configuration of the hotel type: object properties: longDateFormat: description: Long date format of the hotel. type: string minLength: 0 maxLength: 20 shortDateFormat: description: Short date format of the hotel. type: string minLength: 0 maxLength: 20 timeFormat: description: Time format for the hotel. type: string minLength: 0 maxLength: 20 timeZoneRegion: description: Time zone region of the hotel. type: string minLength: 0 maxLength: 80 applicationMode: description: Application Mode information configuration of the hotel. type: object properties: configurationMode: description: The hotel's configuration mode if applicable. type: string minLength: 0 maxLength: 20 countryMode: description: The hotel's country code. type: string minLength: 0 maxLength: 20 expHotelCode: description: Hotel Code used for third party exports. type: string minLength: 0 maxLength: 20 touristNumber: description: The Tourist Number of the hotel. type: string minLength: 0 maxLength: 20 mbsSupported: description: Indicates if the hotel uses MBS (Marriott Business Services). type: boolean enablePropertyConfigurations: description: Indicates if the configurations are enabled for the property. type: boolean isCentralResort: description: Indicates if the property has centra license. type: boolean communication: description: Communication information of the hotel. type: object properties: phoneNumber: description: The direct dial phone number of the hotel. $ref: '#/components/schemas/telephoneType' tollFreeNumber: description: Toll free phone number of the hotel. $ref: '#/components/schemas/telephoneType' faxNumber: description: Fax phone number of the hotel. $ref: '#/components/schemas/telephoneType' emailAddress: description: Email address of the hotel. $ref: '#/components/schemas/basicEmailType' webPage: description: The web address of the hotel. $ref: '#/components/schemas/uRLType' address: description: Provides address information. type: object properties: isValidated: description: Indicator to define if the Address is validated by the Address Validation System. type: boolean addressLine: description: When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence. type: array maxItems: 4 items: type: string minLength: 0 maxLength: 80 cityName: description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). type: string minLength: 0 maxLength: 40 postalCode: description: Post Office Code number. type: string minLength: 0 maxLength: 15 cityExtension: description: Post Office City Extension Code number. City Extension mainly used for UK addresses. type: string minLength: 0 maxLength: 20 county: description: County or District Name (e.g., Fairfax). This is read only. type: string minLength: 0 maxLength: 20 state: description: State or Province name (e.g., Texas). type: string minLength: 0 maxLength: 20 country: description: Country name (e.g., Ireland). $ref: '#/components/schemas/countryNameType' language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' type: description: Defines the type of address (e.g. home, business, other). type: string minLength: 0 maxLength: 20 typeDescription: description: Describes the type code type: string primaryInd: description: When true, indicates a primary information. type: boolean updateReservations: description: Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address. type: boolean barCode: description: The postal barcode for the address. type: string minLength: 0 maxLength: 100 createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 regionCode: description: The region code of the hotel. type: string minLength: 0 maxLength: 20 hotelRestaurants: description: Names of restaurants which can be found in the Hotel. $ref: '#/components/schemas/hotelRestaurantsType' hotelRateRanges: description: The rate ranges which are offered by the hotels. $ref: '#/components/schemas/hotelRateRangesType' alternateHotels: description: Informations about alternative hotels provided by the Hotel. $ref: '#/components/schemas/alternateHotelsType' hotelContacts: description: The contacts information the hotels. $ref: '#/components/schemas/hotelContactsType' hotelEventSpaces: description: Even Space information of the hotel. $ref: '#/components/schemas/hotelEventSpacesType' hotelNotes: description: List of notes for the hotel. $ref: '#/components/schemas/hotelNotesType' hotelCorporateInformations: $ref: '#/components/schemas/hotelCorporateInformationsType' attractions: description: List of Attractions for the hotel. $ref: '#/components/schemas/hotelAttractionsType' meetingRooms: description: List of Meeting Rooms for the hotel. $ref: '#/components/schemas/meetingRoomsType' chainCode: description: The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute. type: string minLength: 0 maxLength: 20 hotelId: description: The code that uniquely identifies a single hotel property. The hotel code is decided between vendors. type: string minLength: 0 maxLength: 20 hotelCityCode: description: The IATA city code; for example DCA, ORD. type: string minLength: 0 maxLength: 40 hotelName: description: A text field used to communicate the proper name of the hotel. type: string minLength: 0 maxLength: 80 hotelCodeContext: description: A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes. type: string minLength: 0 maxLength: 40 chainName: description: The name of the hotel chain (e.g., Hilton, Marriott, Hyatt). type: string minLength: 0 maxLength: 80 baseLanguage: description: The base language of the Hotel. $ref: '#/components/schemas/languageType' currentTime: description: The time when login hotel brochure. type: string minLength: 0 maxLength: 80 hotelAttractions: description: Information about attractive places that can be found around the Hotel. $ref: '#/components/schemas/hotelAttractionsType' hotelPackages: description: Packages and offers offered by the Hotel. $ref: '#/components/schemas/hotelPackagesType' hotelTransportations: description: List of different transportation companies around the Hotel. $ref: '#/components/schemas/hotelTransportationsType' hotelConferenceFacilities: description: Information about the conference rooms in the Hotel. $ref: '#/components/schemas/hotelConferenceFacilitiesType' hotelFeatures: description: Lists of features provided by the Hotel $ref: '#/components/schemas/hotelFeaturesType' directions: description: Instructions and direction to help reaching the Hotel. $ref: '#/components/schemas/directionsType' generalNotes: description: General Notes provided about the Hotel. $ref: '#/components/schemas/generalNotesType' hotelAirports: description: Informations about different airports near by. $ref: '#/components/schemas/hotelAirportsType' hotelMiscellaneousInformation: description: General user defined information provided about the Hotel. $ref: '#/components/schemas/hotelUserDefinedFieldsType' yieldCategoryType: type: object description: Provides information about the Yield Category. properties: hotelId: description: Code of the Hotel. type: string minLength: 0 maxLength: 20 code: description: Code of the Yield Category. type: string minLength: 0 maxLength: 20 description: description: Description of the Yield Category. type: string minLength: 0 maxLength: 40 managedBy: $ref: '#/components/schemas/managedByOptions' applicationSettingConversionType: type: string enum: - Default - Parameter configTemplateAmenitiesType: type: array description: This type holds a collection of amenities at the template level. maxItems: 4000 items: $ref: '#/components/schemas/configTemplateAmenityType' creditCardTypeType: type: object description: Contains Common Master configuration detail. properties: code: description: Common Master unique code. type: string minLength: 0 maxLength: 40 description: description: Description of the Master code. $ref: '#/components/schemas/translationTextType2000' displayOrder: description: Common Master record sequence number. type: number hotelId: description: Hotel of the record. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' facilityCodesType: type: array description: List of the facility codes. maxItems: 4000 items: $ref: '#/components/schemas/facilityCodeType' personNameTypeType: type: string description: Person's name in an external system. enum: - Primary - Alternate - Incognito - External - Phonetic telephoneBookEntryType: type: object description: This type definition of Telephone Book Entry Type. properties: id: $ref: '#/components/schemas/uniqueID_Type' hotelId: type: string minLength: 0 maxLength: 20 category: type: string minLength: 0 maxLength: 80 categorySequence: type: integer categoryDescription: type: string minLength: 0 maxLength: 2000 name: type: string minLength: 0 maxLength: 200 telephone: type: string minLength: 0 maxLength: 80 url: type: string minLength: 0 maxLength: 1000 remarks: type: string minLength: 0 maxLength: 2000 managedBy: $ref: '#/components/schemas/managedByOptions' dateUDFsType: type: array description: Used to hold collection of user defined fields of Date Type. maxItems: 4000 items: $ref: '#/components/schemas/dateUDFType' translationTextType2000: type: object description: Contains Multiple translated texts and language codes. properties: defaultText: description: Default text with Character length from 0 to 2000. type: string minLength: 0 maxLength: 2000 translatedTexts: description: List of translated text and language codes. $ref: '#/components/schemas/translationsTextType' resCompAccountingType: type: object description: Information regarding comp accounting on the reservation. properties: compType: description: Code used to identify the casino comp type and ranking of a guest. type: string minLength: 0 maxLength: 20 authorizer: description: ID of the employee who will act as the host for this guest. type: string minLength: 0 maxLength: 40 compPostings: description: Indicates if the Comp Billing/posting Exist type: string minLength: 0 maxLength: 5 creditCardTypesCriteria: type: object description: Request object for creating Credit Card Types. properties: creditCardTypes: description: Credit Card Types to be created. $ref: '#/components/schemas/creditCardTypesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' feeType: type: object description: Applicable service charges or fees. properties: description: type: string minLength: 0 maxLength: 2000 type: description: Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other). $ref: '#/components/schemas/amountDeterminationType' code: description: Code identifying the fee (e.g.,agency fee, municipality fee). type: string minLength: 0 maxLength: 20 amount: description: A monetary amount. type: number currencyCode: description: Provides a currency code to reflect the currency in which an amount may be expressed. type: string minLength: 3 maxLength: 3 dateUDFType: type: object description: Used to hold user defined field of Date Type. properties: name: description: Used to hold user defined field of Date Type. It is highly recommended to use UDFD01, UDFD02,...UDFN20 (Total 20) as Date UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required. type: string minLength: 0 maxLength: 20 value: description: Value of user defined field. type: string format: date maxLength: 8 alternateName: description: Label of user defined field used by vendors or customers. type: string minLength: 0 maxLength: 2000 copyYieldAdjustmentCodes: type: object properties: yieldAdjustmentCodes: type: array description: List of the Yield AdjustmentCodes to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' uRLInfoType: type: object description: Web site address. properties: url: description: Provides URL information. $ref: '#/components/schemas/uRLType' id: 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 minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 copyHotelDetailsType: type: object description: Instructions for copying template hotel details to hotel(s). properties: hotels: description: Hotel codes to copy the template hotel details to. $ref: '#/components/schemas/codeListType' templateHotelDetails: description: Template hotel details to be copied to the hotel(s). $ref: '#/components/schemas/templateHotelDetailsIDType' awardId: type: object description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). properties: url: description: URL that identifies the location associated with the record identified by the UniqueID. type: string type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 20 instance: description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated. type: string minLength: 0 maxLength: 80 idContext: description: Used to identify the source of the identifier (e.g., IATA, ABTA). type: string minLength: 0 maxLength: 80 id: 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 minLength: 0 maxLength: 80 idExtension: description: Additional identifying value assigned by the creating system. type: integer resAttachedProfileType: type: object properties: name: description: Attached profile name type: string profileIdList: description: Collection of unique profile identifiers $ref: '#/components/schemas/profileIdList' reservationProfileType: $ref: '#/components/schemas/resProfileTypeType' telephoneBookEntriesType: type: array description: This type holds collection of Telephone Book Entries with complete information. maxItems: 4000 items: $ref: '#/components/schemas/telephoneBookEntryType' transportationTemplatesType: type: array description: Collection of transportation templates. maxItems: 4000 items: $ref: '#/components/schemas/hotelTransportationType' applicationSettingType: type: object description: Internal settings that can be of a certain valueType. properties: shortDescription: type: string minLength: 0 maxLength: 2000 description: type: string minLength: 0 maxLength: 2000 wildCardMatch: description: A flag which indicate whether a wild card search should be made. type: boolean name: type: string minLength: 0 maxLength: 80 displayName: type: string minLength: 0 maxLength: 80 type: $ref: '#/components/schemas/applicationSettingTypeType' hotelId: description: Each configuration item will come with a HotelCode which will help the configuration to specify what context the update has to be. Eg. _Global,ORS,'CRO', etc. type: string minLength: 0 maxLength: 20 sequence: type: number editAllowed: type: boolean value: type: string minLength: 0 maxLength: 2000 scope: type: string enum: - P - G - Ch - C valueType: type: string enum: - Yn - Integer - String - SingleSelectLov - MultiSelectLov - ShuttleLov - Custom - Double - Secure conversionType: description: Represents whether the value is OXI Parameter or Conversion code default. $ref: '#/components/schemas/applicationSettingConversionType' settings: type: array maxItems: 4000 items: $ref: '#/components/schemas/baseApplicationSettingType' levelType: $ref: '#/components/schemas/applicationSettingLevelType' levelCode: type: string minLength: 0 maxLength: 20 subscriptionCountEligible: description: Indicates if this OPERA Setting is part of subscription count. type: boolean keywordDetailType: type: object properties: newKeyword: description: The new keyword value. type: string minLength: 0 maxLength: 80 taxTypeType: type: object description: Provides information about the Tax Type. properties: hotelId: description: Code of the Hotel. type: string minLength: 0 maxLength: 20 code: description: Code of the Tax Type. type: string minLength: 0 maxLength: 20 description: description: Description of the Tax Type. type: string minLength: 0 maxLength: 2000 collectingAgentTax: description: A boolean flag for Collecting Agent Tax type: boolean printAutoAdjust: description: Print auto adjust information for this tax type on the tax exempt report. type: boolean reportExemptDays: description: Number of days after which the guest will be tax exempt. Only used for tax exempt report. type: integer reportTaxPercentage: description: Tax percentage. Only used for tax exempt report. type: number minimum: 0 maximum: 100 minimumLengthOfStay: description: Minimun Length of Stay. type: integer hotelsDetails: type: object description: Response object for fetching lists of Property summary information. properties: hotelSummaryInfoList: $ref: '#/components/schemas/hotelsSummaryType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' yieldCategoriesType: type: array description: Holds Yield Category details. maxItems: 4000 items: $ref: '#/components/schemas/yieldCategoryType' feesType: type: object description: A collection of fees or service charges. properties: fee: description: An individual fee or service charge. type: array maxItems: 99 items: $ref: '#/components/schemas/feeType' amount: description: A monetary amount. type: number currencyCode: description: Provides a currency code to reflect the currency in which an amount may be expressed. type: string minLength: 3 maxLength: 3 translationsTextType: type: array description: Language code for the translation. maxItems: 4000 items: type: object properties: value: type: string description: Used for Character Strings, length 0 to 2000. minLength: 0 maxLength: 2000 language: description: Language identification. type: string minLength: 0 maxLength: 20 description: Language code for the translation. transportationListType: type: array description: Collection of hotel level transportation. maxItems: 4000 items: $ref: '#/components/schemas/transportationType' eCertificateIssueType: type: string description: Indicates that guest purchased OPERA E-Certificate. enum: - Assigned - OptedIn - Purchased hotelDayTypeCodeType: type: object description: Base structure for Day Type Code at both template and hotel levels. properties: code: description: Code of a Day Type. type: string minLength: 0 maxLength: 20 description: description: Description of a Day Type. type: string minLength: 0 maxLength: 100 multiplier: description: Value by which the rates will be multiplied on a day. type: number adder: description: Value that will be added to rate on a day. type: number color: description: Color used to represent Day Type. $ref: '#/components/schemas/colorType' sellSequence: description: Sell sequence for a Day Type. type: number hotel: description: Hotel code to which the Day Type is associated. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' templateHotelDetailValueType: type: object description: This type holds the base information of the hotel detail value which will be associated with a hotel detail. properties: code: description: Specifies the hotel detail value code. type: string minLength: 0 maxLength: 20 description: description: Specifies the description of the hotel detail value. type: string minLength: 0 maxLength: 2000 sequence: description: Specifies the sorting sequence number for the hotel detail value. type: integer webUserAccountType: type: object description: Web User Account of the guest. properties: securityQuestion: description: Security Question and its Code associated with the account to verify the user. $ref: '#/components/schemas/codeDescriptionType' securityAnswer: description: Answer to the Security Question. type: string minLength: 0 maxLength: 4000 comments: description: Comments. type: string minLength: 0 maxLength: 4000 history: description: Web User Account History. $ref: '#/components/schemas/webUserHistoryType' newLoginName: description: New Login Name of the guest. type: string minLength: 0 maxLength: 80 newPassword: description: Login Password. type: string minLength: 0 maxLength: 2000 autoGeneratePassword: description: A flag which determines if the password is auto generated. type: boolean loginName: description: Login Name of the guest. type: string minLength: 0 maxLength: 80 domainCode: description: Domain code. type: string minLength: 0 maxLength: 20 locked: description: Boolean flag that indicates whether the web account is locked or not. type: boolean inactive: description: Boolean flag that indicates whether the web account is inactive or not. type: boolean externalReferencesType: type: array description: This type contains unique information of external reference. maxItems: 4000 items: $ref: '#/components/schemas/externalReferenceType' templateHotelDetailType: type: object description: Base details used for storing information about a hotel detail. properties: code: description: Specifies the hotel detail code. type: string minLength: 0 maxLength: 20 description: description: Specifies the hotel detail description. type: string minLength: 0 maxLength: 2000 category: description: Specifies the hotel detail category. type: string minLength: 0 maxLength: 20 sequence: description: Specifies the sorting sequence number for the hotel detail. type: integer verified: description: Specifies if hotel detail values are being verified to match template values. type: boolean dataType: description: Specifies the data type of the added hotel detail value codes. $ref: '#/components/schemas/hotelDetailDataType' templateHotelDetailValues: description: Collection of values which are associated with the hotel detail. $ref: '#/components/schemas/templateHotelDetailValuesType' managedBy: $ref: '#/components/schemas/managedByOptions' telephoneBookCategoriesCriteria: type: object description: Request object for Telephone Book Category. properties: telephoneCategories: description: Collection of telephone categories to create. $ref: '#/components/schemas/telephoneCategoriesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' pMS_ResStatusType: type: string description: This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment. enum: - Reserved - Requested - NoShow - Cancelled - InHouse - CheckedOut - Waitlisted - DueIn - DueOut - Walkin - PendingCheckout configHotelAmenitiesType: type: array description: This type holds a collection of amenities at the property level. maxItems: 4000 items: $ref: '#/components/schemas/configHotelAmenityType' hotelEventSpaceSummaryType: type: object description: The summary info of hotel event space properties: 'no': description: The total event space number which has the same space type, max capacity and setup style. type: integer spaceType: description: The type of the event space type: string minLength: 0 maxLength: 2000 maxCapacity: description: The max capacity of this event space group type: integer maxOccupancies: description: List of max occupancies of the event space based on the setup code. $ref: '#/components/schemas/eventSpaceMaxOccupanciesType' templateAirportsCriteria: type: object description: Request object for creating new template airports. properties: templateAirports: description: Collection of template airports to be created. $ref: '#/components/schemas/templateAirportsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' operaHotelContextDetails: type: object description: The result element returned with general hotel contextual information. properties: hotelContext: description: A record containing hotel contextual information, stored as attributes. type: object properties: hotelId: description: The hotel code. type: string minLength: 0 maxLength: 20 hotelName: description: The hotel name. type: string minLength: 0 maxLength: 80 businessDate: description: The hotel's business date. type: string format: date configurationMode: description: The hotel's configuration mode if applicable. type: string minLength: 0 maxLength: 20 countryMode: description: The hotel's country code. type: string minLength: 0 maxLength: 20 languageCode: description: The hotel's language code. type: string minLength: 0 maxLength: 20 currencyCode: description: Provides the hotel's currency code. type: string minLength: 3 maxLength: 3 cateringCurrencyCode: description: Catering Currency Code, used when Catering Currency differs from base currency. type: string minLength: 3 maxLength: 3 checkInTime: description: The hotel's check-in time. type: string format: date checkOutTime: description: The hotel's check-out time. type: string format: date timezone: description: The hotel's timezone. type: string minLength: 0 maxLength: 80 loginUserId: description: The login user. type: string minLength: 0 maxLength: 20 chainCode: description: The hotel's chain code. type: string minLength: 0 maxLength: 20 links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' profileTypeType: type: string description: The types of Profile handled by the web service. enum: - Guest - Agent - Company - Group - Source - Employee - Hotel - Vendor - Contact - Purge - BusinessHeader - BillingAccount - Activity - Potential - Account templateJobTitlesToBeChanged: type: object description: Request object for modifying template job titles. properties: templateJobTitles: description: Collection of template job titles to be modified. $ref: '#/components/schemas/templateJobTitlesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' profileIdList: type: array description: Unique Id that references an object uniquely in the system. maxItems: 4000 items: $ref: '#/components/schemas/uniqueID_Type' attractionsCriteria: type: object description: Request object for creating a new group of attractions. properties: attractions: description: Group of attractions to be created. $ref: '#/components/schemas/attractionCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' primaryShareTypeType: type: string enum: - Primary - NonPrimary templateCountryType: type: object description: Base details of the country properties: name: description: Name for the country. type: string minLength: 0 maxLength: 80 statisticCode: description: Statistic code for the country. type: string minLength: 0 maxLength: 3 guestAddressFormat: description: Guest Address format Codes for confirmation letter. type: string minLength: 0 maxLength: 20 addressDoctorMode: description: Defines the mode used to invoke address doctor service. type: string minLength: 0 maxLength: 20 mainGroup: description: Main Group of Country. Used in statistic reports. type: string minLength: 0 maxLength: 20 regionCode: description: Regin to which the Country belongs. type: string minLength: 0 maxLength: 3 isoCode: description: ISO standard code for country. type: string minLength: 0 maxLength: 20 iso3Code: description: ISO standard 3 letter code for country. type: string minLength: 0 maxLength: 3 isoName: description: ISO standard name for country. type: string minLength: 0 maxLength: 200 displaySequence: description: Sequence number for displaying the countries. type: number printSequence: description: Print Sequence number for report. type: number displayFlag: description: Indicates if the country flag should be displayed. type: boolean countryCode: description: Country code identifying the country. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' amenitiesCriteria: type: object description: Request object for creating amenities at the property level. properties: hotelAmenities: description: Collection containing details of amenities specified at the property level. $ref: '#/components/schemas/configHotelAmenitiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' reservationAllowedActionType: type: string description: Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation. enum: - Cancel - Move - PreCharge - PostCharge - FacilitySchedule - Upsell - PreCheckIn - PostToNoShowCancel - NoShow - NameChange - Discount - EnrollToPrimaryMembership - EnrollInProgress hotelRateRangesToBeChanged: type: object description: Request object for changing hotel Rate Ranges for hotels. properties: hotelRateRanges: description: Collection of Rate Ranges to be modified. $ref: '#/components/schemas/hotelRateRangesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelRateRangesCriteria: type: object description: Request object for creating new Rate Ranges for hotels. properties: hotelRateRanges: description: Collection of Rate Range to be created. $ref: '#/components/schemas/hotelRateRangesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' countriesToBeChanged: type: object description: Request object for modifying Countries for hotels. properties: countries: description: Collection of Countries to be modified. $ref: '#/components/schemas/countriesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelConferenceRoomsType: type: array maxItems: 4000 items: $ref: '#/components/schemas/hotelConferenceRoomType' resSharedGuestInfoType: type: object description: Contains information regarding the share reservation. properties: profileId: $ref: '#/components/schemas/profileId' firstName: description: Given name, first name or names type: string lastName: description: Family name, last name. type: string fullName: description: String representation of the full name type: string transportationCodeListType: type: array description: List of available transportations from airport to get into Hotel. maxItems: 4000 items: $ref: '#/components/schemas/transportationCodeType' numericUDFType: type: object description: Used to hold user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02,...UDFN40 (Total 40) as Numeric UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required. properties: name: description: Name of user defined field. type: string minLength: 0 maxLength: 20 value: description: Value of user defined field. type: number alternateName: description: Label of user defined field used by vendors or customers. type: string minLength: 0 maxLength: 2000 namePrefixType: type: string description: Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.) minLength: 0 maxLength: 40 personNameType: type: object description: This provides name information for a person. properties: namePrefix: description: Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) type: string minLength: 0 maxLength: 40 givenName: description: Given name, first name or names. type: string minLength: 0 maxLength: 40 middleName: description: The middle name of the person name. type: string minLength: 0 maxLength: 40 surname: description: Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name. type: string minLength: 0 maxLength: 40 nameSuffix: description: Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.) type: string minLength: 0 maxLength: 40 nameTitle: description: Degree or honors (e.g., Ph.D., M.D.) type: string minLength: 0 maxLength: 80 nameTitleSuffix: description: Title Suffix. Must be populated if ADVANCED_TITLE is on. type: integer envelopeGreeting: description: Envelope Greeting of the profile type: string salutation: description: Salutation of the profile type: string nameType: description: Type of name of the individual, such as former, nickname, alternate or alias name. $ref: '#/components/schemas/personNameTypeType' language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' externalSystem: description: When name type is external, indicates the external system the name belongs to. type: string minLength: 0 maxLength: 40 attractionCodesType: type: array description: Collection of hotel level alert codes with attached alert types. maxItems: 4000 items: $ref: '#/components/schemas/attractionCodeType' creditCardTypesDetails: type: object description: Response object for fetching Credit Card Types. properties: creditCardTypes: description: Collection of Credit Card Types. $ref: '#/components/schemas/creditCardTypesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' communicationStatusType: type: string description: Enum to denote the Status of Readiness messages sent to Guest Devices. enum: - Pending - Completed - Failed - Sent - Received - Cancelled - PendingAvailability amountDeterminationType: type: string description: Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes. enum: - Inclusive - Exclusive hotelRestaurantsType: type: array maxItems: 4000 items: $ref: '#/components/schemas/hotelRestaurantType' hotelInfoType: type: object description: Contains the basic configuration information about a Hotel. properties: primaryDetails: description: Primary Information of the hotel. type: object properties: legalOwner: description: Legal owner of the hotel. type: string minLength: 0 maxLength: 80 generalInformation: description: General Information of the hotel. type: object properties: hotelType: description: The type of the Hotel. type: string minLength: 0 maxLength: 20 roomCount: description: The total number of rooms in the Hotel. type: integer bedCount: description: The total number of beds in the Hotel. type: integer floorCount: description: The total number of floors of the Hotel. type: integer checkInTime: description: The official check in time of the Hotel. type: string format: date-time checkOutTime: description: The official check out time of the Hotel. type: string format: date-time hotelInfoWebsite: description: URL where property information is located. $ref: '#/components/schemas/uRLType' longitude: description: Longitude of the hotel. type: number latitude: description: Latitude of the hotel. type: number baseLanguage: description: The base language of the Hotel. $ref: '#/components/schemas/languageType' accommodationDetails: description: Accommodation Details of the hotel. type: object properties: singleRooms: description: The number of Single Rooms of the Hotel. type: integer doubleRooms: description: The number of Double Rooms of the Hotel. type: integer twinRooms: description: The number of Twin Rooms of the Hotel. type: integer familyRooms: description: The number of Family Rooms of the Hotel. type: integer connectingRooms: description: The number of Connecting Rooms of the Hotel. type: integer accessibleRooms: description: The number of Accessible Rooms of the Hotel. type: integer nonSmokingRooms: description: The number of Non-Smoking Rooms of the Hotel. type: integer maxAdultsInFamilyRoom: description: Maximum Adults for Family Room Type. type: integer maxChildrenInFamilyRoom: description: Maximum Children for Family Room Type. type: integer guestRoomFloors: description: The total number of the Guest Room Floors. type: integer guestRoomElevators: description: The number of Guest Room Elevators. type: integer suites: description: The number of Suites of the Hotel. type: integer executiveFloorNo: description: The floor number of Executive Floors of the Hotel. type: string minLength: 0 maxLength: 1000 roomAmenties: description: The information about the Room Amenities. type: string minLength: 0 maxLength: 2000 shopDescription: description: The Description of the shops in the Hotel. type: string minLength: 0 maxLength: 2000 propertyControls: description: Property controls information configuration of the hotel. type: object properties: sellControls: description: The sell controls information configuration of the hotel. type: object properties: startDate: description: Date when the hotel become valid for use. type: string format: date maxLength: 8 endDate: description: The end date of the hotel. type: string format: date maxLength: 8 hotelId: description: The hotel code. type: string minLength: 0 maxLength: 80 currencyFormatting: description: Currency Formatting information configuration of the hotel. type: object properties: currencyCode: description: The base currency code for this hotel.. type: string minLength: 0 maxLength: 20 currencyFormat: description: Format for the local currency. type: string minLength: 0 maxLength: 80 currencySymbol: description: Symbol to designate the default currency of the hotel. type: string minLength: 0 maxLength: 20 decimalPositions: description: Number of decimal positions used for this currency type. type: integer cateringCurrencyFormatting: description: Catering Currency Formatting information configuration of the hotel. type: object properties: currencyCode: description: The base currency code for this hotel.. type: string minLength: 0 maxLength: 20 currencyFormat: description: Format for the local currency. type: string minLength: 0 maxLength: 80 dateTimeFormatting: description: Date Time Formatting information configuration of the hotel type: object properties: longDateFormat: description: Long date format of the hotel. type: string minLength: 0 maxLength: 20 shortDateFormat: description: Short date format of the hotel. type: string minLength: 0 maxLength: 20 timeFormat: description: Time format for the hotel. type: string minLength: 0 maxLength: 20 timeZoneRegion: description: Time zone region of the hotel. type: string minLength: 0 maxLength: 80 applicationMode: description: Application Mode information configuration of the hotel. type: object properties: configurationMode: description: The hotel's configuration mode if applicable. type: string minLength: 0 maxLength: 20 countryMode: description: The hotel's country code. type: string minLength: 0 maxLength: 20 expHotelCode: description: Hotel Code used for third party exports. type: string minLength: 0 maxLength: 20 touristNumber: description: The Tourist Number of the hotel. type: string minLength: 0 maxLength: 20 mbsSupported: description: Indicates if the hotel uses MBS (Marriott Business Services). type: boolean enablePropertyConfigurations: description: Indicates if the configurations are enabled for the property. type: boolean isCentralResort: description: Indicates if the property has centra license. type: boolean communication: description: Communication information of the hotel. type: object properties: phoneNumber: description: The direct dial phone number of the hotel. $ref: '#/components/schemas/telephoneType' tollFreeNumber: description: Toll free phone number of the hotel. $ref: '#/components/schemas/telephoneType' faxNumber: description: Fax phone number of the hotel. $ref: '#/components/schemas/telephoneType' emailAddress: description: Email address of the hotel. $ref: '#/components/schemas/basicEmailType' webPage: description: The web address of the hotel. $ref: '#/components/schemas/uRLType' address: description: Provides address information. type: object properties: isValidated: description: Indicator to define if the Address is validated by the Address Validation System. type: boolean addressLine: description: When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence. type: array maxItems: 4 items: type: string minLength: 0 maxLength: 80 cityName: description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). type: string minLength: 0 maxLength: 40 postalCode: description: Post Office Code number. type: string minLength: 0 maxLength: 15 cityExtension: description: Post Office City Extension Code number. City Extension mainly used for UK addresses. type: string minLength: 0 maxLength: 20 county: description: County or District Name (e.g., Fairfax). This is read only. type: string minLength: 0 maxLength: 20 state: description: State or Province name (e.g., Texas). type: string minLength: 0 maxLength: 20 country: description: Country name (e.g., Ireland). $ref: '#/components/schemas/countryNameType' language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' type: description: Defines the type of address (e.g. home, business, other). type: string minLength: 0 maxLength: 20 typeDescription: description: Describes the type code type: string primaryInd: description: When true, indicates a primary information. type: boolean updateReservations: description: Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address. type: boolean barCode: description: The postal barcode for the address. type: string minLength: 0 maxLength: 100 createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 regionCode: description: The region code of the hotel. type: string minLength: 0 maxLength: 20 hotelRestaurants: description: Names of restaurants which can be found in the Hotel. $ref: '#/components/schemas/hotelRestaurantsType' hotelRateRanges: description: The rate ranges which are offered by the hotels. $ref: '#/components/schemas/hotelRateRangesType' alternateHotels: description: Informations about alternative hotels provided by the Hotel. $ref: '#/components/schemas/alternateHotelsType' hotelContacts: description: The contacts information the hotels. $ref: '#/components/schemas/hotelContactsType' hotelEventSpaces: description: Even Space information of the hotel. $ref: '#/components/schemas/hotelEventSpacesType' hotelNotes: description: List of notes for the hotel. $ref: '#/components/schemas/hotelNotesType' hotelCorporateInformations: $ref: '#/components/schemas/hotelCorporateInformationsType' attractions: description: List of Attractions for the hotel. $ref: '#/components/schemas/hotelAttractionsType' meetingRooms: description: List of Meeting Rooms for the hotel. $ref: '#/components/schemas/meetingRoomsType' chainCode: description: The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute. type: string minLength: 0 maxLength: 20 hotelId: description: The code that uniquely identifies a single hotel property. The hotel code is decided between vendors. type: string minLength: 0 maxLength: 20 hotelCityCode: description: The IATA city code; for example DCA, ORD. type: string minLength: 0 maxLength: 40 hotelName: description: A text field used to communicate the proper name of the hotel. type: string minLength: 0 maxLength: 80 hotelCodeContext: description: A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes. type: string minLength: 0 maxLength: 40 chainName: description: The name of the hotel chain (e.g., Hilton, Marriott, Hyatt). type: string minLength: 0 maxLength: 80 configured: description: This flag is to indicate that whether the property is configured in the Welcome screen. type: boolean rateRoomDetailsType: type: object properties: memberships: description: Detail regarding customer loyalty program. type: array maxItems: 4000 items: $ref: '#/components/schemas/membershipSearchType' restrictionType: description: Indicates the restriction types if hotel is not available. $ref: '#/components/schemas/masterRestrictionStatusesType' roomStays: description: Room stay information. type: array maxItems: 4000 items: $ref: '#/components/schemas/roomStayType' resPaymentCardType: type: object description: Information on a credit card for the customer. properties: cardId: description: credit card id $ref: '#/components/schemas/uniqueID_Type' currentAuthorizedAmount: $ref: '#/components/schemas/currencyAmountType' approvalAmountNeeded: $ref: '#/components/schemas/currencyAmountType' cardType: description: Indicates the type of credit card from a defined list $ref: '#/components/schemas/cardTypeType' userDefinedCardType: description: Indicates the user defined credit card type if credit card type from a defined list is not provided type: string minLength: 0 maxLength: 2 cardNumber: type: string minLength: 0 maxLength: 80 cardNumberMasked: type: string minLength: 0 maxLength: 80 cardNumberLast4Digits: type: string minLength: 0 maxLength: 80 expirationDate: description: Expiration date of the credit card type: string format: date maxLength: 8 expirationDateMasked: description: Masked Expiration date of the credit card type: string minLength: 0 maxLength: 20 expirationDateExpired: type: boolean cardHolderName: type: string minLength: 0 maxLength: 200 attachCreditCardToProfile: description: Attach the credit card to profile. type: boolean processing: description: This contains information on whether EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type. $ref: '#/components/schemas/cardProcessingType' swiped: type: boolean cardPresent: description: Flag to determine if the credit card was swiped/manually entered , This element is only used when PAYMENT SERVICE DIRECTIVE(PSD) Opera Control is active. type: boolean cardOrToken: description: This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates credit card is token enabled and 'CardNumber' indicates non token environment for this payment card type. $ref: '#/components/schemas/cardNumberTypeType' citId: description: Customer Initiated Transaction(CIT) Id for Credit Cards. This is only used when PAYMENT SERVICES DIRECTIVE (PSD2) Opera Control is active. type: string minLength: 0 maxLength: 30 webLinkDetails: type: object properties: text: description: Text value to indicate the web link type: string minLength: 0 maxLength: 80 link: description: Actual URL value of the web link type: string minLength: 0 maxLength: 2000 hotelDetails: type: object description: Response object for fetching Property configuration information. properties: hotelConfigInfo: description: Hotel configuration information. $ref: '#/components/schemas/hotelInfoType' masterInfoList: description: Refer to Generic common types document. type: array items: $ref: '#/components/schemas/masterInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' resHousekeepingType: type: object description: Holds housekeeping turndown service information for the room. properties: instructions: description: Turndown instructions for the room. type: string facilityTaskInfo: description: The facility task applicable for the current day. This will be information only and not used for any updates. $ref: '#/components/schemas/facilityTaskType' linenChange: description: Indicates if a linen change is necessary. type: boolean turndownRequested: description: Indicates whether guest wants turndown facility or not. type: boolean serviceTime: description: This is the Turndown room service time. type: string format: date maxLength: 8 expectedServiceTime: description: Expected Start Time for housekeeping task(s). type: string roomStatus: description: Current room status. Current room status is populated only if room is assigned to the reservation and reservation is due in or in house. $ref: '#/components/schemas/housekeepingRoomStatusType' indicatorsType: type: array description: Collection of lamp indicators. maxItems: 4000 items: $ref: '#/components/schemas/indicatorType' addtionalCodeInfoType: type: array description: Holds name of additional code information maxItems: 4000 items: type: object properties: name: description: Holds name of additional code information $ref: '#/components/schemas/masterInfoCodeDetailType' value: description: Holds value of additional code information type: string minLength: 0 maxLength: 2000 telephoneType: type: object description: Information on a telephone number for the customer. properties: phoneTechType: description: Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. type: string minLength: 0 maxLength: 20 phoneUseType: description: Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening). type: string minLength: 0 maxLength: 20 phoneUseTypeDescription: description: Description of the PhoneUseType code type: string minLength: 0 maxLength: 2000 phoneNumber: description: Telephone number assigned to a single location. type: string minLength: 0 maxLength: 40 extension: description: Extension to reach a specific party at the phone number. type: string minLength: 0 maxLength: 20 primaryInd: description: When true, indicates a primary information. type: boolean orderSequence: description: Display Order sequence. type: number createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 uniqueID_Type: type: object description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). properties: id: 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 minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 telephoneBookEntriesToBeChanged: type: object description: Request object for Telephone Book Entries. properties: telephoneBookEntries: description: Telephone Book Entries to be changed. $ref: '#/components/schemas/telephoneBookEntriesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' attractionTemplatesDetails: type: object description: Response object for information regarding attraction templates. properties: attractionTemplates: description: Collection of attraction templates and their information. $ref: '#/components/schemas/attractionTemplatesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' baseApplicationSettingType: type: object description: Internal settings that can be of a certain valueType. properties: shortDescription: type: string minLength: 0 maxLength: 2000 description: type: string minLength: 0 maxLength: 2000 wildCardMatch: description: A flag which indicate whether a wild card search should be made. type: boolean name: type: string minLength: 0 maxLength: 80 displayName: type: string minLength: 0 maxLength: 80 type: $ref: '#/components/schemas/applicationSettingTypeType' hotelId: description: Each configuration item will come with a HotelCode which will help the configuration to specify what context the update has to be. Eg. _Global,ORS,'CRO', etc. type: string minLength: 0 maxLength: 20 sequence: type: number editAllowed: type: boolean value: type: string minLength: 0 maxLength: 2000 scope: type: string enum: - P - G - Ch - C valueType: type: string enum: - Yn - Integer - String - SingleSelectLov - MultiSelectLov - ShuttleLov - Custom - Double - Secure conversionType: description: Represents whether the value is OXI Parameter or Conversion code default. $ref: '#/components/schemas/applicationSettingConversionType' subscriptionCountEligible: description: Indicator if the function does not count against the OPERA Control function count limit or not. type: boolean preferenceType_2: type: object description: Guest Preference details for the profile. properties: preferenceValue: description: Preference value for display purposes. type: string minLength: 0 maxLength: 200 description: description: Preference Description for display purposes. type: string minLength: 0 maxLength: 2000 global: description: Whether this preference is property specific or not. type: boolean source: description: Source of the preference. type: string minLength: 0 maxLength: 40 hotels: description: If specified preference belongs to the Hotels listed, otherwise it is a global preference. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 preferenceId: type: string minLength: 0 maxLength: 20 excludedPreferencesCount: description: Specifies the count of preferences excluded for the attached reservation preference. type: integer tierAdministrationType: type: string description: Do not upgrade membership. The membership may be downgraded. enum: - Disabled - NoUpgrade roomRateAvailReasonType: type: string description: Indicates the Room Rate is not available due to unavailability of enough items for the rate code. enum: - Available - Restricted - RestrictedDueToInventory - RestrictedDueToOccupancy - RestrictedDueToItemInventory hotelContactsToBeChanged: type: object description: Request object for changing hotel Contacts for hotels. properties: hotelContacts: description: Collection of Contacts to be modified. $ref: '#/components/schemas/hotelContactsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyTemplateCodes: type: object properties: templateName: description: Template name to be copied. $ref: '#/components/schemas/copyTemplateType' codes: description: List of template codes to be copied. $ref: '#/components/schemas/codeListType' hotelCodes: description: List of hotel codes for which the template needs to be copied. $ref: '#/components/schemas/hotelCodeListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelEventCodeType: type: object description: Details of Event to be used to set events for a hotel. properties: hotelId: description: Code of the hotel for which the events are being set. type: string minLength: 0 maxLength: 20 eventCode: description: Event code selected. type: string minLength: 0 maxLength: 20 dateRange: description: Date Range with days of week where the range update has to be applied. $ref: '#/components/schemas/timeSpanDaysOfWeekType' eventTitle: description: Event title for the event code. type: string minLength: 0 maxLength: 50 eventDetails: description: 'Details ' type: string minLength: 0 maxLength: 4000 startTime: description: Start time of the event. type: string format: date-time endTime: description: End time of the event. type: string format: date-time allDay: description: Indicates if it is an all day event type: boolean webLink: description: Stores the text and url values $ref: '#/components/schemas/webLinkDetails' location: description: 'Location value ' type: string minLength: 0 maxLength: 2000 availability: description: 'Availability of the slots for the events ' type: string minLength: 0 maxLength: 25 eventImage: type: string format: byte description: Image related to the event creditCardTypesToBeChanged: type: object description: Request object for changing Credit Card Types. properties: creditCardTypes: description: Credit Card Types to be changed. $ref: '#/components/schemas/creditCardTypesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' authorizerInfoType: type: object description: Authorizer Information properties: authorizerId: $ref: '#/components/schemas/uniqueID_Type' authorizerUserName: description: Application user name of the authorizer type: string minLength: 0 maxLength: 40 authorizerName: description: Full name of the authorizer. type: string minLength: 0 maxLength: 100 authorizerRateCode: description: Rate code of the authorizer. type: string minLength: 0 maxLength: 20 inheritAuthorizerRateCode: description: Indicates whether user has the choice to have reservation inherit rate code from the authorizer. type: boolean yieldAdjustmentCodesCriteria: type: object description: Request object for creating new Yield AdjustmentCodes Configurations. properties: yieldAdjustmentCodes: description: Yield AdjustmentCodes Configurations to be created. $ref: '#/components/schemas/yieldAdjustmentCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' resCommunicationType: type: object description: Communication details for a reservation. properties: telephones: description: List of Telephone Number Information type: object properties: telephoneInfo: description: Collection of Detailed information on telephone/fax for the customer. type: array maxItems: 4000 items: $ref: '#/components/schemas/telephoneInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer emails: description: List of email address for the customer. type: object properties: emailInfo: description: Collection of Detailed information on an eMail address for the customer. type: array maxItems: 4000 items: $ref: '#/components/schemas/emailInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer masterInfoType: type: object properties: codeInfo: type: array maxItems: 4000 items: $ref: '#/components/schemas/codeInfoType' codeType: $ref: '#/components/schemas/masterType' currencyExchangeRatesDetails: type: object description: Response with the list of currency codes and their exchange rates for each property requested. properties: exchangeRates: description: List of currency codes with their exchange rates. type: array items: type: object properties: exchangeInfo: description: Exchange Rate information for a currency code. type: array items: $ref: '#/components/schemas/currencyExchangeRateType' hotelId: $ref: '#/components/schemas/codeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelRateRangesType: type: array description: Lists of rate ranges of the hotel. maxItems: 4000 items: $ref: '#/components/schemas/hotelRateRangeType' yieldMarketTypesToBeChanged: type: object description: Request object for changing existing Yield Market Types. properties: code: description: Yield Market Code. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel code for which the yield market type belong to. type: string minLength: 0 maxLength: 20 description: description: Description for the yield market code. type: string minLength: 0 maxLength: 200 alternativeCode: description: If the yield market code does not return a result, this alternative yield market code is used instead. type: string minLength: 0 maxLength: 20 default: description: Indicates the default yield market type. type: boolean links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' reservationProfileType: type: object properties: profileIdList: description: Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id. $ref: '#/components/schemas/profileIdList' profile: description: Provides detailed information regarding either a company or a customer profile. $ref: '#/components/schemas/profileType' reservationProfileType: $ref: '#/components/schemas/resProfileTypeType' marketingCitiesCriteria: type: object description: Request object for creating new marketing cities for hotels. properties: marketingCities: description: Collection of marketing cities to be created. $ref: '#/components/schemas/marketingCitiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelToBeChanged: type: object description: Request object for changing Property general information. properties: hotelInfo: description: The basic configuration information about a Hotel. $ref: '#/components/schemas/hotelInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' configActivityLogDetails: type: object description: Response object for fetching configuration activity log. properties: activityLog: description: Contains list of the activity logs. $ref: '#/components/schemas/activityLogListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' applicationSettingLevelType: type: string enum: - Global - Hotel - Cro basicEmailType: type: string description: Email address minLength: 0 maxLength: 2000 awardVouchersType: type: array description: This stores the Membership Awards code applied on the reservation. maxItems: 5 items: type: object properties: awardCode: description: Membership Award code applied on the reservation. type: string minLength: 0 maxLength: 20 voucherNo: description: Membership Award number. type: string minLength: 0 maxLength: 80 departmentsDetails: type: object description: Response object for fetching departments. properties: departments: description: Type contains departments. $ref: '#/components/schemas/departmentsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipSearchType: type: object description: Identifies criteria for searching frequent customer reward program. properties: membershipId: description: Membership ID criteria. type: string membershipLevel: description: Membership Level criteria. $ref: '#/components/schemas/codeListType' membershipType: description: Membership Type criteria. $ref: '#/components/schemas/codeListType' associatedReservationsOnly: description: If this is true,the reservations which has membership information associated will be resulted . type: boolean hotelEventSpaceDetailType: type: object description: The detail info of hotel event space properties: code: description: The code of hotel event space. type: string minLength: 0 maxLength: 20 description: description: Th description of the hotel event space type: string minLength: 0 maxLength: 2000 maxCapacity: description: Th max capacity of the hotel event space type: integer maxOccupancies: description: List of max occupancies of the event space based on the setup code. $ref: '#/components/schemas/eventSpaceMaxOccupanciesType' profileCommissionType: type: object description: This is the preconfigured routing instruction type. properties: hotelId: description: Hotel Code for the commission being used for a profile. type: string minLength: 0 maxLength: 20 commissionCode: description: commission Code for a profile. type: string minLength: 0 maxLength: 20 bankAccount: description: Bank account used for the commission for a profile. type: string minLength: 0 maxLength: 20 paymentMethod: description: Type of payment associated with the bank account. $ref: '#/components/schemas/commissionPaymentMethods' currencyCode: description: The code specifying a monetary unit. Use ISO 4217, three alpha code. type: string minLength: 0 maxLength: 20 currencySymbol: description: The symbol for the currency, e.g, for currencyCode USD the symbol is $. type: string minLength: 0 maxLength: 10 decimalPlaces: description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85). type: integer applicationSettingGroupType: type: object description: This element simply groups the different Application Functions. properties: appSettings: type: array maxItems: 4000 items: $ref: '#/components/schemas/applicationSettingType' groupName: type: string minLength: 0 maxLength: 80 groupDisplayName: type: string minLength: 0 maxLength: 80 identificationType: type: object description: Identification information of the customer. properties: idType: description: Identification Type. Eg Passport, Driving License etc. type: string minLength: 0 maxLength: 40 idNumber: description: Identification Number. type: string minLength: 0 maxLength: 80 idNumberMasked: description: Masked Identification Number. type: string minLength: 0 maxLength: 80 issuedCountry: description: The country where Identification was issued. type: string minLength: 0 maxLength: 20 issuedDate: description: Issued date of Identification. type: string format: date maxLength: 8 issuedPlace: description: The place where Identification was issued. type: string minLength: 0 maxLength: 80 expirationDate: description: Expiration date of Identification. type: string format: date maxLength: 8 registeredProperty: description: Property where the identification belongs to. type: string minLength: 0 maxLength: 20 primaryInd: description: When true, indicates a primary information. type: boolean orderSequence: description: Display Order sequence. type: number relationshipProfileType: type: object properties: customer: description: Detailed information of the customer $ref: '#/components/schemas/customerType' company: description: Detailed information of the Company. $ref: '#/components/schemas/companyType' telephone: description: Information on telephone details for the customer/company $ref: '#/components/schemas/telephoneInfoType' address: description: Information on address details for the customer/company $ref: '#/components/schemas/addressInfoType' email: description: Information on email address for the customer/company $ref: '#/components/schemas/emailInfoType' uRLs: description: Information on web url/address for the customer/company $ref: '#/components/schemas/uRLInfoType' primaryOwner: description: Primary Owner of the profile $ref: '#/components/schemas/ownerType' profileIdList: description: Original profile details for which the relationships was created $ref: '#/components/schemas/uniqueIDListType' changeProfileIdList: description: Updated/changed profile details for the relationships created $ref: '#/components/schemas/uniqueIDListType' primary: description: Indicates if this relationship is the primary relationship. type: string minLength: 0 maxLength: 20 id: description: Relationship identifier. type: string minLength: 0 maxLength: 80 statusCode: description: Status of the profile. Active/Inactive $ref: '#/components/schemas/profileStatusType' profileType: description: Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact. $ref: '#/components/schemas/profileTypeType' deleteTransportationRequest: type: object properties: label: type: array items: type: string orderBy: type: array items: type: integer createDateTime: type: string format: date-time description: Time stamp of the creation. creatorId: type: string description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. extension: type: string description: Extension to reach a specific party at the phone number. lastModifierId: type: string description: Identifies the last software system or person to modify a record. lastModifyDateTime: type: string format: date-time description: Time stamp of last modification. phoneNumberOrderSequence: type: number description: Display Order sequence. phoneNumber: type: string description: Telephone number assigned to a single location. phoneTechType: type: string description: Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. phoneUseType: type: string description: Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening). phoneUseTypeDescription: type: string description: Description of the PhoneUseType code phoneNumberPrimaryInd: type: boolean description: When true, indicates a primary information. purgeDate: type: string format: date description: Date an item will be purged from a database (e.g., from a live database to an archive). distance: type: number description: Defines the distance between two points. distanceType: type: string description: The unit of measure in a code format. drivingTime: type: string description: The driving time in a free text format. description: type: array items: type: string description: The description of the transportation. comments: type: array items: type: string description: Comments about the transportation. priceRange: type: array items: type: string description: The price range of the transportation. websiteOrderSequence: type: number description: Display Order sequence. websitePrimaryInd: type: boolean description: When true, indicates a primary information. type: type: string description: Defines the purpose of the URL address, such as personal, business, public, etc. typeDescription: type: string description: Describes the Type code keyOptionsCodes: type: array maxItems: 4000 items: type: string setHotelEvents: type: object description: Request object for setting hotel events for specified date range. properties: hotelEvents: description: Collection of hotel calendar event entries to be created. $ref: '#/components/schemas/hotelEventCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelTransportationType: type: object description: Information about the transportations of the hotel. properties: phoneNumber: description: The name of the package. $ref: '#/components/schemas/telephoneType' relativePosition: $ref: '#/components/schemas/relativePositionType' description: description: The description of the transportation. type: string minLength: 0 maxLength: 1000 comments: description: Comments about the transportation. type: string minLength: 0 maxLength: 2000 priceRange: description: The price range of the transportation. type: string minLength: 0 maxLength: 40 website: description: Web address associated with transportation. $ref: '#/components/schemas/uRLType' keyOptions: description: This is a placeholder element for future use. Functionality may not be available for the current implementation. $ref: '#/components/schemas/codeListType' transportationCode: type: string minLength: 0 maxLength: 20 label: type: string minLength: 0 maxLength: 1 orderBy: type: integer managedBy: $ref: '#/components/schemas/managedByOptions' templateMarketingCityInfoType: type: object description: Template marketing city details. properties: marketingCity: description: Marketing city code. type: string minLength: 0 maxLength: 40 regionCode: description: Region code the marketing city belongs to. type: string minLength: 0 maxLength: 20 attractionTemplatesType: type: array description: Collection of attraction templates. maxItems: 4000 items: $ref: '#/components/schemas/attractionTemplateType' masterAccountInfoType: type: object properties: masterAccountId: description: Unique ID of the Master account. $ref: '#/components/schemas/uniqueID_Type' masterAccountName: description: Name of the Master account. type: string minLength: 0 maxLength: 40 templateCountriesToBeChanged: type: object description: Request object for modifying template Countries. properties: templateCountries: description: Collection of template of Countries to be modified. $ref: '#/components/schemas/templateCountriesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelDetailType: type: object description: Base details used for storing information about a hotel detail. properties: code: description: Specifies the hotel detail code. type: string minLength: 0 maxLength: 20 description: description: Specifies the hotel detail description. type: string minLength: 0 maxLength: 2000 category: description: Specifies the hotel detail category. type: string minLength: 0 maxLength: 20 sequence: description: Specifies the sorting sequence number for the hotel detail. type: integer hotelId: description: Specifies the hotel code of the hotel detail. type: string minLength: 0 maxLength: 20 verified: description: Specifies if hotel detail values are being verified to match template values. type: boolean dataType: description: Specifies the data type of the added hotel detail value codes. $ref: '#/components/schemas/hotelDetailDataType' hotelDetailValues: description: Collection of values which are associated with the hotel detail. $ref: '#/components/schemas/hotelDetailValuesType' managedBy: $ref: '#/components/schemas/managedByOptions' numericUDFsType: type: array description: Used to hold collection of user defined fields of Numeric Type. maxItems: 4000 items: $ref: '#/components/schemas/numericUDFType' hotelEventSpaceDetailsType: type: array description: List of detail info of hotel event space maxItems: 4000 items: $ref: '#/components/schemas/hotelEventSpaceDetailType' bookingChannelType: type: object properties: channelCode: type: string minLength: 0 maxLength: 20 channelName: type: string minLength: 0 maxLength: 80 channelType: type: string minLength: 0 maxLength: 240 activityLogType: type: object properties: hotelId: type: string minLength: 0 maxLength: 20 module: type: string logDate: type: string format: date-time refActionId: type: number logUserId: type: integer logUserName: type: string machineStation: type: string croCode: type: string minLength: 0 maxLength: 20 actionType: type: string minLength: 0 maxLength: 100 actionDescription: type: string minLength: 0 maxLength: 2000 iPAddress: description: The IP Address of the machine that performed the activity type: string minLength: 0 maxLength: 2000 deviceCode: description: The selected device code type: string minLength: 0 maxLength: 2000 masterType: type: string enum: - Country - State - AddressType - PhoneType - RateCategory - CalculationRule - PostingRythym - BillingInstruction - TransactionCode - DisplaySet - MailingActions - DistanceType - District - Territory - FiscalRegion - InventoryItem - Package - RoomFeaturePreference - SpecialPreference - Promotion - Department - ReservationPreference - FacilityTask - RoomType - RateCode - OutOfOrderReason - Block resGuaranteeType: type: object description: Validations type record returned after Validations are done. properties: guaranteeCode: description: Guarantee Code. type: string minLength: 0 maxLength: 20 shortDescription: description: Guarantee Code. type: string minLength: 0 maxLength: 80 onHold: description: Guarantee Code. type: boolean transportationToBeChanged: type: object description: Request object for modifying transportation. properties: transportationList: $ref: '#/components/schemas/transportationListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' searchTelephoneBookEntriesRequest: type: object properties: category: type: string description: Category code that the telephone book entry belongs to. name: type: string description: Wildcard search on the name of telephone book entry. phoneNumberType: type: string description: Phone number minLength: 0 maxLength: 40 templateAmenitiesCriteria: type: object description: Request object for creating amenities at the template level. properties: templateAmenities: description: Collection containing details of amenities specified at the template level. $ref: '#/components/schemas/configTemplateAmenitiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateHotelDetailsCriteria: type: object description: Request object for creating hotel details at the template level. properties: templateHotelDetails: description: Collection containing information of hotel details to be created at the template level. $ref: '#/components/schemas/templateHotelDetailsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' jobTitlesToBeChanged: type: object description: Request object for modifying job titles for hotels. properties: jobTitles: description: Collection of job titles to be modified. $ref: '#/components/schemas/jobTitlesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelInterfaceStatusType: type: string description: Status of the Hotel Interface either STOPPED or RUNNING. enum: - Stopped - Running - Waiting - StopInitiated - StartInitiated - RebootInitiated - Other eCertificateConsumeSourceType: type: string description: Indicates that OPERA E-Certificate is consumed by hotelPMS. enum: - Central - Web - Hotel hotelConferenceFacilitiesType: type: object properties: hotelBanquetSpace: description: Banquet Space of the hotel. $ref: '#/components/schemas/hotelBanquetSpaceType' hotelConferenceRooms: description: Conference Rooms of the Hotel. $ref: '#/components/schemas/hotelConferenceRoomsType' configLanguageType: type: object description: This gives detailed information about a language. properties: description: description: Description gives the full text language name associated with the code. $ref: '#/components/schemas/translationTextType50' translationLanguageCode: description: Translation Language Code is required for the Translation Studio program to display language into which object has been translated. type: string minLength: 0 maxLength: 20 reportDateLanguage: description: Report Date Language if filled will represent correctly in the report language date elements that might be spelled out, like the day-of-week or the month. type: string minLength: 0 maxLength: 40 useAsAlternateLanguage: description: This is a placeholder element for future use. Functionality may not be available for the current implementation. type: boolean locale: description: Geographic, political or cultural region. type: string minLength: 0 maxLength: 40 localeDescription: description: Description for the locale. type: string minLength: 0 maxLength: 80 languageCode: description: Language Code is a user definable code that identifies a language. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' upsellInfoType: type: object description: Information regarding upsell for a reservation. properties: originalInfo: description: Original Values of the reservation prior to upgrade. type: object properties: rateCode: description: The Rate Code of the Reservation before it was upgraded type: string minLength: 0 maxLength: 20 totalAmount: description: Total Amount of the reservation before it was upgraded. $ref: '#/components/schemas/currencyAmountType' roomType: description: Original Reservation Room Type before being upgraded. $ref: '#/components/schemas/codeDescriptionType' nights: description: The number of nights of the reservation before being upgraded. type: integer upsellInfo: description: Information of a reservation during the process of upgrade. type: object properties: totalUpsellCharge: description: Amount that was charged for the upsell. $ref: '#/components/schemas/currencyAmountType' totalUpsellMoneyAmount: description: Total Amount that was charged including upsell. $ref: '#/components/schemas/currencyAmountType' firstNightUpsellAmount: description: First Night Total Amount including Upsell. $ref: '#/components/schemas/currencyAmountType' firstNightUpsellCharge: description: First Night Upsell Charges. $ref: '#/components/schemas/currencyAmountType' totalUpsellPoints: description: Total Upsell Points. type: integer totalActualRateAmount: description: Actual Total Room Rate for the Target Upsell Room Type. $ref: '#/components/schemas/currencyAmountType' roomType: description: Reservation Room Type for Upsell. $ref: '#/components/schemas/codeDescriptionType' roomLongDescription: description: Detail description of the Room Type. type: string minLength: 0 maxLength: 2000 ruleId: description: Upsell Rule Id. type: integer ruleCode: description: Upsell rule code type: string minLength: 0 maxLength: 20 ruleDescription: description: Upsell rule description type: string minLength: 0 maxLength: 2000 percentageSavings: description: Percentage savings resulting from accepting upsell offer. This will be calculated as the ratio of the amount saved by accepting the upsell offer to the actual room rate (i.e. room rate when upsell is not offered) type: number minimum: 0 maximum: 100 upsellDate: description: The date on which reservation is upgraded. type: string format: date maxLength: 8 upsellUser: description: User who upgraded the reservation. type: string minLength: 0 maxLength: 40 airportsToBeChanged: type: object description: Request object for modifying airports for hotels. properties: airports: description: Collection of airports to be modified. $ref: '#/components/schemas/airportsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' telephoneBookCategoriesDetails: type: object description: Response object for fetch Telephone Categories. properties: telephoneCategories: description: Collection of telephone categories. $ref: '#/components/schemas/telephoneCategoriesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' iATAInfoType: type: object description: IATA Information of the profile. properties: iATACompany: description: IATA Company Detail. type: string minLength: 0 maxLength: 20 iATAConsortia: description: IATA Consortia. type: string minLength: 0 maxLength: 40 iATAValidationResult: description: IATA Validation Result. type: boolean preferenceTypeType_2: type: object description: Preference details for the profile. properties: preference: description: Collection of Preferences for the profile. type: array maxItems: 4000 items: $ref: '#/components/schemas/preferenceType_2' preferenceType: description: Preference group code. type: string minLength: 0 maxLength: 20 preferenceTypeDescription: description: Preference group description. type: string sequence: description: Preference Sequence. type: string maxQuantity: description: Maximum quantity of preferences allowed per preference group. type: integer availableQuantity: description: Available quantity of preferences (maximum quantity - Existing preferences)per preference group. type: integer maxResortUsedQuantity: description: Maximum quantity of preferences used by any resort per preference group. type: integer reservationPreference: description: Whether this preference is reservation preference or not. type: boolean createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 guestCountsType: type: object description: A collection of GuestCount by age group. properties: childAges: description: Defines Children's Ages. Number of children ages mentioned may mot match with children counts. $ref: '#/components/schemas/childAgesType' childBuckets: description: Defines children counts with Age Qualifying Group(Child Bucket#1) classification. $ref: '#/components/schemas/childBucketsType' adults: description: Defines the number of Adults. type: integer children: description: Defines the number of Children. type: integer emailType: type: object description: Information on an email for the customer. properties: emailAddress: description: Defines the e-mail address. type: string minLength: 0 maxLength: 2000 type: description: Defines the purpose of the e-mail address (e.g. personal, business, listserve). type: string minLength: 0 maxLength: 20 typeDescription: description: Describes the Type code type: string minLength: 0 maxLength: 2000 emailFormat: description: Supported Email format. type: string enum: - Html - Text primaryInd: description: When true, indicates a primary information. type: boolean orderSequence: description: Display Order sequence. type: number createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 hotelDayTypeType: type: object description: Details of Day Type to be used to set day types for a hotel. properties: hotelId: description: Day type code selected. type: string minLength: 0 maxLength: 20 dayTypeCode: description: Day type code selected. type: string minLength: 0 maxLength: 20 dateRange: description: Date Range with days of week where the range update has to be applied. $ref: '#/components/schemas/timeSpanDaysOfWeekType' copyMarketingCities: type: object description: Request object for copying template marketing cities to hotel(s). properties: copyInstructions: description: List of the template marketing city(s) to be copied to hotel(s). $ref: '#/components/schemas/copyMarketingCitiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' transportationType: type: object description: Information about the transportations of the hotel. properties: phoneNumber: description: The name of the package. $ref: '#/components/schemas/telephoneType' relativePosition: $ref: '#/components/schemas/relativePositionType' description: description: The description of the transportation. type: string minLength: 0 maxLength: 1000 comments: description: Comments about the transportation. type: string minLength: 0 maxLength: 2000 priceRange: description: The price range of the transportation. type: string minLength: 0 maxLength: 40 website: description: Web address associated with transportation. $ref: '#/components/schemas/uRLType' keyOptions: description: This is a placeholder element for future use. Functionality may not be available for the current implementation. $ref: '#/components/schemas/codeListType' transportationCode: type: string minLength: 0 maxLength: 20 label: type: string minLength: 0 maxLength: 1 orderBy: type: integer hotelId: description: Hotel code for the transportation. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' codeType: type: string description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. minLength: 0 maxLength: 20 uRLType: type: object description: Web site address, in IETF(The Internet Engineering Task Force) specified format. properties: value: type: string description: Property Value type: description: Defines the purpose of the URL address, such as personal, business, public, etc. type: string minLength: 0 maxLength: 20 typeDescription: description: Describes the Type code type: string minLength: 0 maxLength: 2000 primaryInd: description: When true, indicates a primary information. type: boolean orderSequence: description: Display Order sequence. type: number codeInfoType: type: object description: '' properties: description: type: string minLength: 0 maxLength: 80 addtionalCodeInfo: $ref: '#/components/schemas/addtionalCodeInfoType' hotelId: type: string minLength: 0 maxLength: 20 code: type: string minLength: 0 maxLength: 20 companyType: type: object properties: companyName: description: Name of the company. type: string minLength: 0 maxLength: 40 companyName2: description: Second Name of the company. type: string minLength: 0 maxLength: 40 companyName3: description: Third Name of the company. type: string minLength: 0 maxLength: 40 alternateName: description: Alternate Name of the Company. Mainly, it's the name of the company written in the Alternate Language. type: string minLength: 0 maxLength: 40 alternateLanguage: description: Alternate Language of the company. type: string minLength: 0 maxLength: 20 businessLocale: description: A jurisdiction(Territory) in which a company is authorized to do business. type: string minLength: 0 maxLength: 40 iATAInfo: description: IATA Information of the profile. $ref: '#/components/schemas/iATAInfoType' businessTitle: description: Business Title. type: string minLength: 0 maxLength: 80 currencyCode: description: The code specifying a monetary unit. Use ISO 4217, three alpha code. type: string minLength: 0 maxLength: 20 currencySymbol: description: The symbol for the currency, e.g, for currencyCode USD the symbol is $. type: string minLength: 0 maxLength: 10 decimalPlaces: description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85). type: integer language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' nationality: description: Nationality code identification type: string minLength: 0 maxLength: 20 nationalityDescription: description: Nationality code description type: string minLength: 0 maxLength: 80 commissionCode: description: Commission code of the company. type: string minLength: 0 maxLength: 20 creditRating: description: Credit Rating of the company. type: string minLength: 0 maxLength: 20 corporateIdType: description: The type of corporate ID type: string minLength: 0 maxLength: 20 vipStatus: description: VIP status of the company. type: string minLength: 0 maxLength: 20 vipDescription: description: Description of the VIP status. type: string minLength: 0 maxLength: 2000 blacklist: description: This element tells if profile is blacklisted or not. type: boolean departmentType: type: object description: Type provides department information. properties: hotelId: description: Property Code where the department belongs to. type: string minLength: 0 maxLength: 20 departmentCode: description: Department Code. type: string minLength: 0 maxLength: 10 departmentName: description: Description of the department. $ref: '#/components/schemas/translationTextType30' displaySequence: description: Display Sequence for the department. type: integer email: description: Department email address. type: string minLength: 0 maxLength: 2000 managedBy: $ref: '#/components/schemas/managedByOptions' changeRelationsType: type: object description: Detailed information regarding the changes made to relationships for the profile. properties: id: description: Relationship identifier. type: string minLength: 0 maxLength: 80 relation: description: Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile). type: string minLength: 0 maxLength: 20 relationDescription: description: Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile). type: string minLength: 0 maxLength: 200 targetRelation: description: Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile). type: string minLength: 0 maxLength: 20 targetRelationDescription: description: Displays the description of the target relation(Target Profile). type: string minLength: 0 maxLength: 200 templateAmenitiesDetails: type: object description: Response object for fetching amenities at the template level. properties: templateAmenities: description: Collection of amenities specified at the template level. $ref: '#/components/schemas/configTemplateAmenitiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' stayHistoryListType: type: object description: A collection of reservation history details attached to Profiles. properties: reservationInfo: description: 'Additional reservation information attached to the profile . Eg : History reservation details' type: array maxItems: 4000 items: $ref: '#/components/schemas/stayReservationInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer marketingCitiesType: type: array description: Marketing city details for a hotel. maxItems: 4000 items: $ref: '#/components/schemas/marketingCityConfigType' reservationAllowedActionsType: type: array description: Allowed action. maxItems: 11 items: $ref: '#/components/schemas/reservationAllowedActionType' templateHotelDetailsIDType: type: array description: Collection of template level hotel detail identifiers. maxItems: 4000 items: $ref: '#/components/schemas/templateHotelDetailIDType' countriesType: type: array description: Country details. maxItems: 4000 items: $ref: '#/components/schemas/countryType' vIPType: type: object description: The supplier's ranking of the customer. properties: vipCode: description: VIP Code. type: string minLength: 0 maxLength: 20 vipDescription: description: VIP Description. type: string minLength: 0 maxLength: 80 searchMatchesType: type: array description: List of Generic Name-Value-Pair Parameters used for super search matches. maxItems: 4000 items: $ref: '#/components/schemas/searchMatchType' transportationInfoType: type: object description: Information about the transportation type. properties: label: description: Single character label for the transportation type. type: string minLength: 0 maxLength: 1 description: description: Description of the transportation type. type: string minLength: 0 maxLength: 1000 code: description: Code for the transportation type. type: string minLength: 0 maxLength: 20 eventSpaceMaxOccupanciesType: type: array description: List of event space max occupancy. maxItems: 5 items: type: integer languageType: type: string minLength: 0 maxLength: 40 templateJobTitlesDetails: type: object description: Response object for fetching template job titles. properties: templateJobTitles: description: Collection of template job titles. $ref: '#/components/schemas/templateJobTitlesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' taxType: type: object description: Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways. properties: description: type: string minLength: 0 maxLength: 2000 type: description: Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other). $ref: '#/components/schemas/amountDeterminationType' code: description: Code identifying the fee (e.g.,agency fee, municipality fee). type: string minLength: 0 maxLength: 20 amount: description: A monetary amount. type: number currencyCode: description: Provides a currency code to reflect the currency in which an amount may be expressed. type: string minLength: 3 maxLength: 3 resPreConfiguredRoutingInstrType: type: object description: Instruction to attach Pre-Configured Routing Instructions to a Reservation. properties: authorizerInfo: description: The authorizer information for Promotion Code with attached Complimentary Routing $ref: '#/components/schemas/authorizerInfoType' ratePlanCode: description: Rate Code with attached Routing Instruction. type: string minLength: 0 maxLength: 20 profileType: description: Profile Type with attached Routing Instruction. $ref: '#/components/schemas/resProfileTypeType' promotionCode: description: Promotion Code with attached Complimentary Routing. type: string minLength: 0 maxLength: 20 translationTextType30: type: object description: Contains Multiple translated texts and language codes. properties: defaultText: description: Default text with Character length from 0 to 30. type: string minLength: 0 maxLength: 30 translatedTexts: description: List of translated text and language codes. $ref: '#/components/schemas/translationsTextType' translationTextType50: type: object description: Contains Multiple translated texts and language codes. properties: defaultText: description: Default text with Character length from 0 to 50. type: string minLength: 0 maxLength: 50 translatedTexts: description: List of translated text and language codes. $ref: '#/components/schemas/translationsTextType' yieldCategoriesCriteria: type: object description: Request object for creating new Yield Category Configurations. properties: hotelId: description: Code of the Hotel. type: string minLength: 0 maxLength: 20 code: description: Code of the Yield Category. type: string minLength: 0 maxLength: 20 description: description: Description of the Yield Category. type: string minLength: 0 maxLength: 40 links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' reservationBlockType: type: object description: Key information about the block for a reservation. properties: blockIdList: description: Collection of unique block identifiers for the reservation. $ref: '#/components/schemas/blockIdList' blockName: description: The Name of the block that is attached to the reservation. type: string minLength: 0 maxLength: 40 hotelId: description: This is the HotelCode of the Block. type: string minLength: 0 maxLength: 20 operation: type: object description: Type that holds Operation values properties: operation: description: Operations type: string minLength: 0 maxLength: 2000 code: description: Unique identifier of Configuation Item type: string minLength: 0 maxLength: 2000 templateJobTitlesType: type: array description: Template job title details. maxItems: 4000 items: $ref: '#/components/schemas/templateJobTitleType' anonymizationStatusType: type: string description: Guest has been anonymized. enum: - Requested - Anonymized characterUDFType: type: object description: Used to hold user defined field of Character/String Type. properties: name: description: Used to hold user defined field of Character Type. It is highly recommended to use UDFC01, UDFC02,...UDFC40 (Total 40) as Character/String UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required. type: string minLength: 0 maxLength: 20 value: description: Value of user defined field. type: string minLength: 0 maxLength: 2000 alternateName: description: Label of user defined field used by vendors or customers. type: string minLength: 0 maxLength: 2000 packageElementType: type: object properties: amount: $ref: '#/components/schemas/currencyAmountType' allowance: $ref: '#/components/schemas/currencyAmountType' description: type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 2000 startDate: type: string format: date maxLength: 8 endDate: type: string format: date maxLength: 8 packageCode: type: string calculationRule: type: string postingRhythm: type: string quantity: type: integer includedInRate: type: boolean addRateSeprateLine: type: boolean addRateCombinedLine: type: boolean startTime: type: string endTime: type: string sellSeparate: type: boolean childAgeType: type: object description: Defines Child's Age. properties: age: description: Age of a child in years. type: integer yieldAdjustmentTypeType: type: string description: Defines values for Yield Adjustment Types. enum: - PerStay - PerNight - PerPersonPerNight - PerPersonPerStay jobTitleType: type: object description: Base details common between both template and hotel job titles. properties: code: description: Job Title Code. type: string minLength: 0 maxLength: 20 description: description: Description of the job title. $ref: '#/components/schemas/translationTextType80' displayClosingScript: description: Flag to indicate if display reservation closing script. type: boolean hotelId: description: Property Code where the job title belongs to. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' externalReferenceType: type: object description: This type contains unique information of external reference. properties: id: description: Unique ID of external reference. type: string minLength: 0 maxLength: 80 idExtension: description: ID extension for external reference. type: integer idContext: description: ID context for external reference. type: string minLength: 0 maxLength: 80 gdsNegotiatedType: type: object description: This holds a list of GdsNegotiatedInfoType. properties: gdsNegotiatedInfoList: description: List of channel negotiated rates for the profile. type: array maxItems: 4000 items: $ref: '#/components/schemas/gdsNegotiatedInfoType' bookingChannelCode: description: Booking Channel Code. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel Code. type: string minLength: 0 maxLength: 20 channelRatePlanCode: description: Channel Room Type. type: string minLength: 0 maxLength: 20 profileAccessType: type: object properties: chainCode: description: Indicates the Chain code where the profile was created type: string minLength: 0 maxLength: 200 croCode: description: Indicates the CRO code where the profile was created type: string minLength: 0 maxLength: 200 hotelId: description: Indicates the Hotel code where the profile was created type: string minLength: 0 maxLength: 200 sharedLevel: description: 'Indicates whether the profile is shared at the following levels : global/property/CRO' $ref: '#/components/schemas/profileSharedLevelType' profileType: type: object description: Type provides the detailed information about the profile and its children. properties: customer: description: Detailed customer information for this profile. $ref: '#/components/schemas/customerType' company: description: Detailed company information for this profile. $ref: '#/components/schemas/companyType' profileImage: description: The profile image. $ref: '#/components/schemas/imageSetType' addresses: description: List of customer addresses. type: object properties: addressInfo: description: Collection of Detailed information on an address for the customer. type: array maxItems: 4000 items: $ref: '#/components/schemas/addressInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer businessSegments: description: Business/Market Segment associated to the profile. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 territory: description: Territory associated to the profile. type: string minLength: 0 maxLength: 40 traceCode: description: Trace Code associated to the profile. type: string minLength: 0 maxLength: 40 ownerCode: description: Owner Code associated to the profile. type: string minLength: 0 maxLength: 40 influenceCode: description: Influence Code associated to the profile. type: string minLength: 0 maxLength: 40 telephones: description: List of Telephone Number Information type: object properties: telephoneInfo: description: Collection of Detailed information on telephone/fax for the customer. type: array maxItems: 4000 items: $ref: '#/components/schemas/telephoneInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer emails: description: List of email address for the customer. type: object properties: emailInfo: description: Collection of Detailed information on an eMail address for the customer. type: array maxItems: 4000 items: $ref: '#/components/schemas/emailInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer uRLs: description: List of Information on a URL for the customer. type: object properties: uRLInfo: description: Collection of Detailed information on web url/address for the customer. type: array maxItems: 4000 items: $ref: '#/components/schemas/uRLInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer comments: description: List of Notes for the customer. type: object properties: commentInfo: description: Collection of Detailed information on comments for the customer. type: array maxItems: 4000 items: $ref: '#/components/schemas/commentInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer profileDeliveryMethods: description: List of Delivery methods configured against a Property for this Profile. type: object properties: profileDeliveryMethod: description: Collection of delivery methods for this Profile. type: array maxItems: 4000 items: $ref: '#/components/schemas/profileDeliveryMethod' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer profileMemberships: description: List of loyalty program(s) the profile is subscribed to. type: object properties: profileMembership: description: Collection of Detailed information on memberships for the customer. type: array maxItems: 4000 items: $ref: '#/components/schemas/profileMembershipType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer preferenceCollection: description: List of customer preferences. type: object properties: preferenceType: description: Collection of Detailed information on preferences of the customer. type: array maxItems: 4000 items: $ref: '#/components/schemas/preferenceTypeType_2' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer keywords: description: List of customer keywords. type: object properties: keyword: description: Collection of keywords attached to the profile. type: array maxItems: 4000 items: $ref: '#/components/schemas/keywordType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer negotiatedRates: description: List of profile negotiated rates. type: object properties: negotiatedRate: description: Collection of Detailed information on profile negotiated rates. type: array maxItems: 4000 items: $ref: '#/components/schemas/negotiatedType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer gdsNegotiatedRates: description: List of channel negotiated rates that this profile has been assigned to. type: object properties: gdsNegotiatedRate: description: Collection of Detailed information on channel negotiated rates for the profile. type: array maxItems: 4000 items: $ref: '#/components/schemas/gdsNegotiatedType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer profileIndicators: description: Indicators of additional information attached to the profile $ref: '#/components/schemas/indicatorsType' relationships: description: Contains a collection of profiles that have a relationship with this profile. type: object properties: relationship: description: A collection of the profiles that have a relationship with this profile. type: array maxItems: 4000 items: $ref: '#/components/schemas/relationshipInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer relationshipsSummary: description: Contains a collection of profiles that have a relationship with this profile. type: object properties: relationship: description: A collection of the profiles summary that have a relationship with this profile. type: array maxItems: 4000 items: $ref: '#/components/schemas/relationshipInfoSummaryType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer reservationInfoList: description: Collection of Detailed information on history and future reservations associated with the profile. $ref: '#/components/schemas/reservationHistoryFutureInfoType' stayReservationInfoList: description: Collection of Detailed information on history and future reservations associated with the profile. $ref: '#/components/schemas/reservationStayHistoryFutureInfoType' lastStayInfo: description: Information on last stay of the profile. $ref: '#/components/schemas/lastStayInfoType' profileAccessType: description: Detailed information on access type associated with the profile. $ref: '#/components/schemas/profileAccessType' profileRestrictions: description: Detailed information on restrictions associated with the profile. $ref: '#/components/schemas/profileRestrictions' mailingActions: description: Contains collection of mailing action list associated with the profile $ref: '#/components/schemas/mailingActionsType' privacyInfo: description: Contains privacy related information associated with the profile $ref: '#/components/schemas/privacyInfoType' cashiering: description: Contains cashiering related details for the profile $ref: '#/components/schemas/profileCashieringType' commissionInfoList: description: Contains commission related details for the profile. type: array maxItems: 4000 items: $ref: '#/components/schemas/profileCommissionType' userDefinedFields: description: Collections of user defined fields. $ref: '#/components/schemas/userDefinedFieldsType' webUserAccounts: description: List of Web User Accounts of the profile. $ref: '#/components/schemas/webUserAccountsType' taxInfo: description: Profile information about tax. $ref: '#/components/schemas/profileTaxInfoType' salesInfo: description: Sales information of the profiles. $ref: '#/components/schemas/salesInfoType' eCertificates: description: E-Certificate assosiated with the profile. $ref: '#/components/schemas/eCertificatesType' subscriptions: description: List of profile subscriptions. $ref: '#/components/schemas/profileSubscriptionListType' localizationGuestType: description: Localization Guest Type assocaited to the profile. type: string minLength: 0 maxLength: 20 eligibleForFiscalFolio: description: Eligible for Fiscal Folio/Payload generation. type: string minLength: 0 maxLength: 20 profileType: description: Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact. $ref: '#/components/schemas/profileTypeType' statusCode: description: Status of the profile. Active/Inactive $ref: '#/components/schemas/profileStatusType' registeredProperty: description: Hotel which this profile is registered with. This attribute is not used for configuration. type: string minLength: 0 maxLength: 20 requestForHotel: description: Hotel which this profile is to be registered. This attribute is only used during creation of profile. type: string minLength: 0 maxLength: 20 protectedBy: description: What level this profile is protected. type: string minLength: 0 maxLength: 40 createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 markAsRecentlyAccessed: description: Mark this profile as recently accessed. type: boolean markForHistory: description: '"true" setting marks the profile to be kept from being purged, once the profile is marked inactive.' type: boolean hasCommission: description: Populates true if the profile has commission configured false otherwise. type: boolean inheritedNegRates: description: Flag to indicate if the negotiated rates are inherited from master profile. Flag is available only when the profile is linked to master profile and master profile has negotiated rate codes attached. type: boolean paragraphType: type: object description: An indication of a new paragraph for a sub-section of a formatted text message. properties: text: description: Formatted text content. $ref: '#/components/schemas/formattedTextTextType' image: description: An image for this paragraph. type: string url: description: A URL for this paragraph. type: string anonymizationType: type: object description: Provides information about guest's anonymization status. properties: anonymizationStatus: description: Status of anonymization such as Requested or Anonymized. $ref: '#/components/schemas/anonymizationStatusType' anonymizationDate: description: Date and Time when the guest was anonymized. type: string format: date-time hotelInterfaceTypeType: type: string enum: - Bms - Cas - Ccw - Dls - Eft - Exp - Mak - Mbs - Msc - Pbx - Pos - Svs - Tik - Vid - Vms - Www - Xml description: XML Posting Interface roomCapacityType: type: object description: Detailed information on the capacity of a room. properties: minCapacity: description: Minimum capacity of the room. type: integer maxCapacity: description: Maximum capacity of the room. type: integer cateringRentalCodesDetails: type: object description: Response object for fetching Catering Rental Code details. properties: rentalCodes: description: Collection of Catering Rental Code Details. $ref: '#/components/schemas/cateringCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' translationTextType200: type: object description: Contains Multiple translated texts and language codes. properties: defaultText: description: Default text with Character length from 0 to 200. type: string minLength: 0 maxLength: 200 translatedTexts: description: List of translated text and language codes. $ref: '#/components/schemas/translationsTextType' eventCodesType: type: array description: Details for Event Code at hotel level. maxItems: 4000 items: $ref: '#/components/schemas/eventCodeType' functionSpaceLocationsCriteria: type: object description: Request object for adding function space location configurations to resort. properties: locations: description: List of function space location(s) to be added to the configuration of resort. $ref: '#/components/schemas/functionSpaceLocationsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateEventCodesDetails: type: object description: Response object for fetching template Event Codes. properties: templateEventCodes: description: Collection of template Event Codes. $ref: '#/components/schemas/templateEventCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' functionSpaceSetupStyleType: type: object description: Type for the function space setup style ID properties: codeId: description: Setup style code id . type: number code: description: Function Space Setup Style Code. type: string minLength: 0 maxLength: 20 translatableDescription: description: Translatable description of the Function Space Setup Style. $ref: '#/components/schemas/translationTextType200' displaySequence: description: Description of the Function Space Setup Style. type: integer directory: description: Display in Directory True or False. type: boolean webBooking: description: Bookmarkable via Website True or False. type: boolean webSetup: description: Setup Time for web bookings. type: integer webSetdown: description: Setdown Time for web bookings. type: integer inactive: description: Indicates if the Setup Style is active. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' functionSpaceRoomType: type: object description: This type represents the primary room attributes. properties: roomType: description: Room type basic information of the room. $ref: '#/components/schemas/roomTypeShortInfoType' floor: description: Floor of the Room. type: string minLength: 0 maxLength: 20 floorDescription: description: Description for the Floor of the Room. type: string minLength: 0 maxLength: 20 roomFeatures: description: Room Features for the room. $ref: '#/components/schemas/roomFeaturesType' roomDescription: description: Detail Long Description Of The Room. type: string minLength: 0 maxLength: 20 description: description: Description of the room. $ref: '#/components/schemas/translationTextType2000' smokingPreference: description: This indicates room smoking preference. type: string minLength: 0 maxLength: 20 smokingPreferenceDescription: description: This indicates the description of the room smoking preference. type: string minLength: 0 maxLength: 20 building: description: Building associated with the room. type: string minLength: 0 maxLength: 20 roomAssignmentRating: description: Assignment Rating associated with the room. $ref: '#/components/schemas/ratePlanRatingType' accessible: description: Indicates whether the room is accessibility compliant. type: boolean roomId: description: Code of the room. type: string minLength: 0 maxLength: 20 meetingRoom: description: Indicates whether the room is a Meeting Room type: boolean roomCapacity: description: Minimum and Maximum room capacity information of the function space. $ref: '#/components/schemas/roomCapacityType' roomSize: description: Collection of room size information of of the function space group by unit of measurement. type: array maxItems: 4000 items: $ref: '#/components/schemas/roomSizeType' targetFunctionSpaceType: type: object description: Function Space details that may be different from the source function space. If any of Space Name, Short Name, Custom Orders and Combo Element types are not passed together with this type, it means that it is expected that these would be copied from source function space properties: spaceName: description: The Name of the Function Space. type: string minLength: 0 maxLength: 2000 shortName: description: The Short Name of the Function Space. type: string minLength: 0 maxLength: 2000 orderBy1: description: The first custom order for sorting the function space display. type: integer orderBy2: description: The second custom order for sorting the function space display. type: integer orderBy3: description: The third custom order for sorting the function space display. type: integer comboElements: description: List of combo elements for the function space. $ref: '#/components/schemas/codeListType' targetRoomNumber: description: Room number of the new function space to be created. type: string minLength: 0 maxLength: 20 functionSpaceConfigDetails: type: object description: Response object for fetching function space config info. properties: functionSpace: description: The detail information of function space for function space configuration. $ref: '#/components/schemas/functionSpaceConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' functionSpaceRateTypeType: type: string description: Indicates the function space rate is applied per person. enum: - PerRoom - PerPerson copyFunctionSpaces: type: object description: Request object for creating multiple function spaces based on an existing function space. New function space may have different name, display name on function dairy, order of display and combo elements. The rest of the details will be copied from the source function space. properties: copyFunctionSpace: description: Object that holds primary details of function space to be copied and collection of function spaces to be created from it. $ref: '#/components/schemas/copyFunctionSpaceType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' functionSpacesToBeChanged: type: object description: Request object for changing function spaces. properties: functionSpaces: description: List of detail information of function space for function space configuration. $ref: '#/components/schemas/functionSpacesConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' functionSpaceDetails: type: object description: Response object for fetching complete information of existing function space room. properties: functionSpaceRoom: description: Detailed information of a function space room. $ref: '#/components/schemas/functionSpaceType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomTypePoolType: type: object description: This type represents complete information of room type pool and Associated Room Type(s). properties: hotelId: description: Hotel Code where room pool belongs to. type: string minLength: 0 maxLength: 20 roomTypePoolCode: description: Room type pool Code. type: string minLength: 0 maxLength: 20 description: description: The description of room pool type. type: string minLength: 0 maxLength: 2000 shortDescription: description: The short description of type room pool. $ref: '#/components/schemas/translationTextType1000' sequence: description: Sequence for representing room type pool record. type: integer associatedRoomTypes: description: Pertain associated room type(s) detail information. $ref: '#/components/schemas/roomPoolRoomTypesType' managedBy: $ref: '#/components/schemas/managedByOptions' roomPoolRoomTypesType: type: array description: Collection of room type pool mapping type. maxItems: 4000 items: $ref: '#/components/schemas/roomPoolRoomTypeType' templateEventCodesType: type: array description: Details for Event Code at template level. maxItems: 4000 items: $ref: '#/components/schemas/templateEventCodeType' comboElementRoomType: type: object description: Details of each combo element room. properties: roomCode: description: Configured code of the room. type: string minLength: 0 maxLength: 20 roomDescription: description: The description of the room(eg. historical significance or physical features). $ref: '#/components/schemas/translationTextType2000' roomSize: description: Configured size of the room. type: number roomProportion: description: Percentage occupied by the room. type: number functionSpaceLocationType: type: object description: Function Space Location details. properties: hotelId: description: Hotel code that the function space location belongs to. type: string minLength: 0 maxLength: 20 code: description: Function Space Location Code. type: string minLength: 0 maxLength: 20 translatableDescription: description: Translatable description of the Function Space Location. $ref: '#/components/schemas/translationTextType2000' managedBy: $ref: '#/components/schemas/managedByOptions' functionSpaceSetupStylesCriteria: type: object description: Request object for adding function space setup styles. properties: setupStyles: description: List of function space setup style(s) to be added. $ref: '#/components/schemas/functionSpaceSetupStylesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' functionSpaceType: type: object description: This type holds collection of function space room with complete information. properties: room: type: array maxItems: 4000 items: $ref: '#/components/schemas/functionSpaceRoomType' hotelId: description: Hotel Code of the room. type: string minLength: 0 maxLength: 20 eventCodesDetails: type: object description: Response object for fetching Event Codes for a hotel. properties: eventCodes: description: Collection of hotel level Event Codes. $ref: '#/components/schemas/eventCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' functionSpacesDetails: type: object description: Response object for fetching function spaces summary info at the property level. properties: functionSpaces: description: List of summary information of function space. $ref: '#/components/schemas/functionSpacesSummaryType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cateringRentalCodesToBeChanged: type: object description: Request object which holds modified Catering Rental Codes. properties: rentalCodes: description: Collection of Catering Rental Codes to be changed. $ref: '#/components/schemas/cateringCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' ratePlanRatingType: type: string description: Possible Rate plan rating values. enum: - MostImportant - Important - SomewhatImportant - LessImportant - LeastImportant - NoValueSet functionSpacesSummaryType: type: array description: The summary information for a function space. maxItems: 4000 items: $ref: '#/components/schemas/functionSpaceSummaryType' eventCodeType: type: object description: Base structure for template and hotel Event Code. properties: code: description: Code of an Event. type: string minLength: 0 maxLength: 20 description: description: Description of an Event. type: string minLength: 0 maxLength: 2000 blackOut: description: Black Out flag of Event. type: boolean sellSequence: description: Sell sequence of Event. type: number inactive: description: Inactive flag of Event. type: boolean hotelId: description: Hotel code to which the Event Code is associated. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' functionSpaceLocationsToBeChanged: type: object description: Request object for modifying function space location(s) for resort. properties: locations: description: List of function space location(s) to be modified in the configuration of the resort. $ref: '#/components/schemas/functionSpaceLocationsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomTypeShortInfoType: type: object description: Basic information of room type. properties: pseudo: description: Indicates if room is a pseudo. This is read-only. type: boolean suite: description: Indicates if room is a suite. This is read-only. type: boolean roomClass: description: Room Class of the room. This is read-only. type: string minLength: 0 maxLength: 20 shortDescription: description: Short Description of room type. type: string minLength: 0 maxLength: 200 houseKeeping: description: Indicates if room type of the room is flagged as housekeeping. This is read-only. type: boolean smokingPreference: description: Specifies the smoking preference for room type of the room. type: string minLength: 0 maxLength: 20 building: description: Building associated with the room. type: string minLength: 0 maxLength: 20 roomAssignmentRating: description: Assignment Rating associated with the room. $ref: '#/components/schemas/ratePlanRatingType' minimumOccupancy: description: Minimum occupancy for the room type. type: integer maximumOccupancy: description: Maximum occupancy for the room type. type: integer roomFeatures: description: Room Features for the room. $ref: '#/components/schemas/roomFeaturesType' accessible: description: Indicates if room type is accessible. type: boolean roomType: description: Room type of the room. type: string minLength: 0 maxLength: 20 meetingRoom: description: Indicates whether function space can be meeting room. type: boolean functionSpaceSummaryType: type: object description: The summary information for a function space. properties: hotelId: description: Hotel Code where function space belongs to. type: string minLength: 0 maxLength: 20 roomCode: description: Room Code of the Function Space. type: string minLength: 0 maxLength: 20 roomType: description: Room Type of the Function Space. type: string minLength: 0 maxLength: 20 psuedoRoomType: description: Indicates whether the room type is psuedo. type: boolean spaceName: description: The Name of the Function Space. $ref: '#/components/schemas/translationTextType2000' shortName: description: The Short Name of the Function Space. type: string minLength: 0 maxLength: 2000 floor: description: The floor on which the Function Space is located. type: string minLength: 0 maxLength: 20 spaceType: description: The Type which the Function Space belongs to. type: string minLength: 0 maxLength: 20 location: description: The building on which the Function Space is located. type: string minLength: 0 maxLength: 20 combo: description: Indicate if the function space is a combination room. type: boolean element: description: Indicate if the function space will be shown in the Function Diary by default. type: boolean shareable: description: Indicate if the function space is shareable. type: boolean forceAlternate: description: Indicate if the function space is forced to have alternate function spaces in case the function space becomes unvailable. type: boolean webBookable: description: Indicates whether the Function Space is web bookable or not. type: boolean webViewable: description: Indicates whether the Function Space is web viewable or not. type: boolean fullUtilizationTime: description: The time in minutes that the function space would be considered at 100% utilization. type: number handicapFacilities: description: Indicates whether the function space has handicap facilities. type: boolean orderBy1: description: The first custom order for sorting the function space display. type: integer orderBy2: description: The second custom order for sorting the function space display. type: integer orderBy3: description: The third custom order for sorting the function space display. type: integer inactive: description: if true, record will be considered as inactive. type: boolean functionSpaceLocationsDetails: type: object description: Response object for fetching function space locations. properties: locations: description: Collection of function space locations. $ref: '#/components/schemas/functionSpaceLocationsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' functionSpacesConfigType: type: array description: The detail information of function space for function space configuration. maxItems: 4000 items: $ref: '#/components/schemas/functionSpaceConfigType' functionSpaceConfigType: type: object description: The summary information for a function space. properties: hotelId: description: Hotel Code where function space belongs to. type: string minLength: 0 maxLength: 20 roomCode: description: Room Code of the Function Space. type: string minLength: 0 maxLength: 20 roomType: description: Room Type of the Function Space. type: string minLength: 0 maxLength: 20 psuedoRoomType: description: Indicates whether the room type is psuedo. type: boolean spaceName: description: The Name of the Function Space. $ref: '#/components/schemas/translationTextType2000' shortName: description: The Short Name of the Function Space. type: string minLength: 0 maxLength: 2000 floor: description: The floor on which the Function Space is located. type: string minLength: 0 maxLength: 20 spaceType: description: The Type which the Function Space belongs to. type: string minLength: 0 maxLength: 20 location: description: The building on which the Function Space is located. type: string minLength: 0 maxLength: 20 combo: description: Indicate if the function space is a combination room. type: boolean element: description: Indicate if the function space will be shown in the Function Diary by default. type: boolean shareable: description: Indicate if the function space is shareable. type: boolean forceAlternate: description: Indicate if the function space is forced to have alternate function spaces in case the function space becomes unvailable. type: boolean webBookable: description: Indicates whether the Function Space is web bookable or not. type: boolean webViewable: description: Indicates whether the Function Space is web viewable or not. type: boolean excludeFromForecast: description: Flag to indicate if the event of this function space should be excluded from the forecast report. type: boolean fullUtilizationTime: description: The time in minutes that the function space would be considered at 100% utilization. type: number handicapFacilities: description: Indicates whether the function space has handicap facilities. type: boolean orderBy1: description: The first custom order for sorting the function space display. type: integer orderBy2: description: The second custom order for sorting the function space display. type: integer orderBy3: description: The third custom order for sorting the function space display. type: integer description: description: The description of the function space(eg. historical significance or physical features). $ref: '#/components/schemas/translationTextType2000' capacity: description: Minimum and Maximum room capacity information of the function space. $ref: '#/components/schemas/roomCapacityType' displayInDiary: description: Indicate if the function space will be shown in the Function Diary by default. type: boolean maxEvents: description: Maximum number of events for a shared function space. type: integer futureEventsExist: description: If the function space has future event, the combo elements are not editable. type: boolean setupStyles: description: Setup Style Type for function space. type: array maxItems: 4000 items: type: object properties: codeId: description: Setup style code id . type: number code: description: Function Space Setup Style Code. type: string minLength: 0 maxLength: 20 translatableDescription: description: Translatable description of the Function Space Setup Style. $ref: '#/components/schemas/translationTextType200' displaySequence: description: Description of the Function Space Setup Style. type: integer directory: description: Display in Directory True or False. type: boolean webBooking: description: Bookmarkable via Website True or False. type: boolean webSetup: description: Setup Time for web bookings. type: integer webSetdown: description: Setdown Time for web bookings. type: integer inactive: description: Indicates if the Setup Style is active. type: boolean minCapacity: description: Minimum Capacity for function space setup style type. type: integer maxCapacity: description: Maximum Capacity for function space setup style type. type: integer default: description: Indicate if the setup style is the default. type: boolean description: Type for the function space setup style ID comboRooms: description: Details of Combo Room Elements for the function space. $ref: '#/components/schemas/comboRoomsType' rates: description: List of available rates for the function space. type: array maxItems: 4000 items: $ref: '#/components/schemas/baseFunctionSpaceRateType' comboElements: description: List of combo elements for the function space. $ref: '#/components/schemas/codeListType' dimension: description: The dimension detail of the function space. $ref: '#/components/schemas/functionSpaceDimensionType' alternate: description: Details for alternate function spaces. $ref: '#/components/schemas/functionSpaceAlternateType' inactive: description: if true, record will be considered as inactive. type: boolean functionSpaceDimensionType: type: object description: Detailed information on the capacity of a room. properties: width: description: Width of the room. type: number length: description: Length of the room. type: number area: description: Area of the room. type: number minHeight: description: Minimum height of the room. type: number maxHeight: description: Maximum height of the room. type: number unitOfMeasureCode: description: The unit of measure in a code format. type: string minLength: 0 maxLength: 20 weight: description: The maximum load that can be supported by the floor in this function space. type: number note: description: Additional information for the function space. type: string minLength: 0 maxLength: 2000 eventCodesCriteria: type: object description: Request object for creating new Event Codes for a hotel. properties: eventCodes: description: Collection of hotel Event Codes to be created. $ref: '#/components/schemas/eventCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomFeaturesType: type: array description: A recurring element that identifies the room features. maxItems: 4000 items: $ref: '#/components/schemas/roomFeatureType' roomPoolRoomTypeType: type: object description: This extension will only use for consuming RoomType and SellSequence elements for consistency. properties: roomClass: description: Room class for the room type code. type: string minLength: 0 maxLength: 20 shortDescription: description: Short Description of room type. type: string minLength: 0 maxLength: 200 activeDate: description: Active date of the room type. type: string format: date maxLength: 8 pseudo: description: Indicates if room type is pseudo. type: boolean accessible: description: Indicates if room type is accessible. type: boolean sendToInterface: description: Indicates if room type is sent to interface. type: boolean sellSequence: description: Indicates room types sell sequence. type: number suite: description: Indicates room type is a suite. type: boolean meetingRoom: description: Indicates room type is meeting room. This Can be Meeting room flag cannot be unmarked at the property level. Can only be marked for non pseudo room types. type: boolean roomType: type: string minLength: 0 maxLength: 20 numberOfRooms: description: Number of rooms for this room type. type: integer inactive: description: Indicates the room type is inactive or not. type: boolean restricted: description: Indicates that the room pool cannot be used to allocate inventory to this room type. Inventory must be allocated directly to the room type itself. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' functionSpaceSetupStylesType: type: array description: List of the function space setup styles to be configured or fetched maxItems: 4000 items: $ref: '#/components/schemas/functionSpaceSetupStyleType' templateEventCodeType: type: object description: Base structure for template and hotel Event Code. properties: code: description: Code of an Event. type: string minLength: 0 maxLength: 20 description: description: Description of an Event. type: string minLength: 0 maxLength: 2000 blackOut: description: Black Out flag of Event. type: boolean sellSequence: description: Sell sequence of Event. type: number inactive: description: Inactive flag of Event. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' translationTextType1000: type: object description: Contains Multiple translated texts and language codes. properties: defaultText: description: Default text with Character length from 0 to 1000. type: string minLength: 0 maxLength: 1000 translatedTexts: description: List of translated text and language codes. $ref: '#/components/schemas/translationsTextType' roomTypePoolTypes: type: array description: Collection of room type pool and associated room type(s). maxItems: 4000 items: $ref: '#/components/schemas/roomTypePoolType' comboRoomsType: type: array description: This type holds a collection of combo elements for a function space. maxItems: 4000 items: $ref: '#/components/schemas/comboElementRoomType' roomTypePoolToBeChanged: type: object description: Request object for changing existing room pool. properties: roomPoolTypes: description: Collection of room pool information. $ref: '#/components/schemas/roomTypePoolTypes' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' functionSpaceLocationsType: type: array description: List of the function space locations to be configured or fetched maxItems: 4000 items: $ref: '#/components/schemas/functionSpaceLocationType' copyFunctionSpaceType: type: object description: Primary details of function space to be copied and collection of function spaces to be created from it. properties: targetFunctionSpace: description: Function Space details that may differ from the source function space. type: array maxItems: 4000 items: $ref: '#/components/schemas/targetFunctionSpaceType' sourceHotelCode: description: Hotel code of source function space that will serve as the basis for the target function spaces. type: string sourceRoomNumber: description: Room number of source function space that will serve as the basis for the target function spaces. type: string baseFunctionSpaceRateType: type: object description: Base type provides information about Catering Code which will be used for removal operation properties: codeId: description: Code ID is used to identify a Catering Code by ID. type: number code: description: Code is used to identify a Catering Code. type: string minLength: 0 maxLength: 20 translatableDescription: description: Description of the Catering Code. $ref: '#/components/schemas/translationTextType200' displaySequence: description: Catering Codes display sequence Number type: number rentAmount: description: Rent amount. $ref: '#/components/schemas/currencyAmountType' revenueType: description: Catering revenue type used for function space rent amount. type: string minLength: 0 maxLength: 20 rateType: description: Indicates the type of rate. $ref: '#/components/schemas/functionSpaceRateTypeType' default: description: Indicates that this rate is the default for the function space. type: boolean inactive: description: Indicates that this rate is inactive. type: boolean hourly: description: Indicates that this rate is computed per hour. type: boolean minimunRevenue: description: Indicates that minimum revenue should be enforced for this rate code. type: boolean cateringCodeType: type: object description: Base type provides information about Catering Code which will be used for removal operation properties: codeId: description: Code ID is used to identify a Catering Code by ID. type: number code: description: Code is used to identify a Catering Code. type: string minLength: 0 maxLength: 20 translatableDescription: description: Description of the Catering Code. $ref: '#/components/schemas/translationTextType200' displaySequence: description: Catering Codes display sequence Number type: number webBookable: description: Indicator used for only WEB Code Type in Item Rate type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' functionSpaceSetupStylesDetails: type: object description: Response object for fetching function space setup styles. properties: setupStyles: description: Collection of function space setup styles. $ref: '#/components/schemas/functionSpaceSetupStylesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' functionSpaceAlternateType: type: object description: Details for alternate function spaces. properties: forceAlternate: description: Flag to indicate if the function space must have an alternate space when used. type: boolean excludedCateringEventTypes: description: A list of catering event types that are not forced or required to have an alternate function space when this function space is used. $ref: '#/components/schemas/codeListType' roomFeatureType: type: object description: Room Feature Information. properties: code: description: A code representing a room feature. type: string minLength: 0 maxLength: 20 description: description: A code representing a room feature. type: string minLength: 0 maxLength: 2000 orderSequence: description: Display Order sequence. type: number quantity: description: Indicates quantity. type: integer functionSpacesCriteria: type: object description: Request object for creating function spaces. properties: functionSpaces: description: List of detail information of function space for function space configuration. $ref: '#/components/schemas/functionSpacesConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyFunctionSpaceLocations: type: object properties: locations: type: array description: List of function space location(s) to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateEventCodesToBeChanged: type: object description: Request object for modifying template Event Codes. properties: templateEventCodes: description: Collection of template Event Codes to be changed. $ref: '#/components/schemas/templateEventCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' functionSpaceSetupStylesToBeChanged: type: object description: Request object for modifying function space setup style(s) properties: setupStyles: description: List of function space setup style(s) to be modified. $ref: '#/components/schemas/functionSpaceSetupStylesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cateringCodesType: type: array description: Catering Code details. maxItems: 4000 items: $ref: '#/components/schemas/cateringCodeType' roomTypePoolDetails: type: object description: Response object for fetch room pool information. properties: roomTypePools: description: Collection of room pool information. $ref: '#/components/schemas/roomTypePoolTypes' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomTypePoolCriteria: type: object description: Request object for creating new room pool. properties: roomPoolTypes: description: Collection of room pool information. $ref: '#/components/schemas/roomTypePoolTypes' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cateringRentalCodesCriteria: type: object description: Request object which holds new Catering Rental Code Details. properties: rentalCodes: description: Collection of Catering Rental Codes to be created. $ref: '#/components/schemas/cateringCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomSizeType: type: object description: Detailed information on the capacity of a room. properties: width: description: Width of the room. type: number length: description: Length of the room. type: number area: description: Area of the room. type: number minHeight: description: Minimum height of the room. type: number maxHeight: description: Maximum height of the room. type: number unitOfMeasureCode: description: The unit of measure in a code format. type: string minLength: 0 maxLength: 20 templateEventCodesCriteria: type: object description: Request object for creating new template Event Codes. properties: templateEventCodes: description: Collection of template Event Codes to be created. $ref: '#/components/schemas/templateEventCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' eventCodesToBeChanged: type: object description: Request object for modifying Event Codes for a hotel. properties: eventCodes: description: Collection of hotel Event Codes to be changed. $ref: '#/components/schemas/eventCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' trackItTypesDetails: type: object description: Response object for fetching Track it Types. properties: trackItTypes: description: Collection of Track it Types. $ref: '#/components/schemas/trackItTypesConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' trackItGroupType: type: object properties: valet: description: Indicates if the Track It belongs to the Valet Group. type: boolean parcel: description: Indicates if the Track It belongs to the Parcel Group. type: boolean baggage: description: Indicates if the Track It belongs to the Baggage Group. type: boolean lost: description: Indicates if the Track It belongs to the Lost Group. type: boolean trackItLocationsToBeChanged: type: object description: Request object for changing existing Track it Locations. properties: trackItLocations: description: Track it Locations to be changed. $ref: '#/components/schemas/trackItLocationsConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' trackItActionConfigType: type: object properties: code: description: Code of the Track It Type. type: string minLength: 0 maxLength: 20 description: description: Description of the Track It Code. type: string minLength: 0 maxLength: 200 displaySequence: description: Display Sequence. type: number hotelId: description: Property to which the Track It Code is configured. type: string minLength: 0 maxLength: 20 trackItGroup: description: Track it Group details for the Track it Code $ref: '#/components/schemas/trackItGroupType' inactive: description: Indicates if the Track it Code is inactive. type: boolean status: description: Status of the Track it Action. $ref: '#/components/schemas/trackItActionStatusType' managedBy: $ref: '#/components/schemas/managedByOptions' description: Track It Action Information Type. trackItLocationConfigType: type: object properties: code: description: Code of the Track It Type. type: string minLength: 0 maxLength: 20 description: description: Description of the Track It Code. type: string minLength: 0 maxLength: 200 displaySequence: description: Display Sequence. type: number hotelId: description: Property to which the Track It Code is configured. type: string minLength: 0 maxLength: 20 trackItGroup: description: Track it Group details for the Track it Code $ref: '#/components/schemas/trackItGroupType' inactive: description: Indicates if the Track it Code is inactive. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' description: Track It Location Information Type. trackItTypeConfigType: type: object properties: code: description: Code of the Track It Type. type: string minLength: 0 maxLength: 20 description: description: Description of the Track It Code. type: string minLength: 0 maxLength: 200 displaySequence: description: Display Sequence. type: number hotelId: description: Property to which the Track It Code is configured. type: string minLength: 0 maxLength: 20 trackItGroup: description: Track it Group details for the Track it Code $ref: '#/components/schemas/trackItGroupType' inactive: description: Indicates if the Track it Code is inactive. type: boolean website: description: Website associated with Track it type. type: string minLength: 0 maxLength: 2000 includePromptToSendMessage: description: Indicator to send a message to the guest when a new trackit item is created. type: boolean messageCode: description: Code of the Message to be sent. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' description: Track It Type Information Type. trackItTypesConfigType: type: array description: Track It Type Collection element. maxItems: 4000 items: $ref: '#/components/schemas/trackItTypeConfigType' copyTrackItTypes: type: object properties: trackItTypes: type: array description: List of Track it Types to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' trackItActionStatusType: type: string description: Defined Values for Status of the Track it Action. enum: - Open - Closed trackItTypesToBeChanged: type: object description: Request object for changing existing Track it Types. properties: trackItTypes: description: Track it Types to be changed. $ref: '#/components/schemas/trackItTypesConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' trackItActionsConfigType: type: array description: Track It Action Collection element. maxItems: 4000 items: $ref: '#/components/schemas/trackItActionConfigType' trackItActionsCriteria: type: object description: Request object for creating new Track it Actions. properties: trackItActions: description: Track it Actions to be created. $ref: '#/components/schemas/trackItActionsConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' trackItLocationsConfigType: type: array description: Track It Locations Collection element. maxItems: 4000 items: $ref: '#/components/schemas/trackItLocationConfigType' trackItActionsToBeChanged: type: object description: Request object for changing existing Track it Actions. properties: trackItActions: description: Track it Actions to be changed. $ref: '#/components/schemas/trackItActionsConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' trackItLocationsDetails: type: object description: Response object for fetching Track it Locations. properties: trackItLocations: description: Collection of Track it Locations. $ref: '#/components/schemas/trackItLocationsConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' trackItActionsDetails: type: object description: Response object for fetching Track it Actions. properties: trackItActions: description: Collection of Track it Actions. $ref: '#/components/schemas/trackItActionsConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyTrackItLocations: type: object properties: trackItLocations: type: array description: List of Track it Locations to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' trackItTypesCriteria: type: object description: Request object for creating new Track it Types. properties: trackItTypes: description: Track it Types to be created. $ref: '#/components/schemas/trackItTypesConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyTrackItActions: type: object properties: trackItActions: type: array description: List of Track it Actions to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' trackItLocationsCriteria: type: object description: Request object for creating new Track it Locations. properties: trackItLocations: description: Track it Locations to be created. $ref: '#/components/schemas/trackItLocationsConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateHousekeepingRoomSchedulesCriteria: type: object description: Request Criteria to configure housekeeping task schedules at template level. properties: templateHousekeepingRoomSchedules: type: array description: This type holds a collection of housekeeping task schedules configured at template level. maxItems: 4000 items: $ref: '#/components/schemas/configTemplateHousekeepingRoomScheduleType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' outOfOrderServiceReasonsToBeChanged: type: object description: Request object for modifying out of order/service reasons for hotels. properties: outOfOrderServiceReasons: description: Collection of out of order/service reasons to be modified. $ref: '#/components/schemas/outOfOrderServiceReasonsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingCodeConfigType: type: object description: Common code type for code, description properties: code: description: Code for the code type. type: string minLength: 0 maxLength: 20 description: description: Description for the code type. type: string minLength: 0 maxLength: 2000 sequence: description: Display sequence for the housekeeping task. type: number hotelId: description: Hotel Code for a housekeeping task. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' housekeepingSectionGroupsCopyType: type: array description: List of the housekeeping section groups to be copied maxItems: 4000 items: $ref: '#/components/schemas/housekeepingSectionGroupCopyType' outOfOrderServiceReasonsDetails: type: object description: Response object for fetching Out of Order/Service Reason(s). properties: outOfOrderServiceReasons: description: Collection of out of order/service reasons. $ref: '#/components/schemas/outOfOrderServiceReasonsType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' frequencyTypeType: type: string description: Simple type for storing frequency type. enum: - Everyday - EveryXDays - CustomSchedule - DepartureDayOnly - ArrivalDayOnly - NotRequired - SpecificDays roomCriteria: type: object description: Request object for creating a new room. properties: room: description: Room to be created. type: object properties: roomDetails: description: Room details to be created. $ref: '#/components/schemas/configRoomType' hotelId: description: Hotel code of the room to be created. $ref: '#/components/schemas/codeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingSectionsToBeChanged: type: object description: Modify housekeeping section codes in resort configurations. properties: housekeepingSections: description: The housekeeping section code to be modified in the configuration of the resort. $ref: '#/components/schemas/housekeepingSectionsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateRoomMaintenanceReasonsToBeChanged: type: object description: Request object for modifying template room maintenance reasons. properties: templateRoomMaintenanceReasons: description: Collection of template room maintenance reasons to be changed. $ref: '#/components/schemas/templateRoomMaintenanceReasonsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyNewRoomsType: type: array description: Room details that may differ from the base existing room. maxItems: 4000 items: $ref: '#/components/schemas/copyNewRoomType' bedTypeInfoType: type: object description: Information representing Bed type associated with a room type. properties: code: description: Bed Type Code. type: string minLength: 0 maxLength: 20 description: description: Description of Bed Type. $ref: '#/components/schemas/translationTextType2000' resortRoomConditionsDetails: type: object description: Response object for information regarding room condition configuration in a resort. properties: roomConditions: description: Contains the results of a successful operation. $ref: '#/components/schemas/roomCondtionsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' configRoomsType: type: object description: This type holds collection of rooms with complete information. properties: room: type: array maxItems: 4000 items: $ref: '#/components/schemas/configRoomType' hotelId: description: Hotel Code of the rooms. type: string minLength: 0 maxLength: 20 templateRoomFeaturesCriteria: type: object description: Request object for creating template room features. properties: templateRoomFeatures: description: Collection containing details of template room features. $ref: '#/components/schemas/templateRoomFeaturesConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' outOfOrderServiceReasonType: type: object description: Base details of the Out of order/service reason. properties: description: description: Description for the out of order/service reason. type: string minLength: 0 maxLength: 80 sequence: description: Sequence number for displaying the out of order/service reason. type: integer reasonCode: description: Out of order/service reason code identifying the reason. type: string minLength: 0 maxLength: 20 inactive: description: Indicator that tells whether the out of order/service reason in the hotel is active or not. type: boolean includeInStatisticsYn: description: Indicator for RNA to use to decide whether to include this room status in statistics, with no functional impact. type: boolean deductYn: description: Indicator for room status display. Room status configured with 'true' will be displayed as OOO, 'false' will be displayed as OOS. type: boolean returnTimeRequired: description: Indicator for Return Time Required display. If configured to true, then a time will be mandatory to determine when this unit (room) will be back to the inventory of the available rooms. type: boolean hotelId: description: Hotel code the out of order/service reason belongs to. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' templateOutOfOrderServiceReasonType: type: object description: Base details of the out of order/service reason properties: description: description: Description for the out of order/service reason. type: string minLength: 0 maxLength: 80 sequence: description: Sequence number for displaying the out of order/service reason. type: integer reasonCode: description: Out of order/service reason code identifying the reason. type: string minLength: 0 maxLength: 20 inactive: description: Indicator that tells whether the out of order/service reason in the hotel is active or not. type: boolean includeInStatisticsYn: description: Indicator for RNA to use to decide whether to include this room status in statistics, with no functional impact. type: boolean deductYn: description: Indicator for room status display. Room status configured with 'true' will be displayed as OOO, 'false' will be displayed as OOS. type: boolean returnTimeRequired: description: Indicator for Return Time Required display. If configured to true, then a time will be mandatory to determine when this unit (room) will be back to the inventory of the available rooms. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' roomHierarchyType: type: object description: Room Hierarchy id type for create, change and delete properties: roomHierarchyType: description: Room Hierarchy Type will take either Type or Class $ref: '#/components/schemas/roomHierarchyTypeType' hotelId: description: Resort code in which the hierarchy should exist type: string minLength: 0 maxLength: 20 fromCode: description: From code to process type: string minLength: 0 maxLength: 20 toCodes: description: To codes to be processed $ref: '#/components/schemas/codeListType' displaySequence: description: Display Sequence type: integer managedBy: $ref: '#/components/schemas/managedByOptions' housekeepingCreditsDefinitionType: type: string description: Type for the different kinds of Credits which will be used in Rooms Management. enum: - Departure - Pickup - Turndown - StayOver - FacilityTask - Travelling - Total housekeepingSectionGroupsDetails: type: object description: Response object for fetching housekeeping section Groups. properties: housekeepingSectionGroups: description: Collection of housekeeping section Groups. $ref: '#/components/schemas/housekeepingSectionGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingSectionGroupCopyInfoType: type: object description: Detailed information of Housekeeping Section Group to copy. properties: targetHotelCode: description: Source property of the Housekeeping section group. type: string minLength: 0 maxLength: 20 sourceSectiongroup: description: Source Housekeeping Section Group Code. type: string minLength: 0 maxLength: 20 copyAs: description: The code and description to be used for the section group code being copied under the target hotel code. $ref: '#/components/schemas/codeDescriptionType' buildingsToBeChanged: type: object description: Request object to change Building details of the Hotel. properties: buildings: description: Collection containing information of Building details to be changed. $ref: '#/components/schemas/buildingsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' bookingChannelMappingType: type: object properties: bookingChannelCode: type: string minLength: 0 maxLength: 20 code: type: string minLength: 0 maxLength: 20 name: type: string minLength: 0 maxLength: 40 description: type: string minLength: 0 maxLength: 2000 housekeepingSectionsCriteria: type: object description: Add housekeeping section codes configurations for resort. properties: housekeepingSections: description: Add the housekeeping section code to the configuration of resort. $ref: '#/components/schemas/housekeepingSectionsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomsSummaryDetails: type: object description: Response object for fetching summary information of existing rooms. properties: rooms: description: Collection of rooms. type: object properties: roomsSummary: description: Collection of rooms summary. type: array items: $ref: '#/components/schemas/configRoomsSummaryType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomHierarchyTypeType: type: string description: Provides the type of room hierarchy enum: - Type - Class templateHousekeepingRoomSchedulesToBeChanged: type: object description: Request object for changing housekeeping schedule tasks and it's associated codes configured at template level properties: templateHousekeepingRoomSchedule: description: This type holds a collection of housekeeping task schedules configured at template level. $ref: '#/components/schemas/configTemplateHousekeepingRoomScheduleType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingCodesDetails: type: object description: Response object for fetching housekeeping codes. properties: codes: description: Collection of housekeeping tasks. $ref: '#/components/schemas/housekeepingCodesConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyBuildingGroups: type: object description: Request object to copy Building Group details to hotel(s). properties: copyInstructions: description: List of the Building Group details to be copied to hotel(s). $ref: '#/components/schemas/copyConfigurationCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelRoomMaintenanceReasonsToBeChanged: type: object description: Request object for modifying room maintenance reasons for a hotel. properties: hotelRoomMaintenanceReasons: description: Collection of hotel room maintenance reason to be changed. $ref: '#/components/schemas/hotelRoomMaintenanceReasonsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateHousekeepingTasksDetails: type: object description: Response object for fetching housekeeping tasks. properties: tasks: type: array description: List of the housekeeping tasks to be configured maxItems: 4000 items: $ref: '#/components/schemas/templateHousekeepingTaskConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomTypeTemplatesCriteria: type: object description: Request object for creating a new Room Type Template. properties: roomTypeTemplate: description: Room Type template details to be created. type: object properties: roomTypeTemplateDetails: description: Room Type template details to be created. $ref: '#/components/schemas/roomTypeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateHousekeepingTaskConfigType: type: object description: Common code type for template housekeeping task type. properties: code: description: Code for template housekeeping task. type: string minLength: 0 maxLength: 20 description: description: Description for template housekeeping task. type: string minLength: 0 maxLength: 2000 instructions: description: Instructions of template housekeeping task for the housekeeping to follow. type: string minLength: 0 maxLength: 2000 sequence: description: Display sequence for template housekeeping task. type: number minimum: 1 maximum: 99999 color: description: Color configuration type for template housekeeping task. $ref: '#/components/schemas/colorType' linenChange: description: Signifies whether template housekeeping task requires linen change. type: boolean guestRequested: description: Signifies whether template housekeeping task is a guest requested task. type: boolean defaultDepartureTask: description: Signifies that template task is a default task for the checked out room. type: boolean protected: description: Flag that determines whether this record is protected from removing or not type: boolean appliedCreditsPercentage: description: Percentage of Credits that will be used for this task. Used when the Housekeeping Credits functionality is set to use ROOM_TASK_RULE. The default value is 100. type: number minimum: 0 maximum: 100 inactive: description: Indicates if the template task is inactive. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' roomTypeTemplatesToBeChanged: type: object description: Request object for Modifying existing Room Type Templates. properties: roomTypeTemplate: description: Room Type template details to be changed. type: object properties: roomTypeTemplateDetails: description: Room Type template details to be changed. $ref: '#/components/schemas/roomTypeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' generateRoomTypeDescriptionResponse: type: object description: Response object containing the generated text based on prompt input for a given use case. properties: description: description: Generated Room Type Description. type: string responseId: description: Response Id generated by AI author service. type: string links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingSectionGroupType: type: object description: Detailed information of Housekeeping Section Group. properties: hotelId: description: Property of the Housekeeping section group. type: string minLength: 0 maxLength: 20 code: description: Housekeeping Section Group Code. type: string minLength: 0 maxLength: 20 description: description: Description of the Housekeeping Section Group. type: string minLength: 0 maxLength: 80 targetCredits: description: Target Credit for each task Sheet when auto task assignment is broken out per Section Group. type: integer sequence: description: Display sequence when task assignment is automatically broken out by Section Group. type: integer rooms: description: Rooms count for this section group. This is auto populated while creating/fetching record. type: integer roomCredits: description: Number of housekeeping credits. This is auto populated while creating/fetching record. type: integer managedBy: $ref: '#/components/schemas/managedByOptions' housekeepingTasksToBeChanged: type: object description: Modify housekeeping tasks in resort configurations. properties: tasks: description: List of the housekeeping task(s) to be modified in the configuration of the resort. $ref: '#/components/schemas/housekeepingTasksConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomTypeSummaryType: type: object description: This type represents the summary of room type attributes. properties: roomClass: description: Room class for the room type code. type: string minLength: 0 maxLength: 20 shortDescription: description: Short Description of room type. type: string minLength: 0 maxLength: 200 activeDate: description: Active date of the room type. type: string format: date maxLength: 8 pseudo: description: Indicates if room type is pseudo. type: boolean accessible: description: Indicates if room type is accessible. type: boolean sendToInterface: description: Indicates if room type is sent to interface. type: boolean sellSequence: description: Indicates room types sell sequence. type: number suite: description: Indicates room type is a suite. type: boolean meetingRoom: description: Indicates room type is meeting room. This Can be Meeting room flag cannot be unmarked at the property level. Can only be marked for non pseudo room types. type: boolean roomType: type: string minLength: 0 maxLength: 20 numberOfRooms: description: Number of rooms for this room type. type: integer inactive: description: Indicates the room type is inactive or not. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' roomConditionTemplatesDetails: type: object description: Response object for information regarding room condition template of a property. properties: roomConditionTemplates: description: Contains the results of a successful operation. $ref: '#/components/schemas/roomCondtionTemplatesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomFeaturesToBeChanged: type: object description: Request object for changing room features of hotel. properties: roomFeatures: description: Collection containing details of hotel room features. $ref: '#/components/schemas/roomFeaturesConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomTypeYieldableType: type: string description: Simple type for Yieldable or Non Yieldable enum: - Yieldable - NonYieldable configHotelPreferencesType: type: array description: This type holds a collection of preferences at the property level. maxItems: 4000 items: $ref: '#/components/schemas/configHotelPreferenceType' copyHousekeepingSections: type: object properties: housekeepingSections: type: array description: List of the housekeeping section code(s) to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingRoomSchedulesToBeChanged: type: object description: Request object for changing housekeeping tasks and housekeeping codes associated to a room type. properties: housekeepingRoomSchedules: description: Collection containing details of housekeeping tasks and housekeeping codes associated to a room type which have to be changed. $ref: '#/components/schemas/configHousekeepingRoomSchedulesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomHierarchiesCriteria: type: object description: Request to create room hierarchies properties: roomHierarchies: description: Room hierarchies to be created $ref: '#/components/schemas/createRoomHierarchiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateRoomMaintenanceReasonsDetails: type: object description: Response object for fetching template room maintenance reasons. properties: templateRoomMaintenanceReasons: description: Collection of template level room maintenance reasons. $ref: '#/components/schemas/templateRoomMaintenanceReasonsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomConditionTemplateToBeChanged: type: object description: Request object for Modifying Room Condition Template. properties: roomConditionTemplate: description: Room Condition Template details to be changed. $ref: '#/components/schemas/roomCondtionTemplateType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomClassesType: type: array description: Collection of hotel level room classes with attached room types. maxItems: 4000 items: $ref: '#/components/schemas/roomClassType' housekeepingAttendantsCriteria: type: object description: Add housekeeping attendant(S). properties: attendants: description: List of the housekeeping attendant(s) to be added to the configuration of resort. $ref: '#/components/schemas/housekeepingAttendantsConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingSectionGroupsToBeChanged: type: object description: Request object for modifying housekeeping section groups in resort. properties: housekeepingSectionGroups: description: List of house keeping section groups to change. $ref: '#/components/schemas/housekeepingSectionGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' vacantRoomStatusType: type: object description: Information related to vacant room housekeeping status. properties: roomTypes: description: Room types of the room. type: array maxItems: 400 items: $ref: '#/components/schemas/codeDescriptionType' beginDate: description: The date from which the vacant room status will be updated during end of day. type: string format: date endDate: description: The last date till which the vacant room status will be updated during end of day. type: string format: date houseKeepingRoomStatus: description: The housekeeping room status to be updated on vacant rooms for the given room types. $ref: '#/components/schemas/housekeepingRoomStatusType_2' numberOfDays: description: Number of days to change room status of those rooms that are vacant from X number of days. type: number vacantRoomStatusId: type: number description: The unique ID of the vacant room configuration to which this record applies. roomTypeMasterInfoType: type: object description: The RoomType element is used to contain all the room type information for a single room type. properties: roomType: description: Room type information type: array maxItems: 4000 items: $ref: '#/components/schemas/roomTypeInfoType' hotelId: type: string minLength: 0 maxLength: 20 floorsToBeChanged: type: object description: Request object for changing floors at the hotel level. properties: hotelFloors: description: Collection containing details of floors specified at the hotel level which have to be changed. $ref: '#/components/schemas/hotelFloorsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingRoomStatusType_2: type: string description: Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected. enum: - Clean - Dirty - Pickup - Inspected - OutOfOrder - OutOfService copyHousekeepingSectionGroups: type: object description: Request object for copying housekeeping section groups in resort. properties: housekeepingSectionGroups: description: List of house keeping section groups to copy. $ref: '#/components/schemas/housekeepingSectionGroupsCopyType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' daysOfWeekAttrType: type: object properties: sunday: type: boolean monday: type: boolean tuesday: type: boolean wednesday: type: boolean thursday: type: boolean friday: type: boolean saturday: type: boolean housekeepingAttendantsToBeChanged: type: object description: Modify housekeeping attendants properties: attendants: description: List of the housekeeping attendant(s) to be modified. $ref: '#/components/schemas/housekeepingAttendantsConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' buildingGroupType: type: object description: Building or Building Group details associated with the Hotel. properties: hotelId: description: Hotel Identifier of the Building or Building Group. type: string minLength: 0 maxLength: 20 code: description: Building Group or Building Code Identifier of the Hotel. type: string minLength: 0 maxLength: 20 description: description: The description of the Building or Building Group. type: string minLength: 0 maxLength: 2000 targetCredits: description: Target Credit for each task sheet created for this building when auto task assignment is broken out by building. type: integer rooms: description: Rooms associated with the building. $ref: '#/components/schemas/codeListType' credits: description: Total Credits for all the rooms that belong to this building group. type: integer sequence: description: Building Sequence when task assignment is automatically generated by building. type: integer managedBy: $ref: '#/components/schemas/managedByOptions' roomTypeTemplateType: type: array description: This type holds collection of room type. maxItems: 4000 items: $ref: '#/components/schemas/roomTypeType' templateHousekeepingTaskToBeChanged: type: object description: Modify housekeeping task. properties: task: description: Detail of the housekeeping task to be modified. $ref: '#/components/schemas/templateHousekeepingTaskConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' buildingGroupsDetails: type: object description: Response object after fetching Building Groups of the Hotel. properties: buildingGroups: description: Collection of Building Group detail of the Hotel. $ref: '#/components/schemas/buildingGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomGroupsToBeChanged: type: object description: Request object for changing Room Groups. properties: roomGroups: description: Collection of Room Groups to change. $ref: '#/components/schemas/roomGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingTasksCriteria: type: object description: Add housekeeping tasks configurations for resort. properties: tasks: description: List of the housekeeping task(s) to be added to the configuration of resort. $ref: '#/components/schemas/housekeepingTasksConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' vacantRoomStatusDetails: type: object description: The request element used to create a vacant room statuses. properties: roomTypes: type: array description: Room Type of the room. maxItems: 400 items: type: string beginDate: description: The starting value of the date range. By default this would be the current business date. type: string format: date endDate: description: The ending value of the date range. The time span between the endDate and the beginDate must not exceed two years. type: string format: date numberOfDays: description: Number of days to change room status of those rooms that are vacant from X number of days. type: number minLength: 1 maxLength: 365 houseKeepingRoomStatus: description: The housekeeping room status to be updated on vacant rooms for the given room types. $ref: '#/components/schemas/housekeepingRoomStatusType_2' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateFloorsType: type: array description: This type holds a collection of floors at the template level. maxItems: 4000 items: $ref: '#/components/schemas/templateFloorType' copyRoomHierarchies: type: object description: Request to copy room hierarchies properties: copyRoomHierarchies: description: Takes either Type or Class type: object properties: roomHierarchyType: description: Takes either Type or Class $ref: '#/components/schemas/roomHierarchyTypeType' roomHierarchies: description: List of room hierarchies to be copied. type: array items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateRoomMaintenanceReasonsCriteria: type: object description: Request object for creating new template room maintenance reasons. properties: templateRoomMaintenanceReasons: description: Collection of template room maintenance reasons to be created. $ref: '#/components/schemas/templateRoomMaintenanceReasonsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' vacantRoomStatusesList: type: object description: Response object for fetching vacant room statuses. properties: vacantRoomStatus: type: array description: Holds collection of vacant room housekeeping statuses. maxItems: 4000 items: $ref: '#/components/schemas/vacantRoomStatusType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomTypesType: type: object description: This type holds collection of room type. properties: roomType: type: array maxItems: 4000 items: $ref: '#/components/schemas/roomTypeType' hotelId: description: Hotel Code. type: string minLength: 0 maxLength: 20 housekeepingRoomSchedulesCriteria: type: object description: Request object for associating housekeeping tasks and housekeeping codes to a room type. properties: housekeepingRoomSchedules: description: Collection containing details of housekeeping tasks and housekeeping codes to be associated to a room type. $ref: '#/components/schemas/configHousekeepingRoomSchedulesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomClassesDetails: type: object description: Response object for fetching existing hotel level room classes. properties: roomClasses: description: Collection of hotel level room classes and their information. $ref: '#/components/schemas/roomClassesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingAttendantType: type: object description: Housekeeping Attendant Information. properties: hotelId: description: Resort Code type: string minLength: 0 maxLength: 20 attendantId: description: An attendant ID. type: string minLength: 0 maxLength: 20 name: description: An attendant ID. type: string minLength: 0 maxLength: 80 phoneNo: description: An attendant's phone No. type: string minLength: 0 maxLength: 200 section: description: Section where the attendant is assigned. type: string minLength: 0 maxLength: 20 floor: description: Floor where the attendant is assigned. type: string minLength: 0 maxLength: 20 job: description: Job which the attendant is assigned. type: string minLength: 0 maxLength: 20 workingDays: description: Attendant's working days $ref: '#/components/schemas/daysOfWeekAttrType' appUser: description: Application User ID assigned for the attendant. type: string minLength: 0 maxLength: 250 inactive: description: Indicates whether the attendant is active or not. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' buildingFloorMappingIDType: type: object description: Building to Floor mapping ID details. properties: hotelId: description: Hotel Identifier of the Building and Floor. type: string minLength: 0 maxLength: 20 floorCode: description: Floor Code Identifier of the Hotel. type: string minLength: 0 maxLength: 20 buildingCode: description: Building Code Identifier of the Hotel. type: string minLength: 0 maxLength: 20 housekeepingCodesCriteria: type: object description: Add housekeeping codes configurations for property. properties: codes: description: List of the housekeeping code(s) to be added to the configuration of resort. $ref: '#/components/schemas/housekeepingCodesConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' validateRoomClassInUse: type: object description: Request object to validate if room type's room class is currently in use. properties: hotelId: description: Hotel code where room type belongs to. $ref: '#/components/schemas/codeType' roomType: description: Room Type where room class to be checked belongs to. $ref: '#/components/schemas/codeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomGroupsCriteria: type: object description: Request object for creating Room Groups. properties: roomGroups: description: Collection of Room Groups to create. $ref: '#/components/schemas/roomGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomCondtionTemplatesType: type: array description: Collection of Room Condition Template Type maxItems: 4000 items: $ref: '#/components/schemas/roomCondtionTemplateType' configTemplateHousekeepingRoomScheduleType: type: object description: Type contains configuration details of the task schedules configured at template level. properties: code: description: Code of the template housekeeping task. type: string minLength: 0 maxLength: 20 description: description: Description of template housekeeping task. type: string minLength: 0 maxLength: 80 priority: description: Signifies the priority of the template task. type: integer credits: description: Housekeeping credits associated with this template housekeeping task. type: integer frequency: description: Signifies frequency(i.e. every 2 days) with which template housekeeping task is to be performed. $ref: '#/components/schemas/frequencyTypeType' frequencyDays: description: Specify how often in days following the guest's arrival date, the template housekeeping task is to be completed. type: integer specialRequests: description: Specify a Special Request code to a template housekeeping task code. $ref: '#/components/schemas/codeListType' vIPStatuses: description: Specify a particular VIP code associated to a template housekeeping task code. $ref: '#/components/schemas/codeListType' sequence: description: Used to store the template housekeeping task sequence. type: integer daysOfWeek: description: This option, if applied, works in conjunction with the Every XX Day(s) option to allow you to control the days of the week on which this template housekeeping task can take place. $ref: '#/components/schemas/timeSpanDaysOfWeekType' rateCodes: description: Specify one or more Rate Codes associated to a specific template housekeeping task code. $ref: '#/components/schemas/codeListType' marketCodes: description: Specify one or more Market Codes associated to a specific template housekeeping task code. $ref: '#/components/schemas/codeListType' cycleStartDay: description: Signifies offset(in days) i.e. start on 3rd day from arrival. type: integer customizePromptText: description: Indicates information about task message. type: string minLength: 0 maxLength: 400 taskSupplies: type: array description: This type holds a collection of template housekeeping task supply codes. maxItems: 4000 items: $ref: '#/components/schemas/configTemplateHousekeepingRoomScheduleTaskSupplyType' roomType: description: Specifies room type for which this task is being scheduled. $ref: '#/components/schemas/codeDescriptionType' guestRequested: description: Indicate this task is only available when requested by the Guest. type: boolean defaultDepartureTask: description: Signifies that template task is a default task for the checked out room. type: boolean moveup: description: Automatically moves the template task up one day if it falls on the day before the guest's departure. It will only be available when the schedule is set to every 3 days or more. type: boolean membershipType: description: Specify a Membership Type associated to a specific template housekeeping task code. type: string minLength: 0 maxLength: 20 membershipLevels: description: Specify one or more Membership Levels associated to a specific template housekeeping task code. $ref: '#/components/schemas/codeListType' managedBy: $ref: '#/components/schemas/managedByOptions' housekeepingCreditRuleType: type: object description: The information of housekeeping credit rule for configuration. properties: hotelId: description: Hotel Code where housekeeping credit rule belongs to. type: string minLength: 0 maxLength: 20 ruleCode: description: Rule Code of housekeeping credit rule. type: string minLength: 0 maxLength: 20 ruleType: description: Rule Type of housekeeping credit rule. $ref: '#/components/schemas/housekeepingCreditRuleTypeType' description: description: Description of housekeeping credit rule. type: string minLength: 0 maxLength: 2000 facilityTaskRule: description: When RuleType is set to FacilityTask, specifies task code and minimum task count. type: object properties: taskCode: description: When RuleType is set to FacilityTask, specifies which task code makes this credit rule applicable. For example, the credit value will be added to the task assignment sheet when this specific task code is assigned. type: string minLength: 0 maxLength: 20 minimumTaskCount: description: When RuleType is set to FacilityTask, specifies the minimum number of the facility task that must be assigned to a sheet before the rule is applicable to that sheet. type: integer special: description: When RuleType is set to Special, specifies which special makes this credit rule applicable. For example, the credit value will be added to the task assignment sheet when the assigned room has this specific special applied to the reservation. type: string minLength: 0 maxLength: 20 travelType: description: When RuleType is set to Travelling, specifies multiples of what unit makes this credit rule applicable. Possible values are Buildings, Section Groups, Sections, or Floors. For example, the credit value will be added to the task assignment sheet when there are rooms from multiple buildings, section groups, sections, or floors assigned. $ref: '#/components/schemas/housekeepingCreditRuleTravelTypeType' creditValue: description: The additional credits which are applied to the task assignment sheet when the rule criteria has been met. type: number buildings: description: List of buildings codes to which the credit rule is applicable. If no building codes are provided, the rule is applicable to the entire hotel. This element is only applicable when the parameter for BUILDINGS is active. $ref: '#/components/schemas/codeListType' daysOfWeek: description: Days of the week for which the credit rule is automatically applied to task sheets. If no days of the week are specified the rule must be applied manually. $ref: '#/components/schemas/timeSpanDaysOfWeekType' inactive: description: Indicates if the Housekeeping Credit Rule is inactive. type: boolean itemInventory: description: When RuleType is set to Item Inventory, specifies which item inventory makes this credit rule applicable. For example, the credit value will be added to the task assignment sheet when the assigned room has this specific item inventory applied to the reservation. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' roomClassToBeChanged: type: object description: Request object for changing an existing hotel level room class. properties: roomClass: description: Room class details to be changed. $ref: '#/components/schemas/roomClassType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' buildingType: type: object description: Building or Building Group details associated with the Hotel. properties: hotelId: description: Hotel Identifier of the Building or Building Group. type: string minLength: 0 maxLength: 20 code: description: Building Group or Building Code Identifier of the Hotel. type: string minLength: 0 maxLength: 20 description: description: The description of the Building or Building Group. type: string minLength: 0 maxLength: 2000 targetCredits: description: Target Credit for each task sheet created for this building when auto task assignment is broken out by building. type: integer rooms: description: Rooms associated with the building. $ref: '#/components/schemas/codeListType' credits: description: Total Credits for all the rooms that belong to this building group. type: integer sequence: description: Building Sequence when task assignment is automatically generated by building. type: integer buildingGroupCode: description: Building Group to which building belongs to. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' roomCondtionTemplateType: type: object description: Room Condition Template Type properties: description: description: Description for the room condition. type: string minLength: 0 maxLength: 2000 displayInRoomAssignment: description: Indicates types of assignment. type: boolean comments: description: Comments for the room condition. type: string minLength: 0 maxLength: 2000 displaySeq: type: integer inactive: type: boolean code: type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' roomHierarchiesToBeChanged: type: object description: Request to change room hierarchies properties: roomHierarchies: description: Room hierarchies to be created $ref: '#/components/schemas/roomHierarchiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateRoomFeaturesConfigType: type: array description: Template room feature details. maxItems: 4000 items: $ref: '#/components/schemas/templateRoomFeatureConfigType' deleteHousekeepingAttendantsRequest: type: object properties: inactive: type: array items: type: boolean description: Indicates whether the attendant is active or not. name: type: array items: type: string description: An attendant ID. phoneNo: type: array items: type: string description: An attendant's phone No. section: type: array items: type: string description: Section where the attendant is assigned. floor: type: array items: type: string description: Floor where the attendant is assigned. job: type: array items: type: string description: Job which the attendant is assigned. friday: type: boolean monday: type: boolean saturday: type: boolean sunday: type: boolean thursday: type: boolean tuesday: type: boolean wednesday: type: boolean appUser: type: array items: type: string description: Application User ID assigned for the attendant. roomTypeTemplateSummaryType: type: array description: This type holds collection of room type. maxItems: 4000 items: $ref: '#/components/schemas/roomTypeSummaryType' hotelFloorType: type: object description: Base details common between both template and hotel level floors. properties: floor: description: Specifies the floor code. type: string minLength: 0 maxLength: 20 description: description: Description for the floor. type: string minLength: 0 maxLength: 2000 housekeeping: description: Flag to indicate if this floor should be available on the Task Sheet Workflow configuration. type: boolean sequence: description: Display sequence for the floor. type: integer hotelId: description: Specifies the hotel code for which the floor is specified. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' roomClassTemplateType: type: object description: Common code type for code, description, seq and inactive properties: description: description: Description for the code type. $ref: '#/components/schemas/translationTextType50' sequence: description: Display sequence for the code type. type: integer code: description: Code for the code type. type: string minLength: 0 maxLength: 20 inactive: description: Indicates the code type is inactive or not. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' templateRoomFeaturesToBeChanged: type: object description: Request object for changing template room features. properties: templateRoomFeatures: description: Collection containing details of template room features. $ref: '#/components/schemas/templateRoomFeaturesConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateHousekeepingTasksCriteria: type: object description: Add template housekeeping tasks configurations. properties: tasks: type: array description: List of the housekeeping tasks to be configured maxItems: 4000 items: $ref: '#/components/schemas/templateHousekeepingTaskConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomGroupsDetails: type: object description: Response object for fetching Room Groups. properties: roomGroups: description: Collection of Room Pools fetched. $ref: '#/components/schemas/roomGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateRoomMaintenanceReasonType: type: object description: Base common structure for Room Maintenance at both hotel and template levels. properties: code: description: Identification code for a particular room maintenance reason. type: string minLength: 0 maxLength: 20 description: description: Description of a particular room maintenance reason. type: string minLength: 0 maxLength: 2000 sellSequence: description: Indicates the sell sequence for a particular room maintenance reason. type: number inactive: description: Inactive flag for a particular room maintenance reason. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' floorsDetails: type: object description: Response object for fetching floors at the hotel level. properties: hotelFloors: description: Collection of floors specified at the hotel level. $ref: '#/components/schemas/hotelFloorsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomTypeShortInfoType_2: type: object description: Basic information of room type. properties: pseudo: description: Indicates if room is a pseudo. This is read-only. type: boolean suite: description: Indicates if room is a suite. This is read-only. type: boolean roomClass: description: Room Class of the room. This is read-only. type: string minLength: 0 maxLength: 20 shortDescription: description: Short Description of room type. type: string minLength: 0 maxLength: 200 houseKeeping: description: Indicates if room type of the room is flagged as housekeeping. This is read-only. type: boolean smokingPreference: description: Specifies the smoking preference for room type of the room. type: string minLength: 0 maxLength: 20 building: description: Building associated with the room. type: string minLength: 0 maxLength: 20 roomAssignmentRating: description: Assignment Rating associated with the room. $ref: '#/components/schemas/ratePlanRatingType' minimumOccupancy: description: Minimum occupancy for the room type. type: integer maximumOccupancy: description: Maximum occupancy for the room type. type: integer roomFeatures: description: Room Features for the room. $ref: '#/components/schemas/roomFeaturesType' accessible: description: Indicates if room type is accessible. type: boolean roomType: description: Room type of the room. type: string minLength: 0 maxLength: 20 meetingRoom: description: Indicates whether function space can be meeting room. type: boolean roomStatus: description: Room Status of the room. type: string componentRoomsInfo: type: array description: This type holds information of Component Rooms attached to the Component Suite. maxItems: 4000 items: $ref: '#/components/schemas/componentRoomInfoType' componentSuitesInfo: type: array description: This type holds information of Component Suites to which the Component Room is attached. maxItems: 4000 items: $ref: '#/components/schemas/componentSuiteInfoType' buildingsType: type: array description: Collection of Building details associated with Hotel. maxItems: 4000 items: $ref: '#/components/schemas/buildingType' configRoomType: type: object description: This type represents the primary room attributes. properties: roomType: description: Room type basic information of the room. $ref: '#/components/schemas/roomTypeShortInfoType_2' floor: description: Floor of the Room. type: string minLength: 0 maxLength: 40 floorDescription: description: Description for the Floor of the Room. type: string minLength: 0 maxLength: 20 roomFeatures: description: Room Features for the room. $ref: '#/components/schemas/roomFeaturesType' roomDescription: description: Detail Long Description Of The Room. type: string minLength: 0 maxLength: 20 description: description: Description of the room. $ref: '#/components/schemas/translationTextType2000' smokingPreference: description: This indicates room smoking preference. type: string minLength: 0 maxLength: 20 smokingPreferenceDescription: description: This indicates the description of the room smoking preference. type: string minLength: 0 maxLength: 20 building: description: Building associated with the room. type: string minLength: 0 maxLength: 20 roomAssignmentRating: description: Assignment Rating associated with the room. $ref: '#/components/schemas/ratePlanRatingType' accessible: description: Indicates whether the room is accessibility compliant. type: boolean roomId: description: Code of the room. type: string minLength: 0 maxLength: 20 meetingRoom: description: Indicates whether the room is a Meeting Room type: boolean roomComponents: description: Components of a room. $ref: '#/components/schemas/roomComponentsType' connectingRooms: description: Connecting rooms of a room. $ref: '#/components/schemas/roomRoomsType' rateCode: description: Published rate code of a room. type: string minLength: 0 maxLength: 20 rateAmount: description: Published rate amount of a room. $ref: '#/components/schemas/currencyAmountType' maximumOccupancy: description: Maximum occupancy of a room. type: integer sellSequence: description: Display sequence of a room. type: number ownerRoom: description: This indicates if room is marked as a owner room type: boolean unitGradeCode: description: The Unit Grade Code attached to the room type: string minLength: 0 maxLength: 20 smoking: description: This indicates if smoking is allowed in the room. type: boolean keyCode: description: Key code of a room. type: string minLength: 0 maxLength: 20 keyOptions: description: Key options of a room. $ref: '#/components/schemas/codeListType' squareUnits: description: Square units of a room. type: number turndownService: description: Turndown service flag of a room. type: boolean squareUnitsMeasurement: description: Square unit measurement of a room. type: string minLength: 0 maxLength: 20 phoneNumber: description: Square unit measurement of a room. type: string minLength: 0 maxLength: 20 housekeepingCredit: description: Housekeeping credits of the room. This may include stayover, departure, pickup and turndown credits. type: array maxItems: 4000 items: $ref: '#/components/schemas/housekeepingCreditsType' roomSection: description: Room section of the room. This includes day and evening sections. $ref: '#/components/schemas/roomSectionType' noOfBeds: description: Number of beds of the room. type: integer managedBy: $ref: '#/components/schemas/managedByOptions' buildingGroupsType: type: array description: Collection of Building Group details. maxItems: 4000 items: $ref: '#/components/schemas/buildingGroupType' templateRoomFeaturesDetails: type: object description: Response object to fetch template room features. properties: templateRoomFeatures: description: Collection of template room features. $ref: '#/components/schemas/templateRoomFeaturesConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomFeaturesConfigType: type: array description: Room feature details. maxItems: 4000 items: $ref: '#/components/schemas/roomFeatureConfigType' copyNewRoomType: type: object description: Room details that may differ from the base existing room. If any of Floor, RoomFeatures, HousekeepingCredits and RoomSection types is not passed together with this type, it means that it is expected to be empty for the new room; otherwise, they will have the value of the base existing room. Connecting rooms attached to the base existing room will not be created for the new room. properties: floors: description: Floor preferences of the room. $ref: '#/components/schemas/codeListType' roomFeatures: description: Room features of the room. $ref: '#/components/schemas/roomFeaturesType' housekeepingCredits: description: Housekeeping credits of the room. This may include stayover, departure, pickup and turndown credits. type: array maxItems: 4000 items: $ref: '#/components/schemas/housekeepingCreditsType' roomSection: description: Room section of the room. This includes day and evening sections. $ref: '#/components/schemas/roomSectionType' roomId: description: Room number of the new room to be created. type: string minLength: 0 maxLength: 20 resortRoomConditionCriteria: type: object description: Request object for Create Room Condition. properties: roomCondition: description: Room Condition details to be created. $ref: '#/components/schemas/roomCondtionType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' resortRoomConditionToBeChanged: type: object description: Request object for Modifying Room Condition configuration in a resort. properties: roomCondition: description: Room Condition details to be updated. $ref: '#/components/schemas/roomCondtionType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateOutOfOrderServiceReasonsDetails: type: object description: Response object for fetching template Out of order/service reason(s). properties: outOfOrderServiceReasons: description: Collection of template Out of order/service reason(s). $ref: '#/components/schemas/templateOutOfOrderServiceReasonsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomSectionType: type: object properties: daySectionCode: type: string minLength: 0 maxLength: 20 eveningSectionCode: type: string minLength: 0 maxLength: 20 configHousekeepingRoomScheduleType: type: object description: Facility Housekeeping task code and description. properties: description: description: Facility task description. type: string minLength: 0 maxLength: 80 priority: description: Signifies the priority of the task. type: integer code: description: Code of the housekeeping task. type: string minLength: 0 maxLength: 20 credits: description: Housekeeping credits associated with this housekeeping task. type: integer frequency: description: Signifies frequency(i.e. every 2 days) with which housekeeping task is to be performed. $ref: '#/components/schemas/frequencyTypeType' frequencyDays: description: Specify how often in days following the guest's arrival date, the housekeeping task is to be completed. type: integer specialRequests: description: Specify a particular Special code to associate to a housekeeping task code. $ref: '#/components/schemas/codeListType' vIPStatuses: description: Specify a particular VIP code to associate to a housekeeping task code. $ref: '#/components/schemas/codeListType' sequence: description: Used to store the housekeeping task sequence. type: integer daysOfWeek: description: This option, if applied, works in conjunction with the Every XX Day(s) option to allow you to control the days of the week on which this housekeeping task can take place. $ref: '#/components/schemas/timeSpanDaysOfWeekType' rateCodes: description: Specify one or more Rate Codes to associate to a specific housekeeping task code. $ref: '#/components/schemas/codeListType' marketCodes: description: Specify one or more Market Codes to associate to a specific housekeeping task code. $ref: '#/components/schemas/codeListType' cycleStartDay: description: Signifies offset(in days) i.e. start on 3rd day from arrival. type: integer customizePromptText: description: The information that is entered into this text box. type: string minLength: 0 maxLength: 400 taskSupplies: description: Collection of housekeeping task supplies for a room type. $ref: '#/components/schemas/configHousekeepingRoomScheduleTaskSuppliesType' roomType: description: Specifies the room type code with description. $ref: '#/components/schemas/codeDescriptionType' guestRequested: description: Signifies whether housekeeping task is a guest requested task. type: boolean defaultDepartureTask: description: Signifies that task is a default task for the checked out room. type: boolean moveup: description: Automatically moves the task up one day if it falls on the day before the guest's departure. It will only be available when the schedule is set to every 3 days or more. type: boolean hotelId: description: Specifies the hotel code that the room type belongs to. type: string minLength: 0 maxLength: 20 membershipType: description: Specify a Membership Type to associate to a specific housekeeping task code. type: string minLength: 0 maxLength: 20 membershipLevels: description: Specify one or more Membership Levels to associate to a specific housekeeping task code. $ref: '#/components/schemas/codeListType' managedBy: $ref: '#/components/schemas/managedByOptions' roomTypeTemplatesDetails: type: object description: Response object for information regarding room type template of a property. properties: roomTypeTemplatesSummary: description: Contains the results of a successful operation. $ref: '#/components/schemas/roomTypeTemplateSummaryType' roomTypeTemplates: description: Collection of Room Type Templates and their information. $ref: '#/components/schemas/roomTypeTemplateType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingTaskConfigType: type: object description: Common code type for code, description properties: code: description: Code for the code type. type: string minLength: 0 maxLength: 20 description: description: Description for the code type. type: string minLength: 0 maxLength: 2000 instructions: description: Instructions of the housekeeping task. type: string minLength: 0 maxLength: 2000 sequence: description: Display sequence for the housekeeping task. type: number color: description: Display sequence for the housekeeping task. $ref: '#/components/schemas/colorType' linenChange: description: Signifies whether housekeeping task requires linen change. type: boolean guestRequested: description: Signifies whether housekeeping task is a guest requested task. type: boolean defaultDepartureTask: description: Signifies that task is a default task for the checked out room. type: boolean protected: description: Flag that determines whether this record is protected from removing or not type: boolean appliedCreditsPercentage: description: Percentage of Credits that will be used for this task. Used when the Housekeeping Credits functionality is set to use ROOM_TASK_RULE. The default value is 100. type: number minimum: 0 maximum: 100 inactive: description: Indicates if the task is inactive. type: boolean hotelId: description: Hotel Code for a housekeeping task. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' housekeepingAttendantsConfigType: type: array description: Housekeeping Attendant Information. maxItems: 4000 items: $ref: '#/components/schemas/housekeepingAttendantType' housekeepingCodesToBeChanged: type: object description: Modify housekeeping codes in resort configurations. properties: codes: description: List of the housekeeping code(s) to be modified in the configuration of the resort. $ref: '#/components/schemas/housekeepingCodesConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingCreditRulesDetails: type: object description: Response object for fetching housekeeping credit rules. properties: creditRules: description: List of housekeeping credit rules for configuration. $ref: '#/components/schemas/housekeepingCreditRulesType' masterInfoList: description: Refer to Generic common types document. type: array items: $ref: '#/components/schemas/masterInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' buildingGroupsToBeChanged: type: object description: Request object to change the Building Group details of the Hotel. properties: buildingGroups: description: Collection of Building Group details to be changed for the Hotel. $ref: '#/components/schemas/buildingGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomConditionTemplateCriteria: type: object description: Request object for creating a new Room Condition Template. properties: roomConditionTemplate: description: Room Condition Template details to be created. $ref: '#/components/schemas/roomCondtionTemplateType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateRoomFeatureConfigType: type: object description: Common code type for code, description, seq and inactive properties: description: description: Description for the code type. $ref: '#/components/schemas/translationTextType50' sequence: description: Display sequence for the code type. type: integer code: description: Code for the code type. type: string minLength: 0 maxLength: 20 inactive: description: Indicates the code type is inactive or not. type: boolean chainCode: description: Chain code for the code type. type: string minLength: 0 maxLength: 20 groupCode: description: Group code to which this code type belongs. type: string minLength: 0 maxLength: 20 global: description: Specifies whether the room feature is to be available for selection at all hotels. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' housekeepingCreditRulesCriteria: type: object description: Request object for creating housekeeping credit rules. properties: creditRules: description: List of housekeeping credit rules for configuration. $ref: '#/components/schemas/housekeepingCreditRulesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingSectionType: type: object description: Information regarding Housekeeping Sections. properties: hotelId: description: Property where this section is defined. type: string minLength: 0 maxLength: 20 code: description: The Housekeeping Section Code. type: string minLength: 0 maxLength: 20 description: description: Description of the Section. type: string minLength: 0 maxLength: 80 sectionGroup: description: Housekeeping Section Group. type: string minLength: 0 maxLength: 20 targetCredits: description: Target Credit for each task sheet created for this section when auto task assignment is broken out by section. type: integer rooms: description: Rooms count for this section code. This is auto populated while creating/fetching record. type: integer roomCredits: description: Number of housekeeping credits. This is auto populated while creating/fetching record. type: integer sequence: description: Display sequence when task assignment is automatically broken out by Section Group. type: integer inactive: description: Indicates if the Section Code is active. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' createRoomHierarchiesType: type: object description: Holds collection of room hierarchies properties: roomHierarchy: type: array maxItems: 4000 items: $ref: '#/components/schemas/roomHierarchyType' overwriteExisting: description: Setting this flag to true will overwrite all existing hierarchies. type: boolean housekeepingCreditRulesType: type: array description: The information of housekeeping credit rule for configuration. maxItems: 4000 items: $ref: '#/components/schemas/housekeepingCreditRuleType' configTemplateHousekeepingRoomScheduleTaskSupplyType: type: object description: Type to indicate associated supply codes for the template task properties: code: description: Supply code value. type: string minLength: 0 maxLength: 20 description: description: Description of the supply code. type: string minLength: 0 maxLength: 80 quantity: description: Number of the items to be provided for this task. type: integer sequence: description: Used to store the housekeeping room schedule sequence. type: integer roomType: description: Specifies the room type being scheduled for the task. $ref: '#/components/schemas/codeDescriptionType' housekeepingRoomScheduleCode: description: Specifies the housekeeping room schedule code. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' housekeepingCreditRuleTypeType: type: string description: A Facility Rule will add extra credit to a task assignment sheet when certain task conditions exist. Multiple Facility Task Rules will be applied on top of each other if the conditions are met. A Miscellaneous Rule will add extra credit to a task assignment sheet when the attendants are occupied with anything other than cleaning a room, for example a team meeting. A Special Rule will add extra credit to a task assignment sheet when the defined Specials are attached to a reservation. A Traveling Rule will add extra credit to a task assignment sheet when rooms from multiple Buildings, Section Groups, Sections and/or Floors are assigned. An Inventory Item Rule will add extra credit to a task assignment sheet when the defined Items are attached to a reservation. enum: - FacilityTask - Miscellaneous - Special - Travelling - ItemInventory hotelRoomMaintenanceReasonType: type: object description: Base common structure for Room Maintenance at both hotel and template levels. properties: code: description: Identification code for a particular room maintenance reason. type: string minLength: 0 maxLength: 20 description: description: Description of a particular room maintenance reason. type: string minLength: 0 maxLength: 2000 sellSequence: description: Indicates the sell sequence for a particular room maintenance reason. type: number inactive: description: Inactive flag for a particular room maintenance reason. type: boolean hotelId: description: Hotel code that a particular room maintenance reason belongs to. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' copyHousekeepingCodes: type: object properties: housekeepingCodes: type: array description: List of the housekeeping code(s) to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingTasksDetails: type: object description: Response object for fetching housekeeping tasks. properties: tasks: description: Collection of housekeeping tasks. $ref: '#/components/schemas/housekeepingTasksConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' buildingFloorMappingsDetails: type: object description: Response object for fetching floor mappings to buildings. properties: buildingFloorMappings: description: Collection of floor building mappings configured. $ref: '#/components/schemas/buildingFloorMappingsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelRoomMaintenanceReasonsDetails: type: object description: Response object for fetching room maintenance reasons for a hotel. properties: hotelRoomMaintenanceReasons: description: Collection of hotel level room maintenance reasons. $ref: '#/components/schemas/hotelRoomMaintenanceReasonsType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomCondtionsType: type: array description: Collection of Resort Room Condition Configuration Type maxItems: 4000 items: $ref: '#/components/schemas/roomCondtionType' roomComponentsType: type: array description: Component of a room. maxItems: 4000 items: $ref: '#/components/schemas/roomComponentType' roomRoomType: type: object description: This type represents the primary room attributes. properties: roomType: description: Room type basic information of the room. $ref: '#/components/schemas/roomTypeShortInfoType_2' floor: description: Floor of the Room. type: string minLength: 0 maxLength: 20 floorDescription: description: Description for the Floor of the Room. type: string minLength: 0 maxLength: 20 roomFeatures: description: Room Features for the room. $ref: '#/components/schemas/roomFeaturesType' roomDescription: description: Detail Long Description Of The Room. type: string minLength: 0 maxLength: 20 description: description: Description of the room. $ref: '#/components/schemas/translationTextType2000' smokingPreference: description: This indicates room smoking preference. type: string minLength: 0 maxLength: 20 smokingPreferenceDescription: description: This indicates the description of the room smoking preference. type: string minLength: 0 maxLength: 20 building: description: Building associated with the room. type: string minLength: 0 maxLength: 20 roomAssignmentRating: description: Assignment Rating associated with the room. $ref: '#/components/schemas/ratePlanRatingType' accessible: description: Indicates whether the room is accessibility compliant. type: boolean roomId: description: Code of the room. type: string minLength: 0 maxLength: 20 meetingRoom: description: Indicates whether the room is a Meeting Room type: boolean roomCondition: description: Code and description of condition assigned on the room. $ref: '#/components/schemas/codeDescriptionType' roomClassTemplatesDetails: type: object description: Response object for information regarding template room classes. properties: roomClassTemplates: description: Collection of room class templates and their information. $ref: '#/components/schemas/roomClassTemplatesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomFeaturesDetails: type: object description: Response object to fetch room features of hotel. properties: roomFeatures: description: Collection of hotel room features. $ref: '#/components/schemas/roomFeaturesConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomHierarchiesToGenerate: type: object description: Generates the room hierarchies based on the AI cost function properties: criteria: description: Criteria for generating the room hierarchy $ref: '#/components/schemas/roomHierarchySearchType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomClassType: type: object description: Common code type for code, description, seq and inactive properties: description: description: Description for the code type. $ref: '#/components/schemas/translationTextType50' sequence: description: Display sequence for the code type. type: integer code: description: Code for the code type. type: string minLength: 0 maxLength: 20 inactive: description: Indicates the code type is inactive or not. type: boolean hotelId: description: Hotel code for the code type. type: string minLength: 0 maxLength: 20 roomTypes: description: Room types of a room class. $ref: '#/components/schemas/roomTypesSummaryType' managedBy: $ref: '#/components/schemas/managedByOptions' roomClassTemplateCriteria: type: object description: Request object for creating a new room class template. properties: roomClassTemplate: description: Room class template details to be created. $ref: '#/components/schemas/roomClassTemplateType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingTaskSheetRoomType: type: object description: Details used for storing information about a housekeeping room properties: hotelId: description: Specifies the hotel code of the housekeeping room type: string minLength: 0 maxLength: 20 room: description: Specifies the housekeeping room code type: string minLength: 0 maxLength: 20 roomType: description: Specifies the housekeeping room type type: string minLength: 0 maxLength: 20 building: description: Specifies the building to which the housekeeping room is mapped to. This element will be used only if the BUILDINGS parameter is active. type: string minLength: 0 maxLength: 20 floor: description: Specifies the floor to which the housekeeping room is mapped to type: string minLength: 0 maxLength: 20 daySectionCode: description: Specifies the day section code. This element will be used only if the HOUSEKEEPING_SECTIONS parameter is active. type: string minLength: 0 maxLength: 20 eveningSectionCode: description: Specifies the evening section code. This element will be used only if the HOUSEKEEPING_SECTIONS parameter is active. type: string minLength: 0 maxLength: 20 ruleCredit: description: This element will be used only if the value of HOUSEKEEPING_CREDITS setting is set to ROOM_TASK_RULE or FACILITY. type: object properties: credits: description: Specifies the base credits defined for each housekeeping room. This element will be used only if the value of HOUSEKEEPING_CREDITS setting is set to ROOM_TASK_RULE. type: integer turndownCredits: description: Specifies the turndown credits for each housekeeping room. This element will be used only if the TURNDOWN parameter is active and HOUSEKEEPING_CREDITS setting is set to a value other than NONE. type: integer roomCredit: description: This element will be used only if the value of HOUSEKEEPING_CREDITS setting is set to ROOM. Room credits can be defined for Stayover, Turndown, Departure and Pickup. For Turndown Credits to be used, the TURNDOWN parameter should be active and HOUSEKEEPING_CREDITS setting should be set to a value other than NONE. For Pickup Credits to be used, the PICKUP_STATUS parameter should be active. type: array maxItems: 4 items: $ref: '#/components/schemas/housekeepingCreditsType' sequence: description: Specifies the sorting sequence number for the housekeeping room type: integer housekeepingSectionsType: type: array description: List of the housekeeping sections to be configured or fetched maxItems: 4000 items: $ref: '#/components/schemas/housekeepingSectionType' configRoomsSummaryType: type: object description: This type holds collection of rooms summary. properties: roomSummary: type: array maxItems: 4000 items: $ref: '#/components/schemas/configRoomSummaryType' hotelId: description: Hotel Code of the rooms. type: string minLength: 0 maxLength: 20 noOfRooms: description: Current number of rooms. type: integer roomClassTemplateToBeChanged: type: object description: Request object for modifying an existing room class template. properties: roomClassTemplate: description: Room class template details to be changed. $ref: '#/components/schemas/roomClassTemplateType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' outOfOrderServiceReasonsCriteria: type: object description: Request object for creating new out of order/service reasons for hotels. properties: outOfOrderServiceReasons: description: Collection of out of order/service reasons to be created. $ref: '#/components/schemas/outOfOrderServiceReasonsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomTypeInfoDetails: type: object description: Response object for fetching room type information. properties: roomTypeMasterInfoType: description: Room Type information based on the search criteria. $ref: '#/components/schemas/roomTypeMasterInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' buildingFloorMappingType: type: object description: Building to Floor mapping details associated with the Hotel. properties: floorMappingId: description: Hotel floor mapping ID details. If only ID is present, it will be considered to be removed. $ref: '#/components/schemas/buildingFloorMappingIDType' description: description: The description of the house keeping building to floor mapping. type: string minLength: 0 maxLength: 80 targetCredits: description: Target Credit for each task sheet created for this floor when auto task assignment is broken out by floor. type: integer roomCount: description: Rooms associated with the floor in the building. type: integer credits: description: Total Credits for all the rooms that belong to this building group. type: integer sequence: description: Display sequence when auto task assignment is broken out by floor. type: integer managedBy: $ref: '#/components/schemas/managedByOptions' roomHierarchiesDetails: type: object description: Response for fetch room hierarchies properties: roomHierarchies: $ref: '#/components/schemas/roomHierarchiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomTypesCriteria: type: object description: Request object for Creating a new Room Type. properties: roomType: description: Room Type details to be created. type: object properties: roomTypeDetails: description: Room Type details to be created. $ref: '#/components/schemas/roomTypeType' hotelId: $ref: '#/components/schemas/codeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomTypeAttributesType: type: object description: Attributes of property room type. properties: defaultOccupancy: description: Default occupancy of property room type. type: integer maximumOccupancy: description: Max occupancy of property room type. type: integer noOfPhysicalRooms: description: Number of physical rooms of property room type. type: integer minimumOccupancy: description: Minimum occupancy of property room type. type: integer maximumAdults: description: Maximum adult occupancy of property room type. type: integer maximumChildren: description: Maximum children occupancy of property room type. type: integer buildingGroupsCriteria: type: object description: Request object to create Building Group details of the Hotel. properties: buildingGroups: description: Collection of Building Group details to be created for the Hotel. $ref: '#/components/schemas/buildingGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' saveRoomTypeDescriptionRequest: type: object description: Request object to save generated room type description to improve auto generation process. properties: description: description: Room Type Description. type: string housekeepingCreditsType: type: object description: Information regarding the credits for housekeeping tasks/rooms. properties: type: description: 'The Type of Credit. Example: TOTAL credits for the task sheet, total TRAVELLING credits for the task sheet.' $ref: '#/components/schemas/housekeepingCreditsDefinitionType' numberOfCredits: description: Total number of Credits for the Type. type: number roomClassCriteria: type: object description: Request object for creating a new hotel level room class. properties: roomClass: description: Room class details to be created. $ref: '#/components/schemas/roomClassType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' buildingsDetails: type: object description: Response object after fetching Building details of the Hotel. properties: buildings: description: Collection of Building details specified of the Hotel. $ref: '#/components/schemas/buildingsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomGroupsType: type: array description: List of Room Pools. maxItems: 4000 items: $ref: '#/components/schemas/roomGroupType' templateFloorsDetails: type: object description: Response object for fetching floors at the template level. properties: templateFloors: description: Collection of floors specified at the template level. $ref: '#/components/schemas/templateFloorsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomTypesSummaryType: type: object description: This type holds collection of room type. properties: roomTypeSummary: type: array maxItems: 4000 items: $ref: '#/components/schemas/roomTypeSummaryType' hotelId: description: Hotel Code. type: string minLength: 0 maxLength: 20 setHousekeepingTaskSheetRooms: type: object description: Request object for setting details about housekeeping tasksheet rooms. properties: housekeepingTaskSheetRooms: description: Collection containing information which has to be set for housekeeping tasksheet rooms. $ref: '#/components/schemas/housekeepingTaskSheetRoomsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' componentSuiteInfoType: type: object description: This type holds information of the Component Suite to which the Component Room is attached. properties: componentSuiteNumber: type: string description: Component Suite Number to which the Component Room is attached. componentSuiteRoomType: type: string description: Component Suite Room Type to which the Component Room is attached. componentSuiteRoomStatus: type: string description: Component Suite Room Status to which the Component Room is attached. housekeepingCodesConfigType: type: array description: List of the housekeeping codes to be configured or fetched maxItems: 4000 items: $ref: '#/components/schemas/housekeepingCodeConfigType' copyRoomType: type: object description: Primary details of room to be copied and collection of rooms to be created from it. properties: newRooms: description: Collection of room details that may differ from the base existing room. $ref: '#/components/schemas/copyNewRoomsType' hotelId: description: Hotel code of an existing room that will serve as the basis for the new rooms. roomId: description: Room number of an existing room that will serve as the basis for the new rooms. searchHousekeepingAttendantsRequest: type: object properties: name: type: string description: Partial name of an attendant. attendantsCodes: type: array maxItems: 4000 items: type: string description: Codes to be searched. wildCard: type: string description: Wildcard search on the code. includeInactive: type: boolean description: Indicator that tells whether to include inactive in search results. configHousekeepingRoomScheduleTaskSupplyType: type: object description: Facility Housekeeping Code, its description and quantity. properties: description: description: Facility Code. type: string minLength: 0 maxLength: 80 quantity: description: Signifies the quantity. type: integer code: description: Facility code value. type: string minLength: 0 maxLength: 20 sequence: description: Used to store the housekeeping room schedule sequence. type: integer roomType: description: Specifies the room type code with description. $ref: '#/components/schemas/codeDescriptionType' hotelId: description: Specifies the hotel code that the room type belongs to. type: string minLength: 0 maxLength: 20 housekeepingRoomScheduleCode: description: Specifies the housekeeping room schedule code. type: string minLength: 0 maxLength: 20 roomTypeComponentsType: type: array description: Contains room components of a component room type. maxItems: 4000 items: $ref: '#/components/schemas/roomTypeComponentType' configHotelPreferenceType: type: object description: Base details common between both template and property level preferences. properties: description: description: The description about the preference. type: string minLength: 0 maxLength: 2000 code: description: Specifies the preference code. type: string minLength: 0 maxLength: 20 preferenceGroup: description: Specifies the preference group the preference belongs to. type: string minLength: 0 maxLength: 20 preferenceSubGroup: description: This is a placeholder element for future use. Functionality may not be available for the current implementation. type: string minLength: 0 maxLength: 20 housekeeping: description: Flag to indicate if this preference should be available on the Task Sheet Workflow configuration. It is only applicable for preference types FLOOR and SPECIALS. type: boolean orderSequence: description: Display Order sequence. type: number hotelId: description: Specifies the hotel code for which the preference is specified. type: string minLength: 0 maxLength: 20 roomHierarchySearchType: type: object description: Room hierarchy search type to fetch room hierarchies properties: roomHierarchyType: description: Hierarchy Type will take either Type or Class $ref: '#/components/schemas/roomHierarchyTypeType' hotelCodes: description: List of hotel codes to search $ref: '#/components/schemas/codeListType' fromCode: description: From code to process type: string minLength: 0 maxLength: 20 toCode: description: To code to process type: string minLength: 0 maxLength: 20 buildingFloorMappingsType: type: array description: Collection of Floor to Building mapping details. maxItems: 4000 items: $ref: '#/components/schemas/buildingFloorMappingType' roomsDetails: type: object description: Response object for fetching complete information of existing rooms. properties: rooms: description: Collection of rooms with detailed information. type: array items: $ref: '#/components/schemas/configRoomsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateFloorsToBeChanged: type: object description: Request object for changing floors at the template level. properties: templateFloors: description: Collection containing details of floors specified at the template level which have to be changed. $ref: '#/components/schemas/templateFloorsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomTypesToBeChanged: type: object description: Request object for Modifying Room Type. properties: roomType: description: Room Type details to be changed. type: object properties: roomTypeDetails: description: Room Type details to be changed. $ref: '#/components/schemas/roomTypeType' hotelId: $ref: '#/components/schemas/codeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelRoomMaintenanceReasonsCriteria: type: object description: Request object for creating new room maintenance reasons for a hotel. properties: hotelRoomMaintenanceReasons: description: Collection of hotel room maintenance reasons to be created. $ref: '#/components/schemas/hotelRoomMaintenanceReasonsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyConfigurationCodesType: type: array description: Information needed to copy configuration code from one property to the other. maxItems: 4000 items: $ref: '#/components/schemas/copyConfigurationCodeType' templateFloorsCriteria: type: object description: Request object for creating floors at the template level. properties: templateFloors: description: Collection containing details of floors specified at the template level which have to be created. $ref: '#/components/schemas/templateFloorsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomComponentType: type: object description: Room component and its quantity for the component room type. properties: qty: description: Quantity of room component for the component room type. type: integer description: description: Description of room component. type: string minLength: 0 maxLength: 2000 roomType: type: string minLength: 0 maxLength: 20 rooms: description: Collection of rooms assigned to the room type component. $ref: '#/components/schemas/roomRoomsType' housekeepingCreditRulesToBeChanged: type: object description: Request object for changing housekeeping credit rules. properties: creditRules: description: List of housekeeping credit rules for configuration. $ref: '#/components/schemas/housekeepingCreditRulesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomFeatureConfigType: type: object description: Common code type for code, description, seq and inactive properties: description: description: Description for the code type. $ref: '#/components/schemas/translationTextType50' sequence: description: Display sequence for the code type. type: integer code: description: Code for the code type. type: string minLength: 0 maxLength: 20 inactive: description: Indicates the code type is inactive or not. type: boolean hotelId: description: Hotel code for the code type. type: string minLength: 0 maxLength: 20 groupCode: description: Group code to which this code type belongs. type: string minLength: 0 maxLength: 20 mappedPreferenceCodes: description: Preference codes mapped to the room feature. $ref: '#/components/schemas/configHotelPreferencesType' managedBy: $ref: '#/components/schemas/managedByOptions' generateRoomTypeDescriptionRequest: type: object description: Request object to generate room type description with provided input. properties: inputPrompt: description: A Prompt that helps to generate more precise room type descriptions. type: string roomType: type: string minLength: 1 maxLength: 20 description: Generates a description for the specified room type. hotelId: type: string minLength: 1 maxLength: 20 description: Hotel Code roomTypeDetails: description: Room Type details to be created. $ref: '#/components/schemas/roomTypeType' roomTypeType: type: object description: This type represents the room type attributes. properties: newRoomType: description: New Room type code. (Used in change template room type operation) type: string minLength: 0 maxLength: 20 roomClass: description: Room class for the room type code. type: string minLength: 0 maxLength: 20 bedType: description: Bed type of room type. type: string minLength: 0 maxLength: 20 shortDescription: description: Short Description of room type. $ref: '#/components/schemas/translationTextType2000' description: description: Long Description of room type. $ref: '#/components/schemas/translationTextType2000' smokingPreference: description: Specifies the smoking preference for this room type. I.E. SM, NS. type: string minLength: 0 maxLength: 20 activeDate: description: Active date of the room type. type: string format: date maxLength: 8 pseudo: description: Indicates if room type is pseudo. type: boolean accessible: description: Indicates if room type is accessible. type: boolean suite: description: Indicates room type is a suite. type: object properties: value: type: boolean description: Property Value editable: description: Indicates if room type Room Components may be changed. type: boolean meetingRoom: description: Indicates if the Room Type is configured as a meeting room (function space). This element is available when Type = Pseudo or the Guest Room As Meeting Room OPERA Control is active. type: boolean sendToInterface: description: Indicates room type is sent to interface. type: boolean sellSequence: description: Indicates room types sell sequence. type: number generic: description: Indicates room type is generic. type: boolean maintenance: description: Indicates if the room type is available for maintenance requests. This element is available when the Maintenance OPERA Control is active. type: boolean defaultOccupancy: description: Default occupancy for the room type. type: number minimumOccupancy: description: Minimum occupancy for the room type. type: integer maximumOccupancy: description: Maximum occupancy for the room type. type: integer maxAdults: description: Maximum Adults for the room type. type: integer maxChildren: description: Maximum Children for the room type. type: integer houseKeeping: description: Indicates if the Room Type shows in the Housekeeping components like the Housekeeping Board. type: boolean infoURL: description: Room type info URL. type: string minLength: 0 maxLength: 200 autoPopulate: description: Room type is automatically attached when new rate codes are created. type: boolean autoRoomAssign: description: The Room is automatically assigned when a reservation is made for this Room Type. This element is available when the Room Type Auto Room Assign OPERA Control is on. type: boolean autoCheckin: description: Creates a new linked Reservation, and proceeds within check-in of the new reservation. type: boolean rateFloor: description: This value will control the minimum amount that the selected room type can be sold type: number components: description: Room type component details. $ref: '#/components/schemas/roomTypeComponentsType' features: description: Room type feature details. $ref: '#/components/schemas/roomFeaturesType' yieldStatus: description: Specify whether the room type is yieldable or non-yieldable (Available when a yield integration add-on license is active.) $ref: '#/components/schemas/roomTypeYieldableType' yieldCategory: description: Yield category for this room type (Available when a yield integration add-on license is active and when room type is Yieldable.) type: string minLength: 0 maxLength: 20 roomType: type: string minLength: 0 maxLength: 20 numberOfRooms: description: Number of rooms for this room type. type: integer inactive: description: Is Room type inactive? type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' configHousekeepingRoomSchedulesType: type: array description: This type holds a collection of housekeeping tasks attached to a room type. maxItems: 4000 items: $ref: '#/components/schemas/configHousekeepingRoomScheduleType' outOfOrderServiceReasonsType: type: array description: out of order/service reason details. maxItems: 4000 items: $ref: '#/components/schemas/outOfOrderServiceReasonType' housekeepingAttendantsDetails: type: object description: Response object for fetching Housekeeping Attendants. properties: housekeepingAttendants: description: Criteria to Housekeeping Attendants. $ref: '#/components/schemas/housekeepingAttendantsConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' configRoomSummaryType: type: object description: This type represents the primary room attributes. properties: roomType: description: Room type basic information of the room. $ref: '#/components/schemas/roomTypeShortInfoType_2' ownerRoom: description: This indicates if room is marked as a owner room. This information is used when Room Rotation OPERA control is active. type: boolean unitGradeCode: description: The Unit Grade Code attached to the room. This information is used when Room Rotation OPERA control is active. type: string minLength: 0 maxLength: 20 unitGradeCodeDescription: description: The Unit Grade Code Description describes the unit grade code attached to the room. This information is used when Room Rotation OPERA control is active. type: string minLength: 0 maxLength: 2000 floor: description: Floor of the Room. type: string minLength: 0 maxLength: 20 floorDescription: description: Description for the Floor of the Room. type: string minLength: 0 maxLength: 20 roomFeatures: description: Room Features for the room. $ref: '#/components/schemas/roomFeaturesType' roomDescription: description: Detail Long Description Of The Room. type: string minLength: 0 maxLength: 20 description: description: Description of the room. $ref: '#/components/schemas/translationTextType2000' smokingPreference: description: This indicates room smoking preference. type: string minLength: 0 maxLength: 20 smokingPreferenceDescription: description: This indicates the description of the room smoking preference. type: string minLength: 0 maxLength: 20 building: description: Building associated with the room. type: string minLength: 0 maxLength: 20 roomAssignmentRating: description: Assignment Rating associated with the room. $ref: '#/components/schemas/ratePlanRatingType' accessible: description: Indicates whether the room is accessibility compliant. type: boolean roomId: description: Code of the room. type: string minLength: 0 maxLength: 20 meetingRoom: description: Indicates whether the room is a Meeting Room type: boolean maximumOccupancy: description: Maximum occupancy for the room type. type: integer squareUnits: description: Square units of a room. type: number squareUnitsMeasurement: description: Square unit measurement of a room. type: string minLength: 0 maxLength: 20 roomComponents: description: Components of a room. $ref: '#/components/schemas/roomComponentsType' connectingRooms: description: Connecting rooms of a room. $ref: '#/components/schemas/roomRoomsType' sellSequence: description: Display sequence of a room. type: number managedBy: $ref: '#/components/schemas/managedByOptions' configHousekeepingRoomScheduleTaskSuppliesType: type: array description: This type holds a collection of housekeeping task supplies attached to a room type. maxItems: 4000 items: $ref: '#/components/schemas/configHousekeepingRoomScheduleTaskSupplyType' roomCondtionType: type: object description: Resort Room Condition Configuration Type properties: description: description: Description for the room condition. type: string minLength: 0 maxLength: 2000 displayInRoomAssignment: description: Indicates types of assignment. type: boolean comments: description: Comments for the room condition. type: string minLength: 0 maxLength: 2000 displaySeq: type: integer inactive: type: boolean holdMinutes: type: integer hotelId: type: string minLength: 0 maxLength: 20 code: type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' setBuildingFloorMappings: type: object description: Request object for setting floor mappings to buildings. properties: buildingFloorMappings: description: Collection of floor building mappings to be configured. $ref: '#/components/schemas/buildingFloorMappingsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingSectionGroupCopyType: type: object description: Detailed information of Housekeeping Section Group to copy. properties: sourceHotelCode: description: Source property of the Housekeeping section group. type: string minLength: 0 maxLength: 20 housekeepingSectionGroupCopyInfo: description: List of detailed information of Housekeeping section groups to copy. type: array maxItems: 4000 items: $ref: '#/components/schemas/housekeepingSectionGroupCopyInfoType' roomRoomsType: type: array description: Collection of rooms. maxItems: 4000 items: $ref: '#/components/schemas/roomRoomType' housekeepingSectionGroupsCriteria: type: object description: Request object to create House Keeping Section Groups for resort. properties: housekeepingSectionGroups: description: List of house keeping section groups to create for a resort. $ref: '#/components/schemas/housekeepingSectionGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingCreditRuleTravelTypeType: type: string description: Applies to rooms across multiple section groups. enum: - Building - Floor - Section - SectionGroup templateOutOfOrderServiceReasonsType: type: array description: Template of out of order/service reason details. maxItems: 4000 items: $ref: '#/components/schemas/templateOutOfOrderServiceReasonType' housekeepingSectionsDetails: type: object description: Response object for fetching housekeeping section codes. properties: housekeepingSections: description: Collection of housekeeping section codes. $ref: '#/components/schemas/housekeepingSectionsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' floorsCriteria: type: object description: Request object for creating floors at the hotel level. properties: hotelFloors: description: Collection containing details of floors specified at the hotel level which have to be created. $ref: '#/components/schemas/hotelFloorsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyRooms: type: object description: Request object for creating multiple rooms based on an existing room. New rooms may have different floor preferences, room features, housekeeping credits and room sections. The rest of the details except for attached connecting rooms will be copied from the base existing room. Component rooms are not allowed to be copied. properties: copyRoom: description: Object that holds primary details of room to be copied and collection of rooms to be created from it. $ref: '#/components/schemas/copyRoomType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingTaskSheetRoomsDetails: type: object description: Response object for fetching details about housekeeping tasksheet rooms. properties: housekeepingTaskSheetRooms: description: Collection containing information of housekeeping tasksheet rooms. $ref: '#/components/schemas/housekeepingTaskSheetRoomsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelFloorsType: type: array description: This type holds a collection of floors at the hotel level. maxItems: 4000 items: $ref: '#/components/schemas/hotelFloorType' housekeepingSectionGroupsType: type: array description: List of the housekeeping section groups to be configured or fetched maxItems: 4000 items: $ref: '#/components/schemas/housekeepingSectionGroupType' housekeepingTasksConfigType: type: array description: List of the housekeeping tasks to be configured maxItems: 4000 items: $ref: '#/components/schemas/housekeepingTaskConfigType' templateOutOfOrderServiceReasonsToBeChanged: type: object description: Request object for modifying template out of order/service reasons. properties: templateOutOfOrderServiceReasons: description: Collection of template of out of order/service reasons to be modified. $ref: '#/components/schemas/templateOutOfOrderServiceReasonsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomTypesDetails: type: object description: Response object for Fetching existing Room Types. properties: roomTypesSummary: description: Contains the results of a successful operation. type: array items: $ref: '#/components/schemas/roomTypesSummaryType' roomTypes: description: Collection of Room Type Templates and their information. type: array items: $ref: '#/components/schemas/roomTypesType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateFloorType: type: object description: Base details common between both template and hotel level floors. properties: floor: description: Specifies the floor code. type: string minLength: 0 maxLength: 20 description: description: Description for the floor. type: string minLength: 0 maxLength: 2000 housekeeping: description: Flag to indicate if this floor should be available on the Task Sheet Workflow configuration. type: boolean sequence: description: Display sequence for the floor. type: integer global: description: Specifies whether the floor is to be available for selection at all hotels. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' templateRoomMaintenanceReasonsType: type: array description: Details for room maintenance reason at template level. maxItems: 4000 items: $ref: '#/components/schemas/templateRoomMaintenanceReasonType' templateHousekeepingRoomSchedulesDetails: type: object description: Response object of fetch template housekeeping tasks and its associated housekeeping codes. properties: templateHousekeepingRoomSchedules: type: array description: This type holds a collection of housekeeping task schedules configured at template level. maxItems: 4000 items: $ref: '#/components/schemas/configTemplateHousekeepingRoomScheduleType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomFeaturesCriteria: type: object description: Request object for creating room features of hotel. properties: roomFeatures: description: Collection containing details of room features of hotel. $ref: '#/components/schemas/roomFeaturesConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingRoomSchedulesDetails: type: object description: Response object for fetching housekeeping tasks and housekeeping codes associated to a room type. properties: housekeepingRoomSchedules: description: Collection of housekeeping tasks and housekeeping codes associated to a room type. $ref: '#/components/schemas/configHousekeepingRoomSchedulesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomTypeComponentType: type: object description: Room component and its quantity for the component room type. properties: qty: description: Quantity of room component for the component room type. type: integer description: description: Description of room component. type: string minLength: 0 maxLength: 2000 roomType: type: string minLength: 0 maxLength: 20 buildingsCriteria: type: object description: Request object to create Building details of the Hotel. properties: buildings: description: Collection containing information of Building details to be created. $ref: '#/components/schemas/buildingsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelRoomMaintenanceReasonsType: type: array description: Details for room maintenance reason at hotel level. maxItems: 4000 items: $ref: '#/components/schemas/hotelRoomMaintenanceReasonType' roomTypeInfoType: type: object properties: longDescription: description: Detail description of the Room Type. type: string minLength: 0 maxLength: 2000 webName: description: Name corresponding to a RoomType. type: string minLength: 0 maxLength: 80 webPage: description: URL providing more information about the Room Type. type: string minLength: 0 maxLength: 2000 roomFeatures: description: Collection of room features. $ref: '#/components/schemas/roomFeaturesType' roomTypeAttributes: description: Room type attributes. $ref: '#/components/schemas/roomTypeAttributesType' bookingChannelMappings: description: Booking Channels mapping for the Room Type. type: array maxItems: 4000 items: $ref: '#/components/schemas/bookingChannelMappingType' bedTypeCodes: description: Bed type code associated with room. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 bedType: description: Information regarding the bed type associated with the room type. $ref: '#/components/schemas/bedTypeInfoType' roomType: type: string minLength: 0 maxLength: 20 hotelId: type: string minLength: 0 maxLength: 20 roomClass: type: string minLength: 0 maxLength: 20 description: type: string minLength: 0 maxLength: 2000 suite: description: Indicates room type is a suite. type: boolean component: description: Indicates room type is a Component Room. type: boolean invBlockCode: description: Block code. type: string minLength: 0 maxLength: 40 roomViewCode: description: Represents the room view code like City view, River view, Ocean view etc. type: string minLength: 0 maxLength: 40 promotionCode: description: Represents the promotional code. type: string minLength: 0 maxLength: 40 roomQualifierCode: description: Represents the room qualifier code like Deluxe,Economy,Suite etc. type: string minLength: 0 maxLength: 40 roomQualifierMatchIndicator: description: Represents the match indicator of room qualifier code returned in the response with the requested room qualifier code. type: string minLength: 0 maxLength: 20 accessible: description: Indicates whether room type is accessible or not. type: boolean roomGroupType: type: object description: Contains Common Master configuration detail. properties: code: description: Common Master unique code. type: string minLength: 0 maxLength: 40 description: description: Description of the Master code. $ref: '#/components/schemas/translationTextType2000' displayOrder: description: Common Master record sequence number. type: number hotelId: description: Hotel of the record. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' roomToBeChanged: type: object description: Request object for changing details of an existing room. properties: room: description: Room to be changed. type: object properties: roomDetails: description: Room details to be changed. $ref: '#/components/schemas/configRoomType' hotelId: description: Hotel code of the room to be changed. $ref: '#/components/schemas/codeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' componentRoomInfoType: type: object description: This type holds information of a Component room attached to the Component Suite. properties: componentRoomNumber: type: string description: Component Room Number attached to the Component Suite. componentRoomType: type: string description: Room type of the Component Room attached to the Component Suite. componentRoomStatus: type: string description: Room Status of the Component Room attached to the Component Suite. templateOutOfOrderServiceReasonsCriteria: type: object description: Request object for creating new template out of order/service reasons. properties: templateOutOfOrderServiceReasons: description: Collection of template of out of order/service reasons to be created. $ref: '#/components/schemas/templateOutOfOrderServiceReasonsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomHierarchiesType: type: array description: Holds collection of room hierarchies maxItems: 4000 items: $ref: '#/components/schemas/roomHierarchyType' copyBuildings: type: object description: Request object for copying Building details to hotel(s). properties: copyInstructions: description: List of the Building details to be copied to hotel(s). $ref: '#/components/schemas/copyConfigurationCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' saveRoomTypeDescriptionResponse: type: object description: Response object when room type description is saved. properties: links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' housekeepingTaskSheetRoomsType: type: array description: Collection of housekeeping room details maxItems: 4000 items: $ref: '#/components/schemas/housekeepingTaskSheetRoomType' roomClassTemplatesType: type: array description: Collection of template room classes. maxItems: 4000 items: $ref: '#/components/schemas/roomClassTemplateType' templateGuaranteeCodeCriteria: type: object description: Request object that holds the details of template Guarantee Code to be created. properties: templateGuaranteeCode: description: Details of template Guarantee Code to be created. $ref: '#/components/schemas/guaranteeConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyServiceRequestCodes: type: object properties: serviceRequestCodes: type: array description: List of the template service request code(s) to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cancellationPolicyCriteria: type: object description: Request object that holds the details of Cancellation Policy to be created. properties: cancelPenalty: description: Details of Cancellation Policy to be created. $ref: '#/components/schemas/hotelConfigCancelPenaltiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' serviceRequestCodesType: type: array description: Details for service request code type. maxItems: 4000 items: $ref: '#/components/schemas/serviceRequestCodeType' policyBasisTypeType: type: string description: Full Amount. enum: - FlatAmount - Percentage - Nights - NightPercentage - FullAmount serviceRequestCodesToBeChanged: type: object description: Request object for changing existing service request codes. properties: serviceRequestCodes: description: Collection of service request codes to be changed. $ref: '#/components/schemas/serviceRequestCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelConfigCancelPenaltiesType: type: object description: The CancelPenalty Configuration class defines configuration of a cancellation policy of the hotel facility. properties: cancelPenaltyConfig: description: Collection of template Cancel Penalty configurations. type: array maxItems: 4000 items: $ref: '#/components/schemas/configCancelPenaltyType' hotelId: description: Hotel code of the collection of template Cancel Penalty configurations. type: string minLength: 0 maxLength: 20 preCheckInRulesToBeChanged: type: object description: Request object for modifying an existing Pre Check-In Rule properties: preCheckInRules: description: Pre Check-In Rule to be changed $ref: '#/components/schemas/preCheckInRulesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateMarketCodeCriteria: type: object description: Request object that holds the details of template Market Code to be created. properties: templateMarketCode: description: Details of template Market Code to be created. $ref: '#/components/schemas/templateMarketCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' serviceRequestCodeType: type: object description: Service request code details. properties: hotelId: description: Hotel code for the service request type: string minLength: 0 maxLength: 20 code: description: Code for the service request type: string minLength: 0 maxLength: 20 description: description: Description for the service request type: string minLength: 0 maxLength: 100 deptCode: description: Department code for the service request type: string minLength: 0 maxLength: 20 inactive: description: Tells service request is active or not type: boolean editable: description: Service request is editable or not. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' guaranteeCodeCriteria: type: object description: Request object that holds the details of Guarantee Code to be created. properties: guaranteeCode: description: Details of Guarantee Code to be created. $ref: '#/components/schemas/guaranteeConfigType' hotelId: description: Hotel code for Guarantee Code. $ref: '#/components/schemas/codeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' guaranteeConfigType: type: object description: Specifies Guarantee Code attributes. properties: description: description: Description of the Guarantee Code. type: string minLength: 0 maxLength: 2000 requirements: description: Specifies various requirements for the guarantee code. $ref: '#/components/schemas/guaranteeRequirementsType' distributionAttributes: description: Specifies various distribution attributes for the guarantee code. $ref: '#/components/schemas/distributionAttributesType' shortDescription: description: Brief description of the Guarantee Code. $ref: '#/components/schemas/translationTextType80' paymentTypes: description: Specifies various payment types for the guarantee code. $ref: '#/components/schemas/paymentTypesType' guaranteeCode: description: Code assigned to the Guarantee. type: string minLength: 0 maxLength: 20 onHold: description: If true indicates this Guarantee Code is used only to hold the inventory during reservation process. type: boolean reserveInventory: description: If true indicates inventory will be reserved/deducted when reservation uses this Guarantee Code. type: boolean orderSequence: description: Display Order sequence. type: number lateArrival: description: Represents the late arrival time. type: string massCancellation: description: Defines the Auto mass cancellation criteria (i.e. number of days pending before auto cancellation). type: object properties: autoCancel: description: If true indicates, the reservations having this Guarantee Code will be auto canceled for which the credit card info is missing for number of days specified in pending days. type: boolean pendingDays: description: Number of days, with in which the credit card info should be received for the reservation, using this guarnatee code, to avoid auto cancellation. type: integer inactive: description: Indicates the reservation type is inactive or not. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' serviceRequestCodePriorityType: type: object description: Contains Common Master configuration detail. properties: code: description: Common Master unique code. type: string minLength: 0 maxLength: 40 description: description: Description of the Master code. $ref: '#/components/schemas/translationTextType2000' displayOrder: description: Common Master record sequence number. type: number hotelId: description: Hotel of the record. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' templateCancellationPolicyCriteria: type: object description: Request object that holds the details of template Cancellation Policy to be created. properties: templateCancelPenalty: description: Details of template Cancellation Policy to be created. $ref: '#/components/schemas/configCancelPenaltyType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateDepositPolicyDetails: type: object description: Response for fetch template Deposit Policies. properties: templateDepositPolicies: description: Collection of template Deposit policies. type: array items: $ref: '#/components/schemas/configDepositPolicyType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateMarketGroupCriteria: type: object description: Request object that holds the details of template Market Group to be created. properties: templateMarketGroup: description: Details of template Market Group to be created. $ref: '#/components/schemas/templateMarketGroupType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' serviceRequestCodesDetails: type: object description: Response object for fetching the service request codes for given search criteria hotel, code, active/inactive. properties: serviceRequestCodes: description: Collection of service request codes. $ref: '#/components/schemas/serviceRequestCodesType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateCancellationPolicyDetails: type: object description: Response for fetch template Cancellation Policies. properties: templateCancelPenaltyConfigs: description: Collection of template Cancel Penalty rules. type: array items: $ref: '#/components/schemas/configCancelPenaltyType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateSourceCodeType: type: object description: Common code type for code, description, seq and inactive properties: description: description: Description for the code type. $ref: '#/components/schemas/translationTextType50' sequence: description: Display sequence for the code type. type: integer code: description: Code for the code type. type: string minLength: 0 maxLength: 20 inactive: description: Indicates the code type is inactive or not. type: boolean chainCode: description: Chain code for the code type. type: string minLength: 0 maxLength: 20 groupCode: description: Group code to which this code type belongs. type: string minLength: 0 maxLength: 20 central: description: Indicates if market code is originated from Central. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' guaranteeCodeScheduleDetailType: type: object description: The Guarantee Code Schedule detail Type. properties: timeSpan: description: Time span the Guarantee Code schedule is applicable. $ref: '#/components/schemas/timeSpanType' guaranteeCode: description: Guarantee code and description for this schedule. $ref: '#/components/schemas/codeDescriptionType' applicableCodes: description: Guarantee Code is applicable to hotel, rate plan, Guarantee Code, Credit Rating etc. for this schedule. $ref: '#/components/schemas/policyApplicableCodesType' sequence: description: Sequence for the schedule. type: number override: description: override the schedule? type: boolean inactive: description: schedule Inactive? type: boolean templateMarketCodeToBeChanged: type: object description: Request object that holds the details of template Market Code to be changed. properties: templateMarketCode: description: Details of template Market Code to be changed. $ref: '#/components/schemas/templateMarketCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' marketCodesDetails: type: object description: Response for fetch Market Codes. properties: marketCodes: description: Collection of Market Codes. $ref: '#/components/schemas/marketCodesType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' sourceGroupsDetails: type: object description: Response for fetch Source Groups. properties: sourceGroups: description: Collection of Source Groups. type: array items: $ref: '#/components/schemas/sourceGroupType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' policyScheduleDetailType: type: object description: The Policy Schedule detail Type. properties: timeSpan: description: Time span the policy schedule is applicable. $ref: '#/components/schemas/timeSpanType' policy: description: Policy code and description for this schedule. $ref: '#/components/schemas/codeDescriptionType' applicableCodes: description: Policy is applicable to hotel, rate plan, Guarantee Code, Block, Credit Rating etc. for this schedule. $ref: '#/components/schemas/policyApplicableCodesType' sequence: description: Sequence for the schedule. type: number override: description: override the schedule? type: boolean inactive: description: schedule Inactive? type: boolean ignoreGracePeriod: description: Applicable to Cancel Penalties only. When true, the configured Grace Period and Grace Period Advanced Booking Window will not be considered when determining the applicable cancel penalty date. type: boolean marketCodesType: type: array description: Collection of Market Codes. maxItems: 4000 items: $ref: '#/components/schemas/marketCodeType' templateMarketGroupsDetails: type: object description: Response for fetch template Market Groups. properties: templateMarketGroups: description: Collection of template Market Groups. type: array items: $ref: '#/components/schemas/templateMarketGroupType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' sourceGroupToBeChanged: type: object description: Request object that holds the details of Source Group to be changed. properties: sourceGroup: description: Details of Source Group to be changed. $ref: '#/components/schemas/sourceGroupType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' guaranteeCodeScheduleCriteria: type: object description: Creates the Guarantee Code schedule based on the details provided by the request. properties: guaranteeCodeSchedule: description: Details of the Guarantee Code schedule to be created. $ref: '#/components/schemas/createGuaranteeCodeScheduleType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateSourceCodesDetails: type: object description: Response for fetch template Source Codes. properties: templateSourceCodes: description: Collection of template Source Codes. type: array items: $ref: '#/components/schemas/templateSourceCodeType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyScheduleType: type: object description: The Schedule copy criteria type. properties: scheduleId: description: Unique Identifer for the schedule. $ref: '#/components/schemas/uniqueID_Type' targetHotelCodes: description: List of Hotel Codes where this schedule will be copied. $ref: '#/components/schemas/codeListType' serviceRequestCodePrioritiesType: type: array description: List of Service Request Code Priorities. maxItems: 4000 items: $ref: '#/components/schemas/serviceRequestCodePriorityType' sourceCodesType: type: array description: Collection of Source Codes. maxItems: 4000 items: $ref: '#/components/schemas/sourceCodeType' marketGroupCriteria: type: object description: Request object that holds the details of Market Group to be created. properties: marketGroup: description: Details of Market Group to be created. $ref: '#/components/schemas/marketGroupType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateDepositPolicyCriteria: type: object description: Request object that holds the details of template Deposit Policy to be created. properties: templateDepositPolicy: description: Details of template Deposit Policy to be created. $ref: '#/components/schemas/configDepositPolicyType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' sourceCodeToBeChanged: type: object description: Request object that holds the details of Source Code to be changed. properties: sourceCode: description: Details of Source Code to be changed. $ref: '#/components/schemas/sourceCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' marketCodeColorsType: type: string description: Simple type for Market Code colors. enum: - None - Blue - Red - Cyan - Green - Black - White - Gray - Yellow - Deepteal - Sunsetorange - Aquasky - Mochabrown - Mossgreen - Rosewood - Claybrown - Softlavender - Olivegold - Plumpurple - Mistblue - Forestgreen - Dustyviolet - Oceanblue - Copper guaranteeCodesDetails: type: object description: Response for fetch Guarantee Codes. properties: guaranteeCodes: description: Collection of Guarantee Codes. type: array items: $ref: '#/components/schemas/guaranteeCodesType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateSourceCodeToBeChanged: type: object description: Request object that holds the details of template Source Code to be changed. properties: templateSourceCode: description: Details of template Source Code to be changed. $ref: '#/components/schemas/templateSourceCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' marketGroupsDetails: type: object description: Response for fetch Market Groups. properties: marketGroups: description: Collection of Market Groups. type: array items: $ref: '#/components/schemas/marketGroupType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cancellationPolicyToBeChanged: type: object description: Request object that holds the details of Cancellation Policy to be changed. properties: cancelPenalty: description: Details of Cancellation Policy to be changed. $ref: '#/components/schemas/hotelConfigCancelPenaltiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' mGRank: type: integer minimum: 1 maximum: 999 templateGuaranteeCodeToBeChanged: type: object description: Request object that holds the details of template Guarantee Code to be changed. properties: templateGuaranteeCode: description: Details of template Guarantee Code to be changed. $ref: '#/components/schemas/guaranteeConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateGuaranteeCodesDetails: type: object description: Response for fetch template Guarantee Codes. properties: guaranteeCodes: description: Collection of Guarantee Codes. $ref: '#/components/schemas/templateGuaranteeCodesType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' depositPolicyCriteria: type: object description: Request object that holds the details of hotel level Deposit Policy to be created. properties: depositPolicy: description: Details of hotel level Deposit Policy to be created. $ref: '#/components/schemas/hotelConfigDepositPoliciesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' guaranteeCodeToBeChanged: type: object description: Request object that holds the details of Guarantee Code to be changed. properties: guaranteeCode: description: Details of Guarantee Code to be changed. $ref: '#/components/schemas/guaranteeConfigType' hotelId: description: Hotel code for Guarantee Code. $ref: '#/components/schemas/codeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' marketCodeToBeChanged: type: object description: Request object that holds the details of Market Code to be changed. properties: marketCode: description: Details of Market Code to be changed. $ref: '#/components/schemas/marketCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' guaranteeCodeSchedulesDetails: type: object description: Return response for fetch guarantee code schedules based on request. properties: guaranteeCodeSchedules: description: Collection of guarantee code schedules. $ref: '#/components/schemas/guaranteeCodeSchedulesType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateMarketGroupToBeChanged: type: object description: Request object that holds the details of template Market Group to be changed. properties: templateMarketGroup: description: Details of template Market Group to be changed. $ref: '#/components/schemas/templateMarketGroupType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' marketCodeType: type: object description: Common code type for code, description, seq and inactive properties: description: description: Description for the code type. $ref: '#/components/schemas/translationTextType50' sequence: description: Display sequence for the code type. type: integer code: description: Code for the code type. type: string minLength: 0 maxLength: 20 inactive: description: Indicates the code type is inactive or not. type: boolean hotelId: description: Hotel code for the code type. type: string minLength: 0 maxLength: 20 groupCode: description: Group code to which this code type belongs. type: string minLength: 0 maxLength: 20 displayColor: description: Display color for the marketing type. $ref: '#/components/schemas/marketCodeColorsType' transactionCode: description: Transaction code to map Market Code. type: string minLength: 0 maxLength: 20 printGroup: description: Print Group to map Market Code. $ref: '#/components/schemas/marketCodePrintGroupType' central: description: Indicates if market code is originated from Central. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' policyTypeType: type: string description: Simple type for Policy type. enum: - Deposit - Cancellation preCheckInTimeRuleTypes: type: object properties: endTime: description: The latest possible Internet check-in time for a reservation based on the Time rule type type: string startTime: description: The earliest possible Internet check-in time for a reservation based on the Time rule type type: string daysBeforeArrival: description: The number of days before the arrival date that the reservation can be checked in through the Internet. A zero will mean the day of arrival type: integer daysAfterBooking: description: The number of days after the booking date that the reservation can be checked in over the Internet type: integer hoursPriorToCheckIn: description: Enter the number of hours before the property's official check-in time that the reservation will be eligible for Internet check in type: integer hoursPostCheckIn: description: Enter the number of hours after the property's official check-in time that the reservation will be eligible for Internet check in type: integer absoluteFlag: description: Absolute Flag value for Time Limit Rule. type: boolean guaranteeCodeScheduleToBeChanged: type: object description: Changes the Guarantee Code schedule based on the details provided by the request. properties: guaranteeCodeSchedule: description: details of the the Guarantee Code schedule to be changed. $ref: '#/components/schemas/guaranteeCodeScheduleType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copySchedulesCriteriaType: type: object description: The Criteria for Schedules to be copied. properties: copySchedules: description: The copy Schedule criteria type. $ref: '#/components/schemas/copySchedulesType' marketGroupToBeChanged: type: object description: Request object that holds the details of Market Group to be changed. properties: marketGroup: description: Details of Market Group to be changed. $ref: '#/components/schemas/marketGroupType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' createGuaranteeCodeScheduleDetailType: type: object description: The Guarantee Code Schedule detail Type. properties: timeSpan: description: Time span the Guarantee Code schedule is applicable. $ref: '#/components/schemas/timeSpanType' guaranteeCode: description: Guarantee code and description for this schedule. $ref: '#/components/schemas/codeDescriptionType' applicableCodes: description: Guarantee Code is applicable to hotel, rate plan, Guarantee Code, Credit Rating etc. for this schedule. $ref: '#/components/schemas/createPolicyApplicableCodesType' sequence: description: Sequence for the schedule. type: number override: description: override the schedule? type: boolean inactive: description: schedule Inactive? type: boolean copySchedulesType: type: object description: The collection of Schedules to be copied. properties: schedule: description: The collection of schedule copy criteria. type: array maxItems: 4000 items: $ref: '#/components/schemas/copyScheduleType' hotelId: description: Hotel Code for the Copy Policy operation. type: string minLength: 0 maxLength: 20 policyScheduleType: type: object description: The Policy Schedule Type. properties: scheduleId: description: Unique Identifer for the policy schedule. $ref: '#/components/schemas/uniqueID_Type' scheduleDetail: description: Policy Schedule details. $ref: '#/components/schemas/policyScheduleDetailType' hotelId: description: Hotel code for the Policy Schedules. type: string minLength: 0 maxLength: 20 policyType: description: Policy Type for the Policy Schedules. $ref: '#/components/schemas/policyTypeType' tieredDepositRules: type: array description: Collection of tiered deposit rule policies that are configured and attached to a tiered policy schedule. To be used when OPERA Control parameter 'Tiered Deposit Schedules' is active. maxItems: 4000 items: $ref: '#/components/schemas/tieredDepositRule' tieredCancelPenalties: type: array description: Collection of tiered cancellation penalties that are configured and attached to a tiered policy schedule. To be used when OPERA Control parameter 'Tiered Cancellation Schedules' is active. maxItems: 4000 items: $ref: '#/components/schemas/tieredCancelPenalty' managedBy: $ref: '#/components/schemas/managedByOptions' guaranteeRequirementsType: type: object description: Specifies various requirement for the guarantee code. properties: requirementCode: description: Requirement Code. type: string cancellation: description: When true indicates cancellation on the reservation is required for this guarantee code. type: boolean phoneNumber: description: When true indicates phone number on the reservation is required for this guarantee code. type: boolean address: description: When true indicates address on the reservation is required for this guarantee code. type: boolean creditCard: description: When true indicates Credit Card on the reservation is required for this guarantee code. type: boolean arrivalTime: description: When true indicates arrival Time on the reservation is required for this guarantee code. type: boolean deposit: description: When true indicates deposit is required for this guarantee code. type: boolean email: description: When true indicates an email on the reservation is required for this guarantee code. type: boolean travelAgent: description: When true indicates attaching a travel agent profile on the reservation is required for this guarantee code. type: boolean company: description: When true indicates attaching a company profile on the reservation is required for this guarantee code. type: boolean preCheckInRulesCriteria: type: object description: Request object for creating a Pre Check-In Rule properties: preCheckInRules: description: Pre Check-In Rule to be created $ref: '#/components/schemas/preCheckInRulesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyGuaranteeCodeSchedules: type: object description: Request object that provides the criteria to copy Guarantee Code schedules to different hotels. properties: criteria: description: Copy object type to copy the Guarantee Code schedules. $ref: '#/components/schemas/copySchedulesCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateMarketCodeType: type: object description: Common code type for code, description, seq and inactive properties: description: description: Description for the code type. $ref: '#/components/schemas/translationTextType50' sequence: description: Display sequence for the code type. type: integer code: description: Code for the code type. type: string minLength: 0 maxLength: 20 inactive: description: Indicates the code type is inactive or not. type: boolean chainCode: description: Chain code for the code type. type: string minLength: 0 maxLength: 20 groupCode: description: Group code to which this code type belongs. type: string minLength: 0 maxLength: 20 displayColor: description: Display Color for the template market code type. $ref: '#/components/schemas/marketCodeColorsType' central: description: Indicates if market code is originated from Central. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' policyAmountPercentType: type: object description: Defines the percentage basis for calculating the fee amount or the amount. properties: basisType: description: Provides the basis for how the amount of the guarantee is calculated. $ref: '#/components/schemas/policyBasisTypeType' nights: description: The number of nights of the hotel stay that are used to calculate the fee amount. type: integer percent: description: The percentage used to calculate the amount. type: number minimum: 0 maximum: 100 amount: description: A monetary amount. type: number currencyCode: description: Provides a currency code to reflect the currency in which an amount may be expressed. type: string minLength: 3 maxLength: 3 cancellationPolicyDetails: type: object description: Response for fetch Cancellation Policies. properties: cancelPenalties: description: Collection of Cancellation Policies grouped by hotel. type: object properties: cancelPenalties: description: Collection of Cancellation Policies grouped by hotel. type: array items: $ref: '#/components/schemas/hotelConfigCancelPenaltiesType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' marketCodePrintGroupType: type: string description: Group Print Group Type for country code Sweden. enum: - Business - Conference - Leisure - BusinessSe - ConferenceSe - LeisureSe - GroupSe tieredCancelPenalty: type: object description: Type for a tiered cancellation penalty that is configured and attached to a tiered cancel penalty schedule. properties: cancelPenaltyCodeDescription: description: '' $ref: '#/components/schemas/codeDescriptionType' cancelPenaltyId: description: Internal cancel penalty identifier that is used to attach the tiered cancel penalty to a tiered cancel penalty schedule. type: number amountPercent: description: Cancellation fee expressed as a fixed amount, or percentage of/or room nights. $ref: '#/components/schemas/policyAmountPercentType' deadline: description: Cancellation deadline, absolute or relative. $ref: '#/components/schemas/policyDeadlineType' createGuaranteeCodeScheduleType: type: object description: The Guarantee Code Schedule Type. properties: scheduleDetail: description: Guarantee Code Schedule details. $ref: '#/components/schemas/createGuaranteeCodeScheduleDetailType' hotelId: description: Hotel code for the Guarantee Code Schedule. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' templateMarketCodesDetails: type: object description: Response for fetch template Market Codes. properties: templateMarketCodes: description: Collection of template market codes. type: array items: $ref: '#/components/schemas/templateMarketCodeType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateSourceGroupsDetails: type: object description: Response for fetch template Source Groups. properties: templateSourceGroups: description: Collection of template Source Groups. type: array items: $ref: '#/components/schemas/templateSourceGroupType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateGuaranteeCodesType: type: array description: Guarantee Code details. maxItems: 4000 items: $ref: '#/components/schemas/guaranteeConfigType' offsetUnitType: type: string description: Indicates deadline offset unit type. enum: - Year - Month - Day - Hour sourceCodeType: type: object description: Common code type for code, description, seq and inactive properties: description: description: Description for the code type. $ref: '#/components/schemas/translationTextType50' sequence: description: Display sequence for the code type. type: integer code: description: Code for the code type. type: string minLength: 0 maxLength: 20 inactive: description: Indicates the code type is inactive or not. type: boolean hotelId: description: Hotel code for the code type. type: string minLength: 0 maxLength: 20 groupCode: description: Group code to which this code type belongs. type: string minLength: 0 maxLength: 20 central: description: Indicates if market code is originated from Central. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' serviceRequestCodesCriteria: type: object description: Request object for creating new service request codes. properties: serviceRequestCodes: description: Collection of service request codes to be created. $ref: '#/components/schemas/serviceRequestCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipTypeLevelType: type: object properties: type: description: Code type for Rule Details type: string minLength: 0 maxLength: 20 level: description: Description type for Rule Details type: string minLength: 0 maxLength: 20 guaranteeCodesType: type: object description: The Collection of Guarantee Codes Type. properties: guaranteeCode: description: Guarantee Code details. type: array maxItems: 4000 items: $ref: '#/components/schemas/guaranteeConfigType' hotelId: description: Hotel code for fetched template Guarantee Codes. type: string minLength: 0 maxLength: 20 templateSourceCodeCriteria: type: object description: Request object that holds the details of template Source Code to be created. properties: templateSourceCode: description: Details of template Source Code to be created. $ref: '#/components/schemas/templateSourceCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' serviceRequestCodePrioritiesCriteria: type: object description: Request object for creating Service Request Code Priorities. properties: serviceRequestCodePriorities: description: Service Request Code Priorities to be created. $ref: '#/components/schemas/serviceRequestCodePrioritiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' sourceCodeCriteria: type: object description: Request object that holds the details of Source Code to be created. properties: sourceCode: description: Details of Source Code to be created. $ref: '#/components/schemas/sourceCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' policySchedulesDetails: type: object description: Return response for fetch policy schedules based on request. properties: policySchedules: description: Collection of policy schedules. $ref: '#/components/schemas/policySchedulesType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateDepositPolicyToBeChanged: type: object description: Request object that holds the details of template Deposit Policy to be changed. properties: templateDepositPolicy: description: Details of template Deposit Policy to be changed. $ref: '#/components/schemas/configDepositPolicyType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelConfigDepositPoliciesType: type: object description: Collection of Deposit Policy Configurations of a hotel. properties: depositPolicy: description: Collection of Deposit Policy configurations of a hotel. type: array maxItems: 4000 items: $ref: '#/components/schemas/configDepositPolicyType' hotelId: description: Hotel code of the collection of Deposit Policy configurations. type: string minLength: 0 maxLength: 20 policyScheduleToBeChanged: type: object description: Changes the Policy schedule based on the details provided by the request. properties: policySchedule: description: details of the the policy schedule to be changed. $ref: '#/components/schemas/policyScheduleType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' preCheckInRulesDetails: type: object description: Response object for information regarding Pre Check-In Rule properties: preCheckInRules: description: Collection of Pre Check-In Rule and their information $ref: '#/components/schemas/preCheckInRulesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' policySchedulesType: type: array description: Unique Identifer for the policy schedule. maxItems: 4000 items: $ref: '#/components/schemas/policyScheduleType' paymentTypesType: type: array description: Payment card code like AX,VI etc. maxItems: 4000 items: type: string minLength: 0 maxLength: 20 templateSourceGroupToBeChanged: type: object description: Request object that holds the details of template Source Group to be changed. properties: templateSourceGroup: description: Details of template Source Group to be changed. $ref: '#/components/schemas/templateSourceGroupType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' guaranteeCodeSchedulesType: type: array description: Unique Identifer for the Guarantee Code schedule. maxItems: 4000 items: $ref: '#/components/schemas/guaranteeCodeScheduleType' preCheckInRulesType: type: array description: Collection of Pre Check-In Rules List maxItems: 4000 items: $ref: '#/components/schemas/preCheckInRuleType' depositPolicyDetails: type: object description: Response for fetch Deposit Policies in hotel level. properties: depositPolicies: description: Collection of Deposit Policies grouped by hotel. type: object properties: depositPolicies: description: Collection of Deposit Policies grouped by hotel. type: array items: $ref: '#/components/schemas/hotelConfigDepositPoliciesType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' depositPolicyToBeChanged: type: object description: Request object that holds the details of hotel level Deposit Policy to be changed. properties: depositPolicy: description: Details of hotel level Deposit Policy to be changed. $ref: '#/components/schemas/hotelConfigDepositPoliciesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' distributionAttributesType: type: object properties: availableChannels: description: Distribution channels in which the guarantee code may be used. If no channels are selected, the guarantee code is available for all distribution channels. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 2000 distributionGuaranteeType: description: Distribution Guarantee Types to which the guarantee code may be mapped type: string releaseTime: description: 'Time (HH24:MM format) in which the reservation is to be released, available when distributionGuaranteeType is set to ''38'' (None) ' type: string preCheckInRuleType: type: object description: A Internet Pre Check-In Rule properties: timeSpan: description: The period for the Pre Check-In Rule $ref: '#/components/schemas/timeSpanType' newTimeSpan: description: The new period for the Pre Check-In Rule. Only used to Change the time span. $ref: '#/components/schemas/timeSpanType' memberships: description: The rule type on which the Internet Pre Check-In Rule is based $ref: '#/components/schemas/membershipTypeLevelListType' specials: description: Only available when Time is selected as the Rule Type $ref: '#/components/schemas/codeListType' marketCodes: description: Only available when Time is selected as the Rule Type $ref: '#/components/schemas/codeListType' timeLimit: description: The rule type on which the Internet Pre Check-In Rule is based $ref: '#/components/schemas/preCheckInTimeRuleTypes' ratePlans: description: The rule type on which the Internet Pre Check-In Rule is based $ref: '#/components/schemas/codeListType' reservationTypes: description: The rule type on which the Internet Pre Check-In Rule is based $ref: '#/components/schemas/codeListType' vIPCodes: description: The rule type on which the Internet Pre Check-In Rule is based $ref: '#/components/schemas/codeListType' originCodes: description: The rule type on which the Internet Pre Check-In Rule is based $ref: '#/components/schemas/codeListType' hotelId: description: Hotel code of Pre Check-In Rule to be searched type: string minLength: 0 maxLength: 20 ruleType: description: Internet Pre Check-In Rule for the property, are based on the rule types. $ref: '#/components/schemas/preCheckInRuleTypeType' templateSourceGroupType: type: object description: Common code type for code, description, seq and inactive properties: description: description: Description for the code type. $ref: '#/components/schemas/translationTextType50' sequence: description: Display sequence for the code type. type: integer code: description: Code for the code type. type: string minLength: 0 maxLength: 20 inactive: description: Indicates the code type is inactive or not. type: boolean chainCode: description: Chain code for the code type. type: string minLength: 0 maxLength: 20 templateSourceCode: description: Collection of Template Source Codes. type: array maxItems: 4000 items: $ref: '#/components/schemas/templateSourceCodeType' central: description: Indicates if market code is originated from Central. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' policyScheduleCriteria: type: object description: Creates the Policy schedule based on the details provided by the request. properties: policySchedule: description: Details of the the policy schedule to be created. $ref: '#/components/schemas/policyScheduleType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' sourceCodesDetails: type: object description: Response for fetch Source Codes. properties: sourceCodes: description: Collection of Source Codes. $ref: '#/components/schemas/sourceCodesType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' createPolicyApplicableCodesType: type: object description: The object contains the applicatble code for creation of new policy schedule. properties: hotelId: description: create schedule for this Hotel code. type: string minLength: 0 maxLength: 20 ratePlanCodes: description: create schedule for this Rate plan code. $ref: '#/components/schemas/codeListType' guaranteeCodes: description: create schedule for these Guarantee codes. $ref: '#/components/schemas/codeListType' blockId: description: Block Id for creation. $ref: '#/components/schemas/uniqueID_Type' blockCode: description: create schedule for this Block code. type: string minLength: 0 maxLength: 20 creditRatings: description: create schedule for this Credit Rating. $ref: '#/components/schemas/codeListType' seasonCode: description: create schedule for this Season Code. type: string minLength: 0 maxLength: 20 templateMarketGroupType: type: object description: Common code type for code, description, seq and inactive properties: description: description: Description for the code type. $ref: '#/components/schemas/translationTextType50' sequence: description: Display sequence for the code type. type: integer code: description: Code for the code type. type: string minLength: 0 maxLength: 20 inactive: description: Indicates the code type is inactive or not. type: boolean chainCode: description: Chain code for the code type. type: string minLength: 0 maxLength: 20 templateMarketCode: description: Collection of Template Market Codes. type: array maxItems: 4000 items: $ref: '#/components/schemas/templateMarketCodeType' central: description: Indicates if market code is originated from Central. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' serviceRequestCodePrioritiesDetails: type: object description: Response object for fetching Service Request Code Priorities. properties: serviceRequestCodePriorities: description: Collection of Service Request Code Priorities. $ref: '#/components/schemas/serviceRequestCodePrioritiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyPolicySchedules: type: object description: Request object that provides the criteria to copy policy schedules to different hotels. properties: criteria: description: Copy object type to copy the policy schedules. $ref: '#/components/schemas/copySchedulesCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' guaranteeCodeScheduleType: type: object description: The Guarantee Code Schedule Type. properties: scheduleId: description: Unique Identifer for the Guarantee Code schedule. $ref: '#/components/schemas/uniqueID_Type' scheduleDetail: description: Guarantee Code Schedule details. $ref: '#/components/schemas/guaranteeCodeScheduleDetailType' hotelId: description: Hotel code for the Guarantee Code Schedule. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' sourceGroupType: type: object description: Common code type for code, description, seq and inactive properties: description: description: Description for the code type. $ref: '#/components/schemas/translationTextType50' sequence: description: Display sequence for the code type. type: integer code: description: Code for the code type. type: string minLength: 0 maxLength: 20 inactive: description: Indicates the code type is inactive or not. type: boolean hotelId: description: Hotel code for the code type. type: string minLength: 0 maxLength: 20 sourceCodes: description: Collection of Source Codes. $ref: '#/components/schemas/sourceCodesType' central: description: Indicates if market code is originated from Central. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' configDepositPolicyType: type: object description: Used to define the deposit policy, guarantees policy, and/or accepted forms of payment. properties: amountPercent: description: Payment expressed as a fixed amount, or a percentage of/or room nights. $ref: '#/components/schemas/policyAmountPercentType' deadline: description: Payment deadline, absolute or relative. $ref: '#/components/schemas/policyDeadlineType' description: description: Text description of the Payment in a given language. type: string minLength: 0 maxLength: 100 depositReceiptNo: description: Receipt number associated with the deposit policy type: integer transactionDate: description: Transaction Date associated with the deposit policy type: string format: date maxLength: 8 depositReqReversed: description: Flag to indicate if deposit policy is reversed type: boolean formattedRule: description: Formatted Text Rule of the deposit policy. type: string minLength: 0 maxLength: 2000 typeOfCharges: description: Defines if the deposit amount is calculated based on Room Charges, Catering Charges or both $ref: '#/components/schemas/depositCancelRevenueType' policyCode: description: Deposit Policy Code type: string minLength: 0 maxLength: 20 manual: description: Flag to indicate if the cancellation policy is manual. type: boolean sequence: description: The sequence number that determines the position of this rule in the Deposit or Cancellation rules LOV. type: integer inactive: description: Inactive rules are no longer available for attachment to rate codes, reservation types or reservations; however, they are still recorded in the database for historical purposes. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' marketCodeCriteria: type: object description: Request object that holds the details of Market Code to be created. properties: marketCode: description: Details of Market Code to be created. $ref: '#/components/schemas/marketCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' sourceGroupCriteria: type: object description: Request object that holds the details of Source Group to be created. properties: sourceGroup: description: Details of Source Group to be created. $ref: '#/components/schemas/sourceGroupType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' policyDeadlineType: type: object description: Cancellation deadline, absolute or relative. properties: absoluteDeadline: description: Defines the absolute deadline. Either this or the offset attributes may be used. Uses the hotel's time zone. type: string format: date-time offsetFromArrival: description: The number of days before arrival that allows cancellation without penalties. type: integer offsetDropTime: description: Time on offset day the cancellation penalties applies. Uses the hotel's time zone. type: string format: date-time offsetFromBookingDate: description: The number of days after booking deposit must be paid. type: integer templateCancellationPolicyToBeChanged: type: object description: Request object that holds the details of template Cancellation Policy to be changed. properties: templateCancelPenalty: description: Details of template Cancellation Policy to be changed. $ref: '#/components/schemas/configCancelPenaltyType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateSourceGroupCriteria: type: object description: Request object that holds the details of template Source Group to be created. properties: templateSourceGroup: description: Details of template Source Group to be created. $ref: '#/components/schemas/templateSourceGroupType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' serviceRequestCodePrioritiesToBeChanged: type: object description: Request object for changing Service Request Code Priorities. properties: serviceRequestCodePriorities: description: Service Request Code Priorities to be changed. $ref: '#/components/schemas/serviceRequestCodePrioritiesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' tieredDepositRule: type: object description: Type for a tiered deposit rule policy that is configured and attached to a tiered deposit rule schedule. properties: depositRuleCodeDescription: description: '' $ref: '#/components/schemas/codeDescriptionType' depositRuleId: description: Internal deposit rule identifier that is used to attach the tiered deposit rule to a tiered deposit rule schedule. type: number amountPercent: description: Payment expressed as a fixed amount, or a percentage of/or room nights. $ref: '#/components/schemas/policyAmountPercentType' deadline: description: Payment deadline, absolute or relative. $ref: '#/components/schemas/policyDeadlineType' marketGroupType: type: object description: Common code type for code, description, seq and inactive properties: description: description: Description for the code type. $ref: '#/components/schemas/translationTextType50' sequence: description: Display sequence for the code type. type: integer code: description: Code for the code type. type: string minLength: 0 maxLength: 20 inactive: description: Indicates the code type is inactive or not. type: boolean hotelId: description: Hotel code for the code type. type: string minLength: 0 maxLength: 20 marketCodes: description: Collection of Market Codes. $ref: '#/components/schemas/marketCodesType' ranking: description: Rank of the Market Group used for Room Assignment Optimization $ref: '#/components/schemas/mGRank' upgradable: description: Defines if the Market Group is eligible for auto upgrade for Room Assignment Optimization type: boolean central: description: Indicates if market code is originated from Central. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' policyApplicableCodesType: type: object description: The object contains usage of the Policy Schedule detail Type. properties: hotelId: description: Schedule is used by this Hotel code. type: string minLength: 0 maxLength: 20 ratePlanCodes: description: Schedule is used by this Rate plan code. $ref: '#/components/schemas/codeListType' guaranteeCodes: description: Schedule is used by this Guarantee code. $ref: '#/components/schemas/codeListType' blockIds: description: Block Id to search. $ref: '#/components/schemas/uniqueIDListType' blockCode: description: Schedule is used by this Block code. type: string minLength: 0 maxLength: 20 creditRatings: description: Schedule is used by this Credit Rating. $ref: '#/components/schemas/codeListType' seasonCode: description: Schedule is used by this Season Code. type: string minLength: 0 maxLength: 20 membershipTypeLevelListType: type: array description: Code type for Rule Details maxItems: 4000 items: $ref: '#/components/schemas/membershipTypeLevelType' preCheckInRuleTypeType: type: string description: The rule type on which the Internet Pre Check-In Rule is based. If a reservation has any of the following code, Pre CheckIn rule gets active for that reservation enum: - Specials - MarketCodes - TimeLimit - RatePlans - ReservationTypes - VIPCodes - Memberships - OriginCodes depositCancelRevenueType: type: string description: The type to indicate what revenue is to be used for calculating deposit/cancellation amounts. enum: - Rooms - Catering - All configCancelPenaltyType: type: object description: The CancelPenalty class defines the cancellation policy of the hotel facility. properties: deadline: description: Cancellation deadline, absolute or relative. $ref: '#/components/schemas/policyDeadlineType' amountPercent: description: Cancellation fee expressed as a fixed amount, or percentage of/or room nights. $ref: '#/components/schemas/policyAmountPercentType' penaltyDescription: description: Text description of the Penalty in a given language. type: string minLength: 0 maxLength: 100 offsetUnit: $ref: '#/components/schemas/offsetUnitType' formattedRule: description: Formatted Text Rule of the Cancellation Penalty. type: string minLength: 0 maxLength: 2000 policyCode: description: Policy Code. type: string minLength: 0 maxLength: 20 manual: description: Flag to indicate if the cancellation policy is manual. type: boolean nonRefundable: description: Indicates if the amount is refundable if booking is canceled. type: boolean sequence: description: The sequence number that determines the position of this rule in the Deposit or Cancellation rules LOV. type: integer managedBy: $ref: '#/components/schemas/managedByOptions' inactive: description: Inactive rules are no longer available for attachment to rate codes, reservation types or reservations; however, they are still recorded in the database for historical purposes. type: boolean hotelRateCategoriesType: type: object properties: rateCategory: type: array maxItems: 4000 items: $ref: '#/components/schemas/rateCategoryType' hotelId: description: Hotel Code for a rate category. type: string minLength: 0 maxLength: 20 templateRateCategoryToBeChanged: type: object properties: templateRateCategory: description: Template rate category to be changed. $ref: '#/components/schemas/templateRateCategoryType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateRateClassCriteria: type: object description: Request to create new template rate class. properties: templateRateClass: description: New template rate class to be saved. $ref: '#/components/schemas/templateRateClassType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' rateCategoryDetails: type: object description: Response object for fetching Rate Categories for a property. properties: hotelRateCategories: description: Collection of Hotel level Rate categories. type: object properties: rateCategories: description: Collection of Hotel level Rate categories. type: array items: $ref: '#/components/schemas/hotelRateCategoriesType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' rateSeasonsCriteria: type: object description: Request object for creating new rate seasons for a hotel. properties: rateSeasons: description: Collection of hotel rate seasons to be created. $ref: '#/components/schemas/rateSeasonsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateRateCategoryType: type: object description: This type represents the rate category type. properties: rateCategoryDetails: description: Begin date for the rate category. type: object properties: beginDate: description: Begin date for the rate category. type: string format: date maxLength: 8 endDate: description: End date for the rate category. type: string format: date maxLength: 8 description: description: Description of rate category. type: string minLength: 0 maxLength: 200 rateClass: description: Active date of the room category. type: string minLength: 0 maxLength: 20 sellSequence: description: Indicates rate category sell sequence. type: number rateCategory: description: Rate category Code. type: string minLength: 0 maxLength: 20 simpleRateCategoriesType: type: array description: List of Rate Categories with description. maxItems: 4000 items: $ref: '#/components/schemas/codeDescriptionType' rateSeasonType: type: object description: Base details common between hotel and template rate seasons. properties: description: description: Description of the rate season. type: string minLength: 0 maxLength: 2000 dateRange: description: Start and end dates of the rate season. $ref: '#/components/schemas/timeSpanType' seasonCode: description: Season code to identify the rate season. type: string minLength: 0 maxLength: 20 reservedForRateCode: description: Rate code associated with the rate season. When a rate code is provided, the season code is reserved exclusively for this rate code and cannot be used in other rate codes. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel code that the rate season belongs to. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' rateClassType: type: object description: A hotel rate class. properties: description: description: Description of the rate class. type: string minLength: 0 maxLength: 2000 sequence: description: Display Sequence of the rate class. type: integer timeSpan: description: Begin Date and End Date of the rate class. $ref: '#/components/schemas/timeSpanType' rateClass: description: Code that uniquely identifies the rate class. type: string minLength: 0 maxLength: 20 rateCategories: description: List of Attached Rate Categories. $ref: '#/components/schemas/simpleRateCategoriesType' hotelId: description: Hotel Code the rate class belongs to. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' rateSeasonsDetails: type: object description: Response object for fetching rate seasons for a hotel. properties: rateSeasons: description: Collection of hotel level rate seasons. $ref: '#/components/schemas/rateSeasonsType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateRateClassDetails: type: object description: Response for fetch template rate classes. properties: templateRateClasses: description: Collection of template rate classes. $ref: '#/components/schemas/templateRateClassesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' rateCategoryCriteria: type: object description: Request object for Creating a new Rate Category for a property. properties: hotelRateCategory: description: Hotel rate category to be created. $ref: '#/components/schemas/hotelRateCategoryType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelRateCategoryType: type: object description: This type represents the rate category type. properties: rateCategoryDetails: description: Begin date for the rate category. type: object properties: beginDate: description: Begin date for the rate category. type: string format: date maxLength: 8 endDate: description: End date for the rate category. type: string format: date maxLength: 8 description: description: Description of rate category. type: string minLength: 0 maxLength: 200 rateClass: description: Active date of the room category. type: string minLength: 0 maxLength: 20 sellSequence: description: Indicates rate category sell sequence. type: number rateCategory: description: Rate category Code. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel Code for a rate category. type: string minLength: 0 maxLength: 20 rateSeasonsToBeChanged: type: object description: Request object for modifying rate seasons for a hotel. properties: rateSeasons: description: Collection of hotel rate season to be changed. $ref: '#/components/schemas/rateSeasonsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' rateClassDetails: type: object description: Response for fetch rate classes. properties: rateClasses: description: Collection of rate classes. type: object properties: rateClasses: description: Collection of rate classes. $ref: '#/components/schemas/rateClassesType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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 limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateRateCategoriesType: type: array maxItems: 4000 items: $ref: '#/components/schemas/rateCategoryType' templateRateClassType: type: object description: A template rate class. properties: description: description: Description of the rate class. type: string minLength: 0 maxLength: 2000 sequence: description: Display Sequence of the rate class. type: integer timeSpan: description: Begin Date and End Date of the rate class. $ref: '#/components/schemas/timeSpanType' rateClass: description: Code that uniquely identifies the rate class. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' rateSeasonsType: type: array description: Hotel rate season details. maxItems: 4000 items: $ref: '#/components/schemas/rateSeasonType' templateRateCategoryDetails: type: object properties: templateRateCategories: description: Collection of template rate categories. type: array items: $ref: '#/components/schemas/templateRateCategoriesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' rateClassesType: type: array description: Collection of hotel rate classes. maxItems: 4000 items: $ref: '#/components/schemas/rateClassType' templateRateSeasonsType: type: array description: Hotel rate season details. maxItems: 4000 items: $ref: '#/components/schemas/templateRateSeasonType' templateRateSeasonsCriteria: type: object description: Request object for creating new template rate seasons. properties: templateRateSeasons: description: Collection of template rate seasons to be created. $ref: '#/components/schemas/templateRateSeasonsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateRateSeasonsDetails: type: object description: Response object for fetching template rate seasons. properties: templateRateSeasons: description: Collection of template level rate seasons. $ref: '#/components/schemas/templateRateSeasonsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' rateClassToBeChanged: type: object description: Request to save changes to rate class. properties: rateClass: description: Rate class to be updated. $ref: '#/components/schemas/rateClassType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateRateClassToBeChanged: type: object description: Request to save changes to template rate class. properties: templateRateClass: description: Template rate class to be updated. $ref: '#/components/schemas/templateRateClassType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' rateClassCriteria: type: object description: Request to create new rate class. properties: rateClass: description: New rate class to be saved. $ref: '#/components/schemas/rateClassType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateRateClassesType: type: array description: Collection of template rate classes. maxItems: 4000 items: $ref: '#/components/schemas/templateRateClassType' templateRateSeasonType: type: object description: Base details common between hotel and template rate seasons. properties: description: description: Description of the rate season. type: string minLength: 0 maxLength: 2000 dateRange: description: Start and end dates of the rate season. $ref: '#/components/schemas/timeSpanType' seasonCode: description: Season code to identify the rate season. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' rateCategoryToBeChanged: type: object description: Request object for modifying a Rate Category for a property. properties: hotelRateCategory: description: Hotel rate category to be changed. $ref: '#/components/schemas/hotelRateCategoryType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateRateCategoryCriteria: type: object properties: templateRateCategory: description: Template rate category to be created. $ref: '#/components/schemas/templateRateCategoryType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateRateSeasonsToBeChanged: type: object description: Request object for modifying template rate seasons. properties: templateRateSeasons: description: Collection of template rate seasons to be changed. $ref: '#/components/schemas/templateRateSeasonsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' rateCategoryType: type: object description: This type represents the rate category type. properties: rateCategoryDetails: description: Begin date for the rate category. type: object properties: beginDate: description: Begin date for the rate category. type: string format: date maxLength: 8 endDate: description: End date for the rate category. type: string format: date maxLength: 8 description: description: Description of rate category. type: string minLength: 0 maxLength: 200 rateClass: description: Active date of the room category. type: string minLength: 0 maxLength: 20 sellSequence: description: Indicates rate category sell sequence. type: number rateCategory: description: Rate category Code. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' externalDocs: description: Find out more about Oracle Hospitality url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html x-refined-from: - oracle-hospitality-property-v1-crmcfg.json - oracle-hospitality-property-v1-entcfg.json - oracle-hospitality-property-v1-evmcfg.json - oracle-hospitality-property-v1-fofcfg.json - oracle-hospitality-property-v1-rmcfg.json - oracle-hospitality-property-v1-rsvcfg.json - oracle-hospitality-property-v1-rtp.json