The identity and technical contract details declared by the specification.
templateAirportsDetails
object
Response object for fetching template airports.
3 properties
templateAirportsType
array
Template airport details.
templateAirportType
object
Base details of the airport.
10 properties
transportationInfoType
object
Information about the transportation type.
3 properties
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
2 required
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
templateAirportsCriteria
object
Request object for creating new template airports.
3 properties
status
object
Response Body.
2 properties
templateAirportsToBeChanged
object
Request object for modifying template airports.
3 properties
templateAmenitiesDetails
object
Response object for fetching amenities at the template level.
3 properties
configTemplateAmenitiesType
array
This type holds a collection of amenities at the template level.
configTemplateAmenityType
object
Base details used for amenities.
9 properties
amenityTypeType
string
Simple type for storing amenity type.
templateAmenitiesCriteria
object
Request object for creating amenities at the template level.
3 properties
templateAmenitiesToBeChanged
object
Request object for changing amenities at the template level.
3 properties
attractionClassesDetails
object
Response object for fetching Attraction Classes.
3 properties
attractionClassesType
array
List of Attraction Classes.
attractionClassType
object
Contains Common Master configuration detail.
4 properties
translationTextType2000
object
Contains Multiple translated texts and language codes.
2 properties
translationsTextType
array
Language code for the translation.
attractionClassesCriteria
object
Request object for creating Attraction Classes.
3 properties
attractionClassesToBeChanged
object
Request object for changing Attraction Classes.
3 properties
attractionTemplatesDetails
object
Response object for information regarding attraction templates.
3 properties
attractionTemplatesType
array
Collection of attraction templates.
attractionTemplateType
object
Information about the attractions near the hotel.
16 properties
relativePositionType
object
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).
3 properties
addressType
object
Provides address information.
19 properties
countryNameType
object
Code for a country or a nationality.
2 properties
uRLType
object
Web site address, in IETF(The Internet Engineering Task Force) specified format.
5 properties
attractionTemplatesCriteria
object
Request object for creating a new attraction code template.
3 properties
attractionTemplatesToBeChanged
object
Request object for modifying the existing attraction attraction templates.
3 properties
brandCodesDetails
object
Response object for fetching Brand Codes.
3 properties
brandCodesType
array
List of Brand Codes.
brandCodeType
object
Contains Common Master configuration detail.
4 properties
brandCodesCriteria
object
Request object for creating Brand Codes.
3 properties
brandCodesToBeChanged
object
Request object for changing Brand Codes.
3 properties
hotelCalendarDetails
object
Response object for fetching calendar entries for a hotel.
3 properties
hotelCalendarType
object
Represents the calendar with individual days having corresponding entries (day type, event, etc.) for a hotel.
2 properties
hotelCalendarDayType
object
Details of calendar entries for a specific day for a specific hotel.
3 properties
hotelCalendarDayTypeType
object
Details of Day Type.
3 properties
colorType
string
Color configuration type. This color configuration provides a visual category of entities.
hotelCalendarEventsType
array
Details of hotel events
hotelCalendarEventType
object
Details of event.
12 properties
chainDetails
object
Response object for fetching Chain.
5 properties
chainConfigInfoType
array
chainDetailInfoType
object
15 properties
chainToBeChanged
object
Request object for changing Chain.
3 properties
communicationMethodsEntDetailsDetails
object
Response object for fetching Communication Methods Ent Details.
3 properties
communicationMethodsEntDetailsType
array
List of Communication Methods Ent Details.
communicationMethodsEntDetailType
object
Contains Common Master configuration detail.
4 properties
communicationMethodsEntDetailsCriteria
object
Request object for creating Communication Methods Ent Details.
3 properties
communicationMethodsEntDetailsToBeChanged
object
Request object for changing Communication Methods Ent Details.
3 properties
configActivityLogDetails
object
Response object for fetching configuration activity log.
3 properties
activityLogListType
object
7 properties
activityLogType
object
12 properties
createConfigActivityLogCriteria
object
Request object for creating Config Activity Logs.
2 properties
configActivitiesType
array
Changes log record to import/Export/Delete customization operations.
configActivityType
object
Changes log record to import/Export/Delete customization operations.
3 properties
corporateBusinessUnitsDetails
object
Response object for fetching Corporate Business Units.
3 properties
corporateBusinessUnitsType
array
List of Corporate Business Units.
corporateBusinessUnitType
object
Contains Common Master configuration detail.
4 properties
corporateBusinessUnitsCriteria
object
Request object for creating Corporate Business Units.
3 properties
corporateBusinessUnitsToBeChanged
object
Request object for changing Corporate Business Units.
3 properties
corporateDepartmentCodesDetails
object
Response object for fetching Corporate Department Codes.
3 properties
corporateDepartmentCodesType
array
List of Corporate Department Codes.
corporateDepartmentCodeType
object
Contains Common Master configuration detail.
4 properties
corporateDepartmentCodesCriteria
object
Request object for creating Corporate Department Codes.
3 properties
corporateDepartmentCodesToBeChanged
object
Request object for changing Corporate Department Codes.
3 properties
corporateDivisionsDetails
object
Response object for fetching Corporate Divisions.
3 properties
corporateDivisionsType
array
List of Corporate Divisions.
corporateDivisionType
object
Contains Common Master configuration detail.
4 properties
corporateDivisionsCriteria
object
Request object for creating Corporate Divisions.
3 properties
corporateDivisionsToBeChanged
object
Request object for changing Corporate Divisions.
3 properties
corporateOperatingUnitsDetails
object
Response object for fetching Corporate Operating Units.
3 properties
corporateOperatingUnitsType
array
List of Corporate Operating Units.
corporateOperatingUnitType
object
Contains Common Master configuration detail.
4 properties
corporateOperatingUnitsCriteria
object
Request object for creating Corporate Operating Units.
3 properties
corporateOperatingUnitsToBeChanged
object
Request object for changing Corporate Operating Units.
3 properties
templateCountriesDetails
object
Response object for fetching template Countries.
3 properties
templateCountriesType
array
Template of country details.
templateCountryType
object
Base details of the country
14 properties
templateCountriesCriteria
object
Request object for creating new template Countries.
3 properties
countryGuestTypesDetails
object
Response object for fetching Philippines Country Guest Types.
3 properties
countryGuestTypesType
array
List of Philippines Country specific Guest Types.
countryGuestTypeType
object
Contains Common Master configuration detail.
4 properties
countryGuestTypesCriteria
object
Request object for creating Country Guest Types.
3 properties
countryGuestTypesToBeChanged
object
Request object for changing Philippines Country Guest Types.
3 properties
templateCountriesToBeChanged
object
Request object for modifying template Countries.
3 properties
countryMainGroupsDetails
object
Response object for fetching Country Main Groups.
3 properties
countryMainGroupsType
array
List of Country Main Groups.
countryMainGroupType
object
Contains Common Master configuration detail.
4 properties
countryMainGroupsCriteria
object
Request object for creating Country Main Groups.
3 properties
countryMainGroupsToBeChanged
object
Request object for changing Country Main Groups.
3 properties
currencyExchangeRatesDetails
object
Response with the list of currency codes and their exchange rates for each property requested.
3 properties
currencyExchangeRateType
object
Currency code configuration.
5 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
codeType
string
Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
templateDayTypeCodesDetails
object
Response object for fetching template day type codes.
3 properties
templateDayTypeCodesType
array
Details for day type code at template level.
templateDayTypeCodeType
object
Base structure for Day Type Code at both template and hotel levels.
7 properties
templateDayTypeCodesToBeChanged
object
Request object for modifying template day type codes.
3 properties
templateDayTypeCodesCriteria
object
Request object for creating new template day type codes.
3 properties
setDayTypes
object
Request object for setting day type for specified date range.
3 properties
hotelDayTypesType
array
Collection of type details.
hotelDayTypeType
object
Details of Day Type to be used to set day types for a hotel.
3 properties
timeSpanDaysOfWeekType
object
Container for Time span with days of week.
8 properties
timeSpanType
object
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…
3 properties
defaultNoteDetails
object
Response object for fetching Default Application Note text.
3 properties
defaultNoteTextDetailType
object
Default Note Text Information Type.
2 properties
departmentsDetails
object
Response object for fetching departments.
3 properties
departmentsType
array
Collection of departments.
departmentType
object
Type provides department information.
6 properties
translationTextType30
object
Contains Multiple translated texts and language codes.
2 properties
departmentsCriteria
object
Request object for creating new departments.
3 properties
departmentsToBeChanged
object
Request object for updating departments.
3 properties
hotelCategoriesDetails
object
Response object for fetching Hotel Categories.
3 properties
hotelCategoriesType
array
List of Hotel Categories.
hotelCategoryType
object
Contains Common Master configuration detail.
4 properties
hotelCategoriesCriteria
object
Request object for creating Hotel Categories.
3 properties
hotelCategoriesToBeChanged
object
Request object for changing Hotel Categories.
3 properties
templateHotelDetailsDetails
object
Response object for fetching hotel details at the template level.
3 properties
templateHotelDetailsType
array
Collection of template level hotel details.
templateHotelDetailType
object
Base details used for storing information about a hotel detail.
8 properties
templateHotelDetailValuesType
array
Collection of template level hotel detail values.
templateHotelDetailValueType
object
This type holds the base information of the hotel detail value which will be associated with a hotel detail.
3 properties
templateHotelDetailsCriteria
object
Request object for creating hotel details at the template level.
3 properties
templateHotelDetailsToBeChanged
object
Request object for changing hotel details at the template level.
3 properties
copyHotelDetails
object
Request object for copying template hotel details to hotel(s).
3 properties
copyHotelDetailsType
object
Instructions for copying template hotel details to hotel(s).
2 properties
templateHotelDetailsIDType
array
Collection of template level hotel detail identifiers.
templateHotelDetailIDType
object
Base details used for uniquely identifying a hotel detail.
2 properties
hotelsDetails
object
Response object for fetching lists of Property summary information.
3 properties
hotelsSummaryType
array
Lists of Hotel summary information.
hotelSummaryType
object
A brief summary of information about a hotel.
7 properties
hotelDetails
object
Response object for fetching Property configuration information.
4 properties
hotelInfoType
object
Contains the basic configuration information about a Hotel.
22 properties
telephoneType
object
Information on a telephone number for the customer.
12 properties
basicEmailType
string
Email address
hotelRestaurantsType
array
hotelRestaurantType
object
Information about the Restaurants in the hotel.
13 properties
restaurantCategoryType
string
Simple type for Hotel Restaurant.
hotelRateRangesType
array
Lists of rate ranges of the hotel.
hotelRateRangeType
object
The rate rage information of the hotel.
5 properties
alternateHotelsType
array
alternateHotelType
object
28 properties
hotelAmenityType
object
4 properties
rateRoomDetailsType
object
3 properties
membershipSearchType
object
Identifies criteria for searching frequent customer reward program.
4 properties
masterRestrictionStatusesType
string
roomStayType
object
24 properties
uniqueID_Type
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
2 properties
currentRoomInfoType
object
Room information of the reservation for the current day.
7 properties
roomRateType
object
43 properties
totalType
object
The total amount charged for the service including additional amounts and fees.
10 properties
taxesType
object
A collection of taxes.
3 properties
taxType
object
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…
5 properties
amountDeterminationType
string
Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.
feesType
object
A collection of fees or service charges.
3 properties
feeType
object
Applicable service charges or fees.
5 properties
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
ratesType
object
Individual rate amount.
2 properties
amountType
object
Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentage…
10 properties
additionalGuestAmountType
object
2 properties
discountType
object
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 speci…
5 properties
shareDistributionInstructionType
string
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…
rateRangeType
object
Rate Range details like maximum rate amount and minimum rate amount in each available rate category.
2 properties
packageElementType
object
15 properties
reservationProfileType
object
3 properties
profileIdList
array
Unique Id that references an object uniquely in the system.
profileType
object
Type provides the detailed information about the profile and its children.
53 properties
customerType
object
Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
26 properties
personNameType
object
This provides name information for a person.
12 properties
personNameTypeType
string
Person's name in an external system.
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
anonymizationStatusType
string
Guest has been anonymized.
identificationInfoType
object
Information on the identification of the customer.
3 properties
identificationType
object
Identification information of the customer.
10 properties
alienInfoType
object
immigration/visa information of a foreign person.
3 properties
companyInfoType
object
Company Information of the Profile.
3 properties
companyType
object
20 properties
iATAInfoType
object
IATA Information of the profile.
3 properties
imageSetType
object
Represents on image set record.
11 properties
imageStyleType
string
An enumeration of image styles.
addressInfoType
object
Provides address information.
3 properties
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
emailInfoType
object
Information on an email for the customer.
3 properties
emailType
object
Information on an email for the customer.
11 properties
uRLInfoType
object
Web site address.
3 properties
commentInfoType
object
Comment related to the profile/reservation.
8 properties
commentType
object
An indication of a new paragraph for a sub-section of a formatted text message.
19 properties
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 properties
profileDeliveryMethod
object
Delivery Information type to the profile.
7 properties
profileDeliveryModuleType
string
Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..
profileMembershipType
object
Detailed information of the memberships.
41 properties
paragraphType
object
An indication of a new paragraph for a sub-section of a formatted text message.
3 properties
membershipEarningPreferenceType
string
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.
benefitsType
array
Basic information about membership benefit.
benefitType
object
Basic information about membership benefit.
3 properties
tierAdministrationType
string
Do not upgrade membership. The membership may be downgraded.
downgradeType
string
Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace.
cardReIssueType
string
Request to re issue a new card.
preferenceTypeType
object
Preference details for the profile.
13 properties
preferenceType
object
Guest Preference details for the profile.
7 properties
keywordType
object
3 properties
keywordDetailType
object
1 property
negotiatedType
object
This holds a list of NegotiatedInfoType.
3 properties
negotiatedInfoType
object
This provides information for a profile negotiated rate.
6 properties
gdsNegotiatedType
object
This holds a list of GdsNegotiatedInfoType.
4 properties
gdsNegotiatedInfoType
object
This provides information for a channel negotiated rate.
5 properties
indicatorsType
array
Collection of lamp indicators.
indicatorType
object
Lamp indicator Type.
2 properties
relationshipInfoType
object
Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.
8 properties
changeRelationsType
object
Detailed information regarding the changes made to relationships for the profile.
5 properties
relationshipProfileType
object
13 properties
ownerType
object
Generic type for information about an owner.
11 properties
codeDescriptionType
object
This contains a generic code and description information.
2 properties
profileId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
profileTypeType
string
The types of Profile handled by the web service.
masterAccountInfoType
object
2 properties
relationshipInfoSummaryType
object
RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact p…
7 properties
relationshipProfileSummaryType
object
11 properties
relationshipAddressType
object
Provides address information for a Relationship.
5 properties
reservationHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
historyListType
object
A collection of reservation history details attached to Profiles.
4 properties
reservationInfoType
object
The Reservation class contains the current reservation being created or altered.
52 properties
reservationIdList
array
Unique Id that references an object uniquely in the system.
externalReferencesType
array
This type contains unique information of external reference.
externalReferenceType
object
This type contains unique information of external reference.
3 properties
stayInfoType
object
Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaini…
36 properties
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
reservationBlockType
object
Key information about the block for a reservation.
3 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
promotionType
object
Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.
3 properties
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
30 properties
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
namePrefixType
string
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
givenNameType
string
Given name, first name or names
surnameType
string
Family name, last name.
phoneNumberType
string
Phone number
vIPType
object
The supplier's ranking of the customer.
2 properties
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
resAccompanyGuestListType
array
Collection of accompany guests
resAccompanyGuestInfoType
object
5 properties
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
resSharedGuestListType
array
Collection of shared guest reservations.
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
resAttachedProfileListType
array
resAttachedProfileType
object
3 properties
resProfileTypeType
string
reservationPaymentMethodType
object
7 properties
resPaymentCardType
object
Information on a credit card for the customer.
18 properties
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
cardProcessingType
string
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
reservationFolioWindowsType
array
Collection of reservation folio windows.
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 properties
payeeInfoType
object
Payee information.
7 properties
aRAccountShortInfoType
object
Accounts Receivabales Account details type charged for batched posting.
4 properties
aRAccountStatusType
object
Type for the Account Status. Status can be restricted and a message/description added to the Account.
3 properties
housekeepingRoomStatusType
string
Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOf…
searchMatchesType
array
List of Generic Name-Value-Pair Parameters used for super search matches.
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
reservationQueueInformationType
object
Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
6 properties
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
7 properties
facilityTaskType
object
Information regarding facility task on a reservation.
3 properties
housekeepingTaskCodeType
object
Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
7 properties
facilityCodesType
array
List of the facility codes.
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
resCashieringType
object
Cashiering Information for the reservation.
14 properties
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
9 properties
billingPrivilegesType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
13 properties
reservationTaxTypeInfo
object
Provides information about the Tax Type.
9 properties
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 properties
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
4 properties
authorizerInfoType
object
Authorizer Information
5 properties
taxTypeType
object
Provides information about the Tax Type.
8 properties
reservationDepositType
object
Reservation Deposit Type.
7 properties
reservationAllowedActionsType
array
Allowed action.
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
hotelInterfaceType
object
8 properties
hotelInterfaceTypeType
string
XML Posting Interface
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
interfaceRightsStatusType
object
4 properties
reservationTurndownInfoType
object
Turndown information for a reservation
2 properties
turndownStatusType
string
Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Complet…
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
resCommunicationType
object
Communication details for a reservation.
2 properties
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
3 properties
pMS_ResStatusType
string
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.
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
commissionPayoutToType
string
futureListType
object
A collection of reservation history details attached to Profiles.
4 properties
reservationStayHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
stayHistoryListType
object
A collection of reservation history details attached to Profiles.
4 properties
stayReservationInfoType
object
The Reservation class contains the current reservation being created or altered.
6 properties
stayFutureListType
object
A collection of reservation history details attached to Profiles.
4 properties
lastStayInfoType
object
Contains last stay related details for the profile
4 properties
profileAccessType
object
4 properties
profileSharedLevelType
string
Simple types for Shared level.
profileRestrictions
object
3 properties
mailingActionsType
object
Defines mailing action list for the profile.
5 properties
privacyInfoType
object
Defines Privacy related information for the profile.
14 properties
profileCashieringType
object
Contains cashiering related details for the profile
14 properties
directBillingType
object
This is the preconfigured routing instruction type.
2 properties
profileCommissionType
object
This is the preconfigured routing instruction type.
7 properties
commissionPaymentMethods
string
Check
userDefinedFieldsType
object
A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc.
3 properties
characterUDFsType
array
Used to hold collection of user defined fields of Character/String Type.
characterUDFType
object
Used to hold user defined field of Character/String Type.
3 properties
numericUDFsType
array
Used to hold collection of user defined fields of Numeric Type.
numericUDFType
object
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 Rese…
3 properties
dateUDFsType
array
Used to hold collection of user defined fields of Date Type.
dateUDFType
object
Used to hold user defined field of Date Type.
3 properties
webUserAccountsType
array
Web User Accounts List.
webUserAccountType
object
Web User Account of the guest.
11 properties
webUserHistoryType
object
Creation date time, Creator Id, last modification date time and last Modifier Id.
8 properties
profileTaxInfoType
object
Profile information related to tax.
7 properties
salesInfoType
object
Provides sales information about the profiles of type company, travel agent, source and contact.
13 properties
eCertificatesType
array
List of e-certificates for the profile.
eCertificateType
object
E-Certificates details.
23 properties
eCertificateInfoType
object
E-Certificates details.
14 properties
eCertificateScopeType
string
Indicates that OPERA E-Certificate is available for a specific list of hotels.
eCertificateUsageCriteriaType
object
E-Certificates details.
8 properties
eCertificateConsumptionType
object
E-Certificates details.
13 properties
eCertificateConsumeSourceType
string
Indicates that OPERA E-Certificate is consumed by hotelPMS.
eCertificateStatusType
string
Indicates that OPERA E-Certificate is reserved.
awardId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
eCertificateIssueSourceType
string
Indicates that OPERA E-Certificate is issued by external system.
eCertificateIssueType
string
Indicates that guest purchased OPERA E-Certificate.
eCertificateGenerationType
object
E-Certificates details.
3 properties
profileSubscriptionListType
array
Details of the OPERA Profile subscription to external system
profileSubscriptionType
object
Contains details of the profile subscription. The subscription represents the link between the OPERA profile and the external profile within a particular exter…
11 properties
guestCountsType
object
A collection of GuestCount by age group.
4 properties
childAgesType
array
Age of a child in years.
childAgeType
object
Defines Child's Age.
1 property
childBucketsType
object
Defines children counts with Age Qualifying Group(Child Bucket) classification.
5 properties
resAwardsType
object
Membership Awards code applied on the reservation.
4 properties
awardVouchersType
array
This stores the Membership Awards code applied on the reservation.
foreignExchangeType
object
Foreign Exchange info.
2 properties
mealPlansType
array
Meal plan codes associated with the rate codes.
mealPlanCodeType
object
Meal plan codes associated with the rate codes.
5 properties
roomRateAvailReasonType
string
Indicates the Room Rate is not available due to unavailability of enough items for the rate code.
upsellInfoType
object
Information regarding upsell for a reservation.
2 properties
primaryShareTypeType
string
channelSummaryInfoType
object
Depicts channel information such as the type and code.
3 properties
bookingChannelType
object
3 properties
sellMessagesType
object
The SellMessagesType is the list of message and attributes returned by web service.
4 properties
sellMessageType
object
The SellMessagesType defines the standard attributes that will be retrieved with the sell message.
16 properties
usedInModuleType
string
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 Di…
currencyExchangeRatesType
array
Exchange Rate information for a currency code.
hotelContactsType
array
Lists of contacts of the hotel.
hotelContactType
object
Contact identification details.
8 properties
hotelContactRolesType
array
Lists of HotelContactRoles of the hotel.
hotelContactRoleType
string
The contact's role in the hotel. Possible values are Lead, General, and Contract.
hotelEventSpacesType
object
The Detail and Summary info of event space about the hotel
3 properties
hotelEventSpaceDetailsType
array
List of detail info of hotel event space
hotelEventSpaceDetailType
object
The detail info of hotel event space
4 properties
eventSpaceMaxOccupanciesType
array
List of event space max occupancy.
hotelEventSpaceSummariesType
array
List of summary info of hotel event space
hotelEventSpaceSummaryType
object
The summary info of hotel event space
4 properties
hotelSetupStylesType
array
List of event space setup style codes.
hotelNotesType
array
List of Notes of the hotel.
hotelCorporateInformationsType
object
Corporate information details of the property
6 properties
primaryCodesType
array
List of codes with primary flag
primaryCodeType
object
Primary flag with code and description.
2 properties
hotelAttractionsType
array
hotelAttractionType
object
Information about the attractions near the hotel.
11 properties
meetingRoomsType
array
List of meeting rooms of the hotel.
meetingRoomType
object
Information about the meeting rooms of the hotel.
3 properties
masterInfoType
object
2 properties
codeInfoType
object
4 properties
addtionalCodeInfoType
array
Holds name of additional code information
masterInfoCodeDetailType
string
airportsDetails
object
Response object for fetching airports configured for hotels.
9 properties
airportsType
array
Airport details for a hotel.
airportType
object
Base details of the airport.
11 properties
airportsCriteria
object
Request object for creating new airports for hotels.
3 properties
airportsToBeChanged
object
Request object for modifying airports for hotels.
3 properties
alternateHotelsCriteria
object
Request object for creating new Alternate Hotels for hotels.
3 properties
alternateHotelsToBeChanged
object
Request object for changing hotel Alternate Hotels for hotels.
3 properties
amenitiesDetails
object
Response object for fetching amenities at the property level.
3 properties
configHotelAmenitiesType
array
This type holds a collection of amenities at the property level.
configHotelAmenityType
object
Base details used for amenities.
13 properties
amenitiesCriteria
object
Request object for creating amenities at the property level.
3 properties
amenitiesToBeChanged
object
Request object for changing amenities at the property level.
3 properties
attractionsDetails
object
Response object for information regarding attraction.
3 properties
attractionCodesType
array
Collection of hotel level alert codes with attached alert types.
attractionCodeType
object
Information about the attractions near the hotel.
17 properties
attractionsCriteria
object
Request object for creating a new group of attractions.
3 properties
attractionsToBeChanged
object
Request object for modifying an existing attraction.
3 properties
hotelContactsCriteria
object
Request object for creating new Contacts for hotels.
3 properties
hotelContactsToBeChanged
object
Request object for changing hotel Contacts for hotels.
3 properties
countriesDetails
object
Response object for fetching Countries.
9 properties
countriesType
array
Country details.
countryType
object
Base details of the country.
15 properties
countriesToBeChanged
object
Request object for modifying Countries for hotels.
3 properties
creditCardTypesDetails
object
Response object for fetching Credit Card Types.
3 properties
creditCardTypesType
array
List of Credit Card Types.
creditCardTypeType
object
Contains Common Master configuration detail.
5 properties
creditCardTypesToBeChanged
object
Request object for changing Credit Card Types.
3 properties
creditCardTypesCriteria
object
Request object for creating Credit Card Types.
3 properties
hotelDayTypeCodesDetails
object
Response object for fetching day type codes for a hotel.
3 properties
hotelDayTypeCodesType
array
Details for day type code at hotel level.
hotelDayTypeCodeType
object
Base structure for Day Type Code at both template and hotel levels.
8 properties
hotelDayTypeCodesToBeChanged
object
Request object for modifying day type codes for a hotel.
3 properties
hotelDayTypeCodesCriteria
object
Request object for creating new day type codes for a hotel.
3 properties
setHotelEvents
object
Request object for setting hotel events for specified date range.
3 properties
hotelEventCodesType
array
Collection of hotel events.
hotelEventCodeType
object
Details of Event to be used to set events for a hotel.
12 properties
hotelBrochureDetails
object
Response object for fetching Basic Property information.
3 properties
hotelBrochureType
object
Contains the basic configuration information about a Hotel.
32 properties
hotelPackageType
object
Information about the packages of the hotel.
7 properties
hotelTransportationsType
array
hotelTransportationType
object
Information about the transportations of the hotel.
11 properties
hotelConferenceFacilitiesType
object
2 properties
hotelBanquetSpaceType
object
Defines the Banquet and Meeting Area of the Hotel
5 properties
hotelConferenceRoomsType
array
hotelConferenceRoomType
object
Information about the Conference rooms in the hotel.
3 properties
hotelFeaturesType
array
Collection of Features in the Hotel
hotelFeatureType
object
Base details used for amenities.
6 properties
directionsType
array
Collection of direction details to get into Hotel.
directionType
object
Direction details to get into Hotel.
2 properties
generalNotesType
array
Collection of general notes about the Hotel.
generalNoteType
object
General note/information about the Hotel.
2 properties
hotelAirportsType
array
Collection of Airport details of the Hotel
hotelAirportType
object
Airport details of the Hotel
6 properties
transportationCodeListType
array
List of available transportations from airport to get into Hotel.
transportationCodeType
object
Transportation Code available from Airport to the Hotel.
1 property
hotelUserDefinedFieldsType
array
hotelUserDefinedFieldType
object
User defined information(UDF) for the hotel.
3 properties
hotelDetailsDetails
object
Response object for fetching hotel details at the property level.
3 properties
hotelDetailsType
array
Collection of property level hotel details.
hotelDetailType
object
Base details used for storing information about a hotel detail.
9 properties
hotelDetailValuesType
array
Collection of property level hotel detail values.
hotelDetailValueType
object
This type holds the base information of the hotel detail value which will be associated with a hotel detail.
4 properties
jobTitlesDetails
object
Response object for fetching job titles configured for hotels.
3 properties
jobTitlesType
array
Job Title details for a hotel.
jobTitleType
object
Base details common between both template and hotel job titles.
5 properties
translationTextType80
object
Contains Multiple translated texts and language codes.
2 properties
jobTitlesCriteria
object
Request object for creating new job titles for hotels.
3 properties
jobTitlesToBeChanged
object
Request object for modifying job titles for hotels.
3 properties
marketingCitiesDetails
object
Response object for fetching marketing cities configured for hotels.
9 properties
marketingCitiesType
array
Marketing city details for a hotel.
marketingCityConfigType
object
Base details of the marketing city.
11 properties
marketingCitiesCriteria
object
Request object for creating new marketing cities for hotels.
3 properties
marketingCitiesToBeChanged
object
Request object for modifying marketing cities for hotels.
3 properties
hotelNotesCriteria
object
Request object for creating new Notes for the hotels
3 properties
hotelNotesToBeChanged
object
Request object for changing hotel Notes for hotels.
3 properties
operaHotelContextDetails
object
The result element returned with general hotel contextual information.
3 properties
hotelRateRangesCriteria
object
Request object for creating new Rate Ranges for hotels.
3 properties
hotelRateRangesToBeChanged
object
Request object for changing hotel Rate Ranges for hotels.
3 properties
hotelRestaurantsCriteria
object
Request object for creating new restaurants for hotels.
3 properties
hotelRestaurantsToBeChanged
object
Request object for changing hotel restaurants for hotels.
3 properties
telephoneBookCategoriesDetails
object
Response object for fetch Telephone Categories.
3 properties
telephoneCategoriesType
array
This type holds collection of Telephone Categories with complete information.
telephoneCategoryType
object
This type definition of Telephone Category Type.
6 properties
telephoneBookCategoriesCriteria
object
Request object for Telephone Book Category.
3 properties
telephoneBookCategoriesToBeChanged
object
Request object for Telephone Book Category.
3 properties
telephoneBookEntriesDetails
object
Response object for fetch Telephone Book Entries.
3 properties
telephoneBookEntriesType
array
This type holds collection of Telephone Book Entries with complete information.
telephoneBookEntryType
object
This type definition of Telephone Book Entry Type.
10 properties
telephoneBookEntriesCriteria
object
Request object for Telephone Book Entries.
3 properties
telephoneBookEntriesToBeChanged
object
Request object for Telephone Book Entries.
3 properties
transportationDetails
object
Response object for information regarding transportation.
3 properties
transportationListType
array
Collection of hotel level transportation.
transportationType
object
Information about the transportations of the hotel.
12 properties
transportationCriteria
object
Request object for creating transportation.
3 properties
transportationToBeChanged
object
Request object for modifying transportation.
3 properties
yieldAdjustmentCodesDetails
object
Response object for fetching Yield AdjustmentCodes configurations.
3 properties
yieldAdjustmentCodesType
array
Holds Yield AdjustmentCodes details.
yieldAdjustmentCodeType
object
Provides information about the Adjustment Codes.
7 properties
yieldAdjustmentTypeType
string
Defines values for Yield Adjustment Types.
yieldAdjustmentCodesCriteria
object
Request object for creating new Yield AdjustmentCodes Configurations.
3 properties
yieldAdjustmentCodesToBeChanged
object
Request object for changing existing Yield AdjustmentCodes Configurations.
3 properties
yieldCategoriesDetails
object
Response object for fetching Yield Category configurations.
3 properties
yieldCategoriesType
array
Holds Yield Category details.
yieldCategoryType
object
Provides information about the Yield Category.
4 properties
yieldCategoriesCriteria
object
Request object for creating new Yield Category Configurations.
5 properties
yieldCategoriesToBeChanged
object
Request object for changing existing Yield Category Configurations.
5 properties
copyDepartments
object
3 properties
copyConfigurationCodeType
object
Information needed to copy configuration code from one property to the other.
3 properties
copyYieldAdjustmentCodes
object
3 properties
copyYieldCategories
object
3 properties
templateJobTitlesDetails
object
Response object for fetching template job titles.
3 properties
templateJobTitlesType
array
Template job title details.
templateJobTitleType
object
Base details common between both template and hotel job titles.
4 properties
templateJobTitlesCriteria
object
Request object for creating new template job titles.
3 properties
templateJobTitlesToBeChanged
object
Request object for modifying template job titles.
3 properties
languagesDetails
object
Response object for fetching languages.
3 properties
configLanguagesType
array
This type holds a collection of languages.
configLanguageType
object
This gives detailed information about a language.
8 properties
translationTextType50
object
Contains Multiple translated texts and language codes.
2 properties
languagesCriteria
object
Request object for creating new language records.
3 properties
languagesToBeChanged
object
Request object for changing details of existing language records.
3 properties
templateMarketingCitiesDetails
object
Response object for fetching template marketing cities.
3 properties
templateMarketingCitiesType
array
Template marketing city details.
templateMarketingCityConfigType
object
Base details of the marketing city.
11 properties
templateMarketingCitiesCriteria
object
Request object for creating new template marketing cities.
3 properties
copyMarketingCities
object
Request object for copying template marketing cities to hotel(s).
3 properties
copyMarketingCitiesType
object
Copy instructions for template marketing cities to hotel(s).
2 properties
templateMarketingCityInfoType
object
Template marketing city details.
2 properties
templateMarketingCitiesToBeChanged
object
Request object for modifying template marketing cities.
3 properties
marketingCitiesByRegionDetails
object
3 properties
regionsType
array
List of Regions.
regionType
object
3 properties
marketingCityType
object
3 properties
cityHotelInfoType
object
2 properties
marketingRegionsDetails
object
Response object for fetching Marketing Regions.
3 properties
marketingRegionsType
array
List of Marketing Regions.
marketingRegionType
object
Contains Common Master configuration detail.
4 properties
marketingRegionsCriteria
object
Request object for creating Marketing Regions.
3 properties
marketingRegionsToBeChanged
object
Request object for changing Marketing Regions.
3 properties
noteTypesDetails
object
Response object for fetching Note Types of specific Notes Group.
3 properties
noteTypesType
array
Note Types Collection element.
noteTypeType
object
Note Types Information Type.
16 properties
genericHotelCodeCodeListType
array
List of HotelCode and Code combinations.
genericHotelCodeCodeType
object
Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request.
2 properties
defaultNoteTextsDetailType
array
Collection of individual Default Note Text details.
noteTypesCriteria
object
Request object for creating new Note Types.
3 properties
noteTypesToBeChanged
object
Request object for changing existing Note Types.
4 properties
operaParametersDetails
object
The result element containing a collection of the requested application parameters.
3 properties
applicationSettingSimpleType
object
Internal settings that is mainly used to get a quick information on the type.
5 properties
applicationSettingLevelType
string
propertyDetailCategoriesDetails
object
Response object for fetching Property Detail Categories.
3 properties
propertyDetailCategoriesType
array
List of Property Detail Categories.
propertyDetailCategoryType
object
Contains Common Master configuration detail.
4 properties
propertyDetailCategoriesCriteria
object
Request object for creating Property Detail Categories.
3 properties
propertyDetailCategoriesToBeChanged
object
Request object for changing Property Detail Categories.
3 properties
propertyTypesDetails
object
Response object for fetching Property Types.
3 properties
propertyTypesType
array
List of Property Types.
propertyTypeType
object
Contains Common Master configuration detail.
4 properties
propertyTypesCriteria
object
Request object for creating Property Types.
3 properties
propertyTypesToBeChanged
object
Request object for changing Property Types.
3 properties
regionsCodeDetails
object
Response object for fetching Regions Code.
3 properties
regionsCodeType
array
List of Regions Code.
regionCodeType
object
Contains Common Master configuration detail.
4 properties
regionsCodeCriteria
object
Request object for creating Regions Code.
3 properties
regionsCodeToBeChanged
object
Request object for changing Regions Code.
3 properties
roomAmenitiesDetails
object
Response object for fetching Room Amenities.
3 properties
roomAmenitiesType
array
List of Room Amenities.
roomAmenityType
object
Contains Common Master configuration detail.
4 properties
roomAmenitiesCriteria
object
Request object for creating Room Amenities.
3 properties
roomAmenitiesToBeChanged
object
Request object for changing Room Amenities.
3 properties
operaSettingsDetails
object
The result element containing the requested application settings.
4 properties
applicationSettingGroupType
object
This element simply groups the different Application Functions.
3 properties
applicationSettingType
object
Internal settings that can be of a certain valueType.
17 properties
applicationSettingTypeType
string
applicationSettingConversionType
string
baseApplicationSettingType
object
Internal settings that can be of a certain valueType.
14 properties
templateCodesDetails
object
Response object for fetching Template Codes.
3 properties
templateCodesType
array
List of Template Codes.
templateCodeType
object
Contains Common Master configuration detail.
5 properties
templateCodesCriteria
object
Request object for creating Template Codes.
3 properties
copyTemplateCodes
object
5 properties
copyTemplateType
string
Template name for template copy operation. Eg: RateCategory
hotelCodeListType
array
Hotel code.
templateCodesToBeChanged
object
Request object for changing Template Codes.
3 properties
transportationTemplatesDetails
object
Response object for fetching transportation templates.
3 properties
transportationTemplatesType
array
Collection of transportation templates.
transportationTemplatesCriteria
object
Request object for creating transportation templates.
3 properties
transportationTemplatesToBeChanged
object
Request object for modifying transportation templates.
3 properties
userDefinedFieldGroupsDetails
object
Response object for fetching User Defined Field Groups.
3 properties
userDefinedFieldGroupsType
array
A recurring element that identifies the User Defined Field Group.
userDefinedFieldGroupType
object
Information representation of User Defined Field Group.
6 properties
userDefinedFieldGroupDataType
string
Simple type used for User Defined Field Group Data Type.
userDefinedFieldGroupsCriteria
object
Request object for creating User Defined Field Groups.
3 properties
userDefinedFieldGroupsToBeChanged
object
Request object for changing User Defined Field Groups.
3 properties
userDefinedFieldValuesDetails
object
Response object for fetching User Defined Field Values.
3 properties
userDefinedFieldValuesType
array
A recurring element that identifies the User Defined Field Value.
userDefinedFieldValueType
object
Contains Common Master configuration detail.
5 properties
userDefinedFieldValuesCriteria
object
Request object for creating User Defined Field Values.
3 properties
userDefinedFieldValuesToBeChanged
object
Request object for changing User Defined Field Values.
3 properties
yieldMarketTypesDetails
object
Response object for fetching Yield Market Types.
3 properties
yieldMarketTypesType
array
List of Yield Market Type to be configured or fetched
yieldMarketTypeType
object
Details for Yield Market Type.
6 properties
yieldMarketTypesCriteria
object
Request object for creating new Yield Market Types.
7 properties
yieldMarketTypesToBeChanged
object
Request object for changing existing Yield Market Types.
7 properties
flexFieldCriteria
object
Request object for flex fields.
3 properties
flexFieldsResponse
object
Response object for flex fields.
9 properties
flexFieldType
object
Provides the details of a flex field
13 properties
flexFieldModuleType
string
Flex field module type.
hotelToBeChanged
object
Request object for changing Property general information.
3 properties
centralConfigsResponse
object
3 properties
centralConfigRequest
object
3 properties
centralConfig
object
Type that holds Central Config
3 properties
operationResponse
object
3 properties
operation
object
Type that holds Operation values
2 properties
managedByOptions
string
Describes of the Configuration is Managed by Enterprise or Property.
operaVersionNumberType
string
Current Opera Version Number
operaVersion
object
Response for Ping operation.
3 properties
operaAppUrlResponse
object
3 properties
applicationUrl
object
Type that consists of url type and url value
2 properties
iframeDomain
object
Details associated with the iframe domain.
3 properties
iframeDomainsDetails
object
3 properties
iframeDomainslistDetails
object
3 properties
hotelDetailDataType
string
Simple type used for hotel details code field data type.
webLinkDetails
object
2 properties
searchTelephoneBookEntriesRequest
object
2 properties
deleteTransportationRequest
object
25 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle Hospitality publishes across the network.