openapi: 3.2.0
info:
title: OPERA Cloud API for Service Customer Management API
description: This API deals with the different aspect of the CustomerManagement.
Compatible with OPERA Cloud release 26.2.0.0.
This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2026 Oracle and/or its affiliates.
version: 26.2.0.0 termsOfService: https://www.oracle.com/legal/terms.html contact: email: hospitality_apis_ww_grp@oracle.com license: name: UPL url: https://opensource.org/licenses/upl servers: - url: /cms/v1 tags: - name: CustomerManagement description: Customer Management web service caters operations for Customer Management activities. paths: /hotels/{hotelId}/trackItems: post: summary: Creates track it items description: Create a new Track It Item. Track It manages storage and delivery of guest luggage, parcels, vehicles (valet), and lost items. They can optionally be linked to a reservation if related or an arrival, in-house or departure reservation.OperationId:postTrackItItems
operationId: postTrackItItems parameters: - name: hotelId in: path required: true description: '' 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: - CustomerManagement requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/trackItItems' description: Request object to create Track It items. required: true put: summary: Updates track it items description: Update the details of a Track It Item for a property.OperationId:putTrackItItems
operationId: putTrackItItems parameters: - name: hotelId in: path required: true description: '' 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 object for updating Track It items. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/trackItItems' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CustomerManagement requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/trackItItems' description: Request object to update Track It items. required: true delete: summary: Deletes track it items description: Delete a Track It Item for a property.OperationId:deleteTrackItItems
operationId: deleteTrackItItems parameters: - name: hotelId in: path required: true description: '' schema: type: string maxLength: 2000 minLength: 1 - name: trackItId in: query 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. required: false style: form explode: true schema: type: array items: type: string - name: trackItIdContext 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 - name: trackItIdType in: query description: A reference to the type of object defined by the UniqueID element. 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: - CustomerManagement get: summary: Fetches track it items description: Retrieve a list of all Track It Items for a property.OperationId:getTrackItItems
operationId: getTrackItItems deprecated: true parameters: - name: hotelId in: path required: true description: '' schema: type: string maxLength: 2000 minLength: 1 - name: ticketId in: query required: false description: Complete ticket number of the Track It item. schema: type: string - name: reservationId 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: reservationIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: reservationIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: givenName in: query required: false description: Given name, first name or names. schema: type: string - name: surname in: query required: false 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. schema: type: string - name: trackItGroups in: query description: Group to which the Track It items belong. required: false style: form explode: true schema: type: array items: type: string enum: - Parcel - Valet - Baggage - Lost uniqueItems: true - name: types in: query description: Track It types based on the Track It group. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: locations in: query description: Locations for Track It location. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: actions in: query description: Track It actions based on Track It groups. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: actionStatuses in: query description: Action status of the Track It item(Open, Closed). required: false style: form explode: true schema: type: array items: type: string enum: - Open - Closed uniqueItems: true - name: appUserId 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: appUserIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: appUserIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: assignedStatuses in: query description: Assignment status of the Track It item(Assigned, Unassigned). required: false style: form explode: true schema: type: array items: type: string enum: - Assigned - Unassigned uniqueItems: true - name: room in: query required: false description: Guest's room number if ticket associated with a reservation. schema: type: string - name: followUpDate in: query required: false description: Follow up date for the ticket. schema: type: string format: date - name: createdOn in: query required: false description: Date when the ticket was created. schema: type: string format: date - name: createdByUserId 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: createdByUserIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: createdByUserIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: description in: query required: false description: Description associated with the Track It item. 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 that retrieves Track It items. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/trackItItems' '204': description: TrackItItems 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: - CustomerManagement /hotels/{hotelId}/trackItems/searches: post: summary: Fetches track it items description: Retrieve a list of all Track It Items for a property.OperationId:searchTrackItItems
operationId: searchTrackItItems parameters: - name: hotelId in: path required: true description: '' 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 that retrieves Track It items. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/trackItItems' '204': description: TrackItItems 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: - CustomerManagement requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/searchTrackItItemsRequest' /services/customerManagement/status: get: summary: Operation to ping the customer management service description: 'OperationId:pingCustomerManagementService
' operationId: pingCustomerManagementService 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: pingCustomerManagementService 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: - CustomerManagement components: responses: '406': description: Not acceptable. '414': description: Request URI Too Large '503': description: Service Unavailable '413': description: Request Entity Too Large '500': description: System Error content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '502': description: Bad Gateway '403': description: Forbidden '415': description: Unsupported Media Type '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '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 authKey: name: authorization description: Bearer token that needs to be passed which is generated post user authentication in: header required: true schema: type: string externalData: name: externalData description: Pass this header as true, if payload needs DVM in: header schema: type: string Accept-Language: name: Accept-Language description: Language code in: header 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}$ x-externalsystem: name: x-externalsystem description: External system code. in: header x-example: EXTERNALSYSTEMCODE schema: type: string maxLength: 40 x-originating-application: name: x-originating-application description: Customer's Integration Application Id 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: trackItType: type: object description: Identifies the kind of Parcel, Baggage, or Lost items or Valet-managed vehicles or services. properties: type: $ref: '#/components/schemas/codeDescriptionType' url: $ref: '#/components/schemas/uRLType' 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' trackItItems: type: object description: Response object that retrieves Track It items. properties: trackItItemsInfo: $ref: '#/components/schemas/trackItItemsType' hotelId: $ref: '#/components/schemas/codeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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 reservationIdList: type: array description: Unique Id that references an object uniquely in the system. maxItems: 4000 items: $ref: '#/components/schemas/uniqueID_Type' actionStatusType: type: string description: Action status of the Track It item(Open, Closed). enum: - Open - Closed 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 trackItItemType: type: object description: Detailed information of a Track It item. properties: hotelId: type: string minLength: 0 maxLength: 20 trackItId: $ref: '#/components/schemas/trackItId' group: $ref: '#/components/schemas/trackItGroup' ticketNumber: type: string minLength: 0 maxLength: 80 referenceNumber: type: string minLength: 0 maxLength: 20 type: $ref: '#/components/schemas/trackItType' action: $ref: '#/components/schemas/trackItActionType' location: $ref: '#/components/schemas/codeDescriptionType' quantity: type: integer followUpDate: type: string format: date maxLength: 8 description: type: string minLength: 0 maxLength: 2000 assignedTo: $ref: '#/components/schemas/applicationUserType' reservationInfo: $ref: '#/components/schemas/trackItReservationInfoType' trackItLogList: $ref: '#/components/schemas/trackItLogListType' 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 warningsType: type: array description: Used in conjunction with the Success element to define a business error. maxItems: 4000 items: $ref: '#/components/schemas/warningType' 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 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 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 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 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 trackItActionType: type: object description: Identifies the response expected from staff or other parties relative to a Track It ticket. properties: trackItAction: $ref: '#/components/schemas/codeDescriptionType' status: $ref: '#/components/schemas/actionStatusType' actionStatusEnum: type: string enum: - Open - Closed 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 trackItGroup: type: string description: Group to which the Track It items belong. enum: - Parcel - Valet - Baggage - Lost status: type: object description: Response Body. properties: warnings: $ref: '#/components/schemas/warningsType' links: $ref: '#/components/schemas/links' 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 applicationUserType: type: object properties: hotel: description: Hotel where user belongs. $ref: '#/components/schemas/codeDescriptionType' appUser: type: string minLength: 0 maxLength: 250 lDAPUser: type: string minLength: 0 maxLength: 250 actAs: type: string minLength: 0 maxLength: 20 actAt: type: string minLength: 0 maxLength: 20 userDefaultLanguage: type: string minLength: 0 maxLength: 20 appUserId: $ref: '#/components/schemas/uniqueID_Type' cashierId: type: integer cashierTitle: description: Cashier title. type: string minLength: 0 maxLength: 2000 department: type: string minLength: 0 maxLength: 60 departmentLocation: type: string minLength: 0 maxLength: 60 salesRepCode: type: string minLength: 0 maxLength: 20 expiryDate: type: string format: date maxLength: 8 disabledUntil: type: string format: date maxLength: 8 passwordChangeDate: type: string format: date maxLength: 8 userInfo: $ref: '#/components/schemas/employeeInfoType' userSessionInfo: description: This is only used during log-in. $ref: '#/components/schemas/userSessionInfoType' attendantInfo: $ref: '#/components/schemas/attendantType' resAccompanyGuestListType: type: array description: Collection of accompany guests maxItems: 4000 items: $ref: '#/components/schemas/resAccompanyGuestInfoType' basicEmailType: type: string description: Email address minLength: 0 maxLength: 2000 trackItGroupEnum: type: string enum: - Parcel - Valet - Baggage - Lost userSessionDefaultsType: type: object properties: dbDateFormat: type: string oracleDateFormat: type: string oracleTimeFormat: type: string javaDateFormat: type: string javaTimeFormat: type: string currencyCode: type: string minLength: 0 maxLength: 20 currencyFormat: type: string defaultLanguage: type: string baseLanguage: type: string minLength: 0 maxLength: 20 userSessionInfoType: type: object properties: businessDate: type: string format: date maxLength: 8 systemDate: type: string format: date maxLength: 8 terminal: type: string runningApp: type: string shareProfiles: type: boolean hotel: $ref: '#/components/schemas/codeDescriptionType' cro: $ref: '#/components/schemas/codeDescriptionType' chain: type: string minLength: 0 maxLength: 20 cROCountryCode: type: string minLength: 0 maxLength: 20 sessionDefaults: $ref: '#/components/schemas/userSessionDefaultsType' parameters: $ref: '#/components/schemas/parametersType' 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 trackItId: 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 surnameType: type: string description: Family name, last name. minLength: 0 maxLength: 40 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 trackItLogListType: type: array maxItems: 4000 items: $ref: '#/components/schemas/trackItLogType' trackItReservationInfoType: type: object description: Reservation info associated with a Track It item. properties: reservationIdList: $ref: '#/components/schemas/reservationIdList' timeSpan: $ref: '#/components/schemas/timeSpanType' guestInfo: $ref: '#/components/schemas/resGuestInfoType' roomType: type: string minLength: 0 maxLength: 20 roomId: type: string minLength: 0 maxLength: 20 roomStatus: $ref: '#/components/schemas/housekeepingRoomStatusType' guarantee: $ref: '#/components/schemas/resGuaranteeType' reservationStatus: $ref: '#/components/schemas/pMS_ResStatusType' computedReservationStatus: $ref: '#/components/schemas/pMS_ResStatusType' 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 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 personNameTypeType: type: string description: Person's name in an external system. enum: - Primary - Alternate - Incognito - External - Phonetic 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' 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 searchTrackItItemsRequest: type: object properties: ticketId: type: string description: Complete ticket number of the Track It item. reservationId: type: string 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. reservationIdContext: type: string description: Used to identify the source of the identifier (e.g., IATA, ABTA). reservationIdType: type: string description: A reference to the type of object defined by the UniqueID element. givenName: type: string description: Given name, first name or names. surname: type: string 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. trackItGroups: type: array items: $ref: '#/components/schemas/trackItGroupEnum' uniqueItems: true description: Group to which the Track It items belong. types: type: array maxItems: 4000 items: type: string description: Track It types based on the Track It group. locations: type: array maxItems: 4000 items: type: string description: Locations for Track It location. actions: type: array maxItems: 4000 items: type: string description: Track It actions based on Track It groups. actionStatuses: type: array items: $ref: '#/components/schemas/actionStatusEnum' uniqueItems: true description: Action status of the Track It item(Open, Closed). appUserId: type: string 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. appUserIdContext: type: string description: Used to identify the source of the identifier (e.g., IATA, ABTA). appUserIdType: type: string description: A reference to the type of object defined by the UniqueID element. assignedStatuses: type: array items: $ref: '#/components/schemas/assignedStatusEnum' uniqueItems: true description: Assignment status of the Track It item(Assigned, Unassigned). room: type: string description: Guest's room number if ticket associated with a reservation. followUpDate: type: string format: date description: Follow up date for the ticket. createdOn: type: string format: date description: Date when the ticket was created. createdByUserId: type: string 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. createdByUserIdContext: type: string description: Used to identify the source of the identifier (e.g., IATA, ABTA). createdByUserIdType: type: string description: A reference to the type of object defined by the UniqueID element. description: type: string description: Description associated with the Track It item. phoneNumberType: type: string description: Phone number minLength: 0 maxLength: 40 givenNameType: type: string description: Given name, first name or names minLength: 0 maxLength: 40 attendantType: type: object properties: attendantId: type: string minLength: 0 maxLength: 20 hotelId: type: string minLength: 0 maxLength: 20 parametersType: type: array description: Collection of generic Name-Value-Pair parameters. maxItems: 4000 items: $ref: '#/components/schemas/parameterType' 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 operaVersionNumberType: type: string description: Current Opera Version Number minLength: 0 maxLength: 40 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 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 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 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 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 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 assignedStatusEnum: type: string enum: - Assigned - Unassigned trackItItemsType: type: array description: '' maxItems: 4000 items: $ref: '#/components/schemas/trackItItemType' 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 employeeInfoType: type: object properties: personName: $ref: '#/components/schemas/personNameType' profileId: $ref: '#/components/schemas/uniqueID_Type' addressInfo: $ref: '#/components/schemas/addressInfoType' emailInfo: $ref: '#/components/schemas/emailInfoType' phoneInfo: $ref: '#/components/schemas/telephoneInfoType' department: $ref: '#/components/schemas/codeDescriptionType' 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 anonymizationStatusType: type: string description: Guest has been anonymized. enum: - Requested - Anonymized trackItLogType: type: object description: Individual activity log related to the Track It ticket. properties: hotelId: type: string minLength: 0 maxLength: 20 trackItLogId: $ref: '#/components/schemas/uniqueID_Type' trackItId: $ref: '#/components/schemas/trackItId' type: type: string minLength: 0 maxLength: 20 description: type: string minLength: 0 maxLength: 200 businessDate: type: string format: date maxLength: 8 logUserId: type: integer logUserName: type: string logDate: type: string format: date-time description: Uses the hotel's time zone. profileIdList: type: array description: Unique Id that references an object uniquely in the system. maxItems: 4000 items: $ref: '#/components/schemas/uniqueID_Type' parameterType: type: object description: Name value pair type that will hold generic parameter information. Only use this type when the parameters being passed are too dynamic to be defined. properties: parameterName: description: Name of the parameter. type: string parameterValue: description: Value of the parameter. type: string 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' 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 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 externalDocs: description: Find out more about Oracle Hospitality url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html