How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle Hospitality Profile API

The Profile APIs allow you to view, create, update, and delete profiles in OPERA Cloud. Each time a new profile in created in OPERA Cloud, a profileID is assigned. Use this profileID to retrieve and update details relating to that profile. The resource 'Companies' includes group, source, company and travel agent profile types. The resource 'Guests' includes individual and contact profile types.

Oracle Hospitality Profile API is one of 154 APIs that Oracle Hospitality publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Profile. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 110 operations across 86 paths, and defines 506 schemas. It is described by OpenAPI 3.2.0, at version 26.2.0.0.

Requests are made against a single base URL, /crm/v1.

110 operations 86 paths 506 schemas 14 DELETE51 GET23 POST22 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
26.2.0.0
Server
/crm/v1
License
Terms of Service
Resource Areas
1

Paths & Operations 110

Across 86 paths, the API surfaces 110 operations — 14 DELETE, 51 GET, 23 POST, 22 PUT. Each is listed below with its method, path, parameters, and response codes.

Profile 110

The Profile APIs allow you to view, create, update, and delete profiles in OPERA Cloud. Each time a new profile in created in OPERA Cloud, a profileID is assigned. Use this profil…

POST
/externalSystems/{extSystemCode}/memberships/{membershipType}/membershipIDs
Generate membership number
postMembershipNumber 9 params body → 201400401403404405406413
GET
/address
Get city states
getAddress 14 params → 200204400401403404405406
DELETE
/certificatesdeprecated
Delete certificate
deleteCertificate 8 params → 200400401403404405406413
POST
/companies
This API facilitates creation of a company/agent/group/source profile in OPERA.
postCompanyProfile 8 params body → 201400401403404405406413
GET
/companies/{corporateID}
Get company profile by corporate ID
getCompanyProfile 10 params → 200204400401403404405406
GET
/duplicateExternalSubscriptions
Get profiles with duplicate external subscriptions
getDuplicateExternalSubscriptions 14 params → 200204400401403404405406
GET
/duplicateOPERASubscriptions
Get profiles with duplicate OPERA Cloud subscriptions
getDuplicateOPERASubscriptions 14 params → 200204400401403404405406
GET
/ecertificates
Get e-certificate
getECertificates 19 params → 200204400401403404405406
POST
/ecertificates
Create e-certificate
postECertificate 8 params body → 201400401403404405406413
DELETE
/ecertificates/{certificateId}
Delete e-certificate
deleteECertificate 9 params → 200400401403404405406413
PUT
/ecertificates/{certificateId}
Consume an E-Certificate
consumeECertificate 9 params body → 200400401403404405406413
PUT
/ecertificates/{certificateId}/action/validate
Verify E-Certificate Number
verifyECertificate 9 params body → 200400401403404405406413
POST
/ecertificates/{certificateId}/extensions
Extend E-Certificate Expiry date
extendECertificate 9 params body → 201400401403404405406413
GET
/externalSystems/{extSystemCode}/profiles/{profileExternalId}
Get profile by external ID
getProfileByExtId 17 params → 200204400401403404405406
PUT
/externalSystems/{extSystemCode}/profiles/{profileExternalId}
Update by external ID
putProfileByExtId 10 params body → 200400401403404405406413
POST
/guests
Create a guest, contact or employee profile in OPERA
postGuestProfile 8 params body → 201400401403404405406413
GET
/guests/{guestId}
Get guest profile by guest ID
getGuestProfile 11 params → 200204400401403404405406
PUT
/hotels/{hotelId}/profiles/{profileId}/commissionAccount
Copy profile commission account
copyProfileCommissionAccount 10 params body → 200400401403404405406413
DELETE
/hotels/{hotelId}/profiles/{profileId}/flexFieldCode/{flexFieldCode}
Operation to delete a flex field.
deleteProfileFlexFieldValue 11 params → 200400401403404405406413
GET
/hotels/{hotelId}/profiles/{profileId}/flexFieldValues
Operation to fetch flex field values.
getProfileFlexFieldValue 15 params → 200204400401403404405406
POST
/hotels/{hotelId}/profiles/{profileId}/flexFieldValues
Operation to create a flex field with value for a module.
postProfileFlexFieldValue 10 params body → 201400401403404405406413
PUT
/hotels/{hotelId}/profiles/{profileId}/flexFieldValues
Operation to update flex field value.
putProfileFlexFieldValue 10 params body → 200400401403404405406413
PUT
/hotels/{hotelId}/profiles/{profileId}/reprocess
Re-Process a single Stage Record
reProcessStageRecord 10 params → 200400401403404405406413
GET
/membershipTierProjections
Get Membership Tier Projection
getMembershipTierProjections 15 params → 200204400401403404405406
GET
/memberships/{membershipId}/fullfillmentExportLogsdeprecated
Get Fulfillment Export Logs
getFulfillmentExportLogs 13 params → 200204400401403404405406
POST
/memberships/{membershipType}/membershipNumbers
Generate membership number
postMembershipNumber 9 params body → 201400401403404405406413
PUT
/processStagedProfile
Process a staged profile
processStagedProfile 8 params body → 200400401403404405406413
GET
/profileMatchdeprecated
Fetch the profile Id if a unique guest profile Exists
getProfileMatch 18 params → 200204400401403404405406
POST
/profileMatch/searches
Fetch the profile Id if a unique guest profile Exists
searchProfileMatch 8 params body → 200204400401403404405406
GET
/profileTransactions/{profileId}
Get Profile Transactions
getProfileTransactions 17 params → 200204400401403404405406
GET
/profilesdeprecated
Search for profile(s)
getProfiles 65 params → 200204400401403404405406
POST
/profiles
Create a profile
postProfile 8 params body → 201400401403404405406413
GET
/profiles/action/validate
Validate and check profiles
checkProfileType 12 params → 200204400401403404405406
GET
/profiles/activityLog
Fetch profile activity log
getProfileActivityLog 21 params → 200204400401403404405406
GET
/profiles/profileMatchesdeprecated
Get potential profile matches
getProfileMatches 20 params → 200204400401403404405406
POST
/profiles/profileMatches/searches
Get potential profile matches
searchProfileMatches 8 params body → 200204400401403404405406
POST
/profiles/searches
Search for profile(s)
searchProfiles 8 params body → 200204400401403404405406
GET
/profiles/stageProfileMatches
Get potential stage profile matches
getStagedProfileMatches 8 params → 200204400401403404405406
GET
/profiles/{profileId}
Get profile by ID
getProfile 18 params → 200204400401403404405406
PUT
/profiles/{profileId}
Update a profile by ID
putProfile 9 params body → 200400401403404405406413
DELETE
/profiles/{profileId}
Forget or delete a profile by ID
deleteProfile 9 params → 200400401403404405406413
GET
/profiles/{profileId}/accounts
Get profile accounts
getProfileAccounts 12 params → 200204400401403404405406
GET
/profiles/{profileId}/attachments
Get profile attachments
getProfileAttachments 13 params → 200204400401403404405406
DELETE
/profiles/{profileId}/attachments/{attachmentId}
Delete profile attachment
deleteProfileAttachment 16 params → 200400401403404405406413
GET
/profiles/{profileId}/awardsAndCertificates
Get Profile awards and certificates
getAwards 12 params → 200204400401403404405406
GET
/profiles/{profileId}/cashieringDetails
Get cashiering details for a profile
getCashieringDetails 14 params → 200204400401403404405406
PUT
/profiles/{profileId}/cashieringDetails
Change cashiering details for a profile
changeProfileCashieringDetails 9 params body → 200400401403404405406413
GET
/profiles/{profileId}/commissionAccount
Get commission account on a profile
getProfileCommissionAccount 10 params → 200204400401403404405406
DELETE
/profiles/{profileId}/commissionAccount
Delete a commission account from a profile
deleteProfileCommissionAccount 20 params → 200400401403404405406413
POST
/profiles/{profileId}/commissionAccount
Add a commission account on a profile
postProfileCommissionAccount 9 params body → 201400401403404405406413
PUT
/profiles/{profileId}/commissionAccount
Set profile commission account
setProfileCommissionAccount 9 params body → 200400401403404405406413
POST
/profiles/{profileId}/emails
Create an Email.
storeEmail 9 params body → 201400401403404405406413
GET
/profiles/{profileId}/flexFieldValues
Operation to fetch flex field values.
getAllProfileFlexFieldValues 15 params → 200204400401403404405406
GET
/profiles/{profileId}/hotels/{hotelId}/forecasts
Fetch Account Forecasts by hotel
getAccountForecasts 13 params → 200204400401403404405406
POST
/profiles/{profileId}/hotels/{hotelId}/forecasts
Create account forecast in a hotel
postAccountForecast 10 params body → 201400401403404405406413
DELETE
/profiles/{profileId}/hotels/{hotelId}/forecasts
Delete multiple account forecasts
deleteMultipleAccountForecasts 11 params → 200400401403404405406413
PUT
/profiles/{profileId}/hotels/{hotelId}/forecasts/periodCodes/{periodCode}
Update account forecast in a hotel by period code
putAccountForecast 11 params body → 200400401403404405406413
DELETE
/profiles/{profileId}/hotels/{hotelId}/forecasts/periodCodes/{periodCode}
Delete account forecast in a hotel by period code
deleteAccountForecast 12 params → 200400401403404405406413
DELETE
/profiles/{profileId}/hotels/{hotelId}/preferenceType/{preferenceType}/preferences/{preferenceCode}
Delete a preference from a profile
deletePreference 13 params → 200400401403404405406413
DELETE
/profiles/{profileId}/hotels/{hotelId}/stagedProfile
Delete a staged profile
deleteStagedProfile 10 params → 200400401403404405406413
GET
/profiles/{profileId}/links
Get linked profiles
getLinkedProfiles 33 params → 200204400401403404405406
GET
/profiles/{profileId}/matches
Get profile matches
getMatchProfiles 12 params → 200204400401403404405406
PUT
/profiles/{profileId}/membershipType/{membershipType}/membershipId/{membershipId}
Change membership information on a profile
changeMembership 11 params body → 200400401403404405406413
DELETE
/profiles/{profileId}/membershipType/{membershipType}/membershipId/{membershipId}
Delete membership information from a profile
deleteMembership 11 params → 200400401403404405406413
POST
/profiles/{profileId}/memberships
Create membership on a profile
postMembership 9 params body → 201400401403404405406413
GET
/profiles/{profileId}/owners
Get profile owners
getProfileOwners 12 params → 200204400401403404405406
PUT
/profiles/{profileId}/owners
Change profile owners
changeProfileOwners 9 params body → 200400401403404405406413
POST
/profiles/{profileId}/owners
Assign profile owners
postProfileOwners 9 params body → 201400401403404405406413
DELETE
/profiles/{profileId}/preferenceType/{preferenceType}/preferences/{preferenceCode}
Delete a global preference from a profile
deleteGlobalPreference 12 params → 200400401403404405406413
GET
/profiles/{profileId}/preferences
Get preferences on a profile
getPreferenceForProfile 14 params → 200204400401403404405406
PUT
/profiles/{profileId}/preferences
Distribute preferences on a profile
distributePreference 9 params body → 200400401403404405406413
POST
/profiles/{profileId}/preferences
Add preferences to a profile
postPreference 9 params body → 201400401403404405406413
GET
/profiles/{profileId}/relationships
FetchProfileRelationships method provides the ability to retrieve a profile relationships for a profile based on the unique internal profile ID specified.
getProfileRelationships 10 params → 200204400401403404405406
PUT
/profiles/{profileId}/reservations/action/validate
Check future past bookings
validateReservationsForProfile 9 params body → 200400401403404405406413
GET
/profiles/{profileId}/stayHistory
FetchStayHistory method provides stay history and future reservations of a profile based on the unique internal ID specified.
getStayHistory 14 params → 200204400401403404405406
POST
/profiles/{sourceProfileId}/relationships/{targetProfileId}
CreateProfileRelationship method provides the ability to create profile relationship based on the request criteria of SourceProfileID,TargetProfileID and SourceRelationType specified.
postProfileRelationship 10 params body → 201400401403404405406413
PUT
/profiles/{sourceProfileId}/relationships/{targetProfileId}
ChangeProfileRelationship method provides the ability to update(delete and add) profile relationship based on the request criteria of SourceProfileID , TargetProfileID, To Be ChangedProfileID and Sou…
putProfileRelationship 10 params body → 200400401403404405406413
DELETE
/profiles/{sourceProfileId}/relationships/{targetProfileId}
DeleteProfileRelationship method provides the ability to delete profile relationship based on the request criteria of SourceProfileID,TargetProfileID and SourceRelationType specified.
removeProfileRelationship 15 params → 200400401403404405406413
POST
/profiles/{survivorProfileId}/merges
Merge two profiles by ID
mergeProfiles 9 params body → 201400401403404405406413
GET
/profiles/{survivorProfileId}/merges/snapshot
Get merge profiles snapshot
getMergeProfilesSnapshot 21 params → 200204400401403404405406
GET
/profiles/{survivorProfileId}/stageProfiles/snapshot
Get merge stage profile snapshot
getMergeStageProfileSnapshot 15 params → 200204400401403404405406
GET
/profilesByIds
Search for profile(s)
getProfilesByIds 17 params → 200204400401403404405406
PUT
/profilesMatchList
Updates a list of matchIds to skip or don't skip profile match.
putProfilesMatchList 8 params body → 200400401403404405406413
GET
/profilesMatchList/profileType/{profileType}
Get profiles match list.
getProfilesMatchList 20 params → 200400401403404405406413
PUT
/reProcessStageRecords
Re-Process all Stage Records
reProcessStageRecords 8 params body → 200400401403404405406413
GET
/reProcessStageRecords/logs
Get reProcess stage records logs.
getReProcessStageRecordsLogs 13 params → 200204400401403404405406
GET
/recentlyAccessedProfiles
Fetch recently accessed profiles
getRecentlyAccessedProfiles 10 params → 200204400401403404405406
DELETE
/service/profileService/cache
Operation to delete cache for Profile service
clearProfileServiceCache 8 params → 200400401403404405406413
GET
/services/profile/status
Operation to check the status of profile service
pingProfileService 8 params → 200204400401403404405406
GET
/stagedProfile/{id}
Get a staged profile
getStagedProfile 13 params → 200204400401403404405406
PUT
/stagedProfile/{id}
Change a staged profile
changeStagedProfile 9 params body → 200400401403404405406413
GET
/stagedProfilesdeprecated
Get staged profiles
getStagedProfiles 29 params → 200204400401403404405406
POST
/stagedProfiles/searches
Get staged profiles
searchStagedProfiles 8 params body → 200204400401403404405406
POST
/stayMembership
This API facilitates attaching or replacing a membership to a given stayRecord.
addReplaceStayMembership 7 params body → 201400401403404405406413
POST
/stayRecord
This API facilitates uploading stage records to LCS.
postStayRecord 7 params body → 201400401403404405406413
GET
/stayRecord/{stayRecordId}
Get Stay Record Detail.
getStayRecordDetail 10 params → 200204400401403404405406
PUT
/stayRecords/{stayRecordId}
Ability to edit Orphan Stay Records
putOrphanStayRecords 9 params body → 200400401403404405406413
GET
/suspendedAddressesdeprecated
Fetch Suspended Profile Addresses
getSuspendedAddresses 15 params → 200204400401403404405406
GET
/suspendedProfiles/errorsSummary
Get suspended profiles errors summary details
getSuspendedProfilesErrorsSummary 12 params → 200204400401403404405406
GET
/suspendedProfiles/errorsSummary/profileType
Get suspended profiles match errors summary information grouped by profile type.
getSuspendedProfilesErrorsSummaryByProfileType 11 params → 200204400401403404405406
GET
/suspendedProfiles/errorsSummary/property
Get suspended profiles match errors summary information grouped by property.
getSuspendedProfilesErrorsStatByProperty 11 params → 200204400401403404405406
POST
/suspendedProfiles/errorsSummary/property
Get suspended profiles match errors summary information grouped by property.
getSuspendedProfilesErrorsSummaryByProperty 8 params body → 201204400401403404405406
GET
/suspendedProfiles/matchStats
Get suspended profile match statistics information.
getSuspendedProfilesMatchStats 14 params → 200204400401403404405406
GET
/suspendedProfiles/matchStats/matchCriteria
Get suspended profiles match statistics information grouped by match criteria.
getSuspendedProfilesMatchStatsByMatchCriteria 10 params → 200204400401403404405406
GET
/suspendedProfiles/matchStats/profileType
Get suspended profiles match statistics information grouped by profile type.
getSuspendedProfilesMatchStatsByProfileType 11 params → 200204400401403404405406
GET
/suspendedProfiles/matchStats/property
Get suspended profiles match statistics information grouped by property.
getSuspendedProfilesMatchStatsByProperty 11 params → 200204400401403404405406
GET
/suspendedProfiles/matchStats/propertyAndProfileType
Get suspended profiles match statistics information grouped by property and profile type.
getSuspendedProfilesMatchStatsByPropertyAndProfileType 11 params → 200204400401403404405406
GET
/suspendedProfiles/matchStats/threshold
Get suspended profiles match statistics summary information filtering by threshold type.
getSuspendedProfilesMatchStatsByThreshold 14 params → 200204400401403404405406
PUT
/synchronizeProfileSubscriptions
Synchronize profile subscriptions
synchronizeProfileSubscriptions 8 params body → 200400401403404405406413
PUT
/validateForgetProfiles
Validate forget profiles
validateForgetProfiles 8 params body → 200400401403404405406413

Schemas 506

The contract defines 506 schemas that model the data the API accepts and returns. The most detailed are stayDetailType (70 properties), stayRecordsType (61 properties), profileType (58 properties), searchProfilesRequest (57 properties). Each schema is shown below with its type and property counts.

generateMembershipNumberCriteriaType
object
Auto generate membership number criteria.
2 properties
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
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
status
object
Response Body.
2 properties
membershipNumber
object
Request object for generating membership number.
3 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
links
array
reservationQueueInformationType
object
Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
6 properties
cardReIssueType
string
Request to re issue a new card.
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
resAccompanyGuestInfoType
object
5 properties
matchStatusType
string
No Match found based on the Threshold.
duplicateExternalSubscriptionsListType
array
Details of the OPERA Profile subscription to external system
suspendedProfilesMatchStatsByMatchCriteriaType
object
Suspended profiles match statistics grouped by match criteria.
1 property
emailMessageType
object
Request object for storing an email.
9 properties
stagedProfilePhoneType
object
Information on a telephone number for the customer.
6 properties
salesInfoType
object
Provides sales information about the profiles of type company, travel agent, source and contact.
13 properties
recentlyAccessedProfileType
object
A recently used profile details.
5 properties
successType
object
Returning an empty element of this type indicates the successful processing of an message. This is used in conjunction with the Warning Type to report any warn…
folioStatusType
string
The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.
stageProfileMatchType
object
Details about the matched profiles.
3 properties
colorType
string
Color configuration type. This color configuration provides a visual category of entities.
profileCashieringDetails
object
Request object for changing the profile cashiering details.
4 properties
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
stagedReasonsEnum
string
stagedProfileCharacterUDFsType
array
Used to hold collection of user defined fields of Character/String Type.
profileCommissionAccountCriteriaType
object
Contains base info to determine profile commission bank account and code.
5 properties
stagedProfileCommentInfosType
array
List of Notes for the customer.
profileSubscriptionListType
array
Details of the OPERA Profile subscription to external system
negotiatedType
object
This holds a list of NegotiatedInfoType.
3 properties
reProcessStageRecordsType
object
Provides information about the search criteria for the staged records to reprocess.
12 properties
characterUDFsType
array
Used to hold collection of user defined fields of Character/String Type.
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
profile
object
Object for creation of profiles. This object contains profile details with unique identifiers for each profile.
7 properties
suspendedProfilesMatchStatsByPropertyAndProfileTypeType
object
Suspended profiles match statistics grouped by property and profile type.
1 property
indicatorType
object
Lamp indicator Type.
2 properties
stagedProfileChangeInstructionsType
object
Information about instructions to change the staged profile.
1 property
fixedChargesType
array
Holds fixed charge detail.
stagedProfileSummariesType
object
A collection of staged profiles.
7 properties
imageStyleType
string
An enumeration of image styles.
addressInfoType
object
Provides address information.
3 properties
profileCommissionAccountCopy
object
Request object for copying transaction groups configuration.
3 properties
verifiedECertificate
object
Response object to Verify E-Certificate and will return the profile information.
4 properties
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
eCertificateInfoType
object
E-Certificates details.
14 properties
changeRelationsInfoType
object
Detailed information regarding to be changed relationships for the profile.
8 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
customerType
object
Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
26 properties
suspendedProfilesErrorsSummaryInfo
object
Response object for fetch suspended profiles errors summary. This object contains collection of profiles errors and the number of profiles that were encountere…
3 properties
suspendedProfilesErrorsSummaryByProfileType
object
Suspended profiles errors summary by profile type.
1 property
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…
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…
12 properties
company
object
Request object for creation of company/agent/group/source profile. This object contains profile details with unique identifiers of a profile. The standard opti…
5 properties
stagedProfileNumericUDFType
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…
8 properties
stagedReasonsType
object
This is used to fetch staged profiles based on the reason why it got staged.
1 property
hasFuturePastBookingsExclusionsType
object
Search type for excluding list of business blocks and/or reservations.
2 properties
forgetProfileFailureReasonListType
array
Reason describing why the profile is not eligible to be forgotten.
stagedAddressCleansStatus
string
Simple type for status of staged address cleansing.
fulfillmentExportInfoType
object
This type holds the export log information for the membership fulfillment record.
9 properties
profileDeliveryModuleType
string
Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..
reProcessStageRecord
object
3 properties
aRAccountType
object
Accounts Receivabales Account details type.
33 properties
duplicateOPERASubscriptionsType
object
Contains subscription details about an external profile within a particular external system that is linked to multiple OPERA profiles.
2 properties
suspendedProfileType
string
The types of suspended profiles
hotelInterfaceType
object
8 properties
stagedProfiles
object
Response object for the staged profiles.
3 properties
cardProcessingType
string
eCertificateGenerationDetailsType
object
E-Certificates issue API call details.
5 properties
suspendedProfilesMatchStatsByMatchCriteria
object
Response object for fetch suspended profiles match statistics grouped by match criteria.
3 properties
aRPaymentsType
array
A collection of AR Payments.
suspendedProfilesMatchStatsByThresholdType
object
Suspended profiles match statistics grouped by threshold
1 property
suspendedAddresses
object
Response object for fetching unique company profile.
3 properties
aRYearViewInfoType
object
Information regarding Year View balances for an account.
2 properties
changeRelationshipCriteriaType
object
Information about the changes in relationship for the profile
6 properties
errorType
object
Standard way to indicate that an error occurred during the processing of an message. If the message successfully processes, but there are business errors, thos…
10 properties
housekeepingTaskCodeType
object
Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
7 properties
resAccompanyGuestListType
array
Collection of accompany guests
resSharedGuestListType
array
Collection of shared guest reservations.
benefitsType
array
Basic information about membership benefit.
facilityTaskType
object
Information regarding facility task on a reservation.
3 properties
setProfileOwnersCriteriaType
object
Criteria to update the profile owners.
2 properties
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.
codeDescriptionType
object
This contains a generic code and description information.
2 properties
profileOwners
object
Request object to change profile owners.
3 properties
surnameType
string
Family name, last name.
sourceCodeInfoType
object
4 properties
stagedProfileId
object
Unique identifier for a staged profile.
2 properties
eCertificateToConsume
object
Request object to Consume an E-Certificate.
3 properties
ownerType
object
Generic type for information about an owner.
11 properties
checkedProfiles
object
Response for checking allowed actions, existence of attached records, or indicators of a profile.
3 properties
exceptionDetailType_2
object
Complex type that contains error details for a REST call.
9 properties 2 required
aRYearViewType
object
Year information for an Year View.
3 properties
matchedProfiles
object
Response object for the match profiles.
3 properties
stayRevenuesType
object
3 properties 2 required
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
flexFieldsResponse
object
Response object for flex fields.
9 properties
checkProfileType
object
Profile and the status of its allowed actions, attached records, and indicators.
2 properties
profileDeliveryMethod
object
Delivery Information type to the profile.
7 properties
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
traceType
object
15 properties
commissionPaymentMethods
string
Check
operaVersionNumberType
string
Current Opera Version Number
stringLength80
string
Used for Character Strings, length 0 to 80.
errorsType
array
An error that occurred during the processing of a message.
stagedProfileCompanyType
object
21 properties
addressType
object
Provides address information.
18 properties
guest
object
Request object for creation of guest/contact/employee profile. This object contains profile details with unique identifiers of a profile. The standard optional…
5 properties
orphanStayRecord
object
The request element used to update orphan stay record elements.
3 properties
profileSubscriptionsToSynchronize
object
Request object for re-subscribing profile subscriptions.
3 properties
stagedProfileDateUDFsType
array
Used to hold collection of user defined fields of Date Type.
stayFutureListType
object
A collection of reservation history details attached to Profiles.
4 properties
suspendedProfilesErrorSummaryByPropertyType
object
Type which represents a suspended profiles error by property information.
2 properties
countryNameType
object
Code for a country or a nationality.
2 properties
errorInstance_2
object
Complex type that contains error instance details for a REST call.
7 properties 2 required
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
stagedReasonType
string
Reasons why the profile got staged. InvalidExpirationDate indicates the membership expiration date is not matching with OPERA system. InvalidEnrollmentCode ind…
relationshipAddressType
object
Provides address information for a Relationship.
5 properties
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
stagedProfileKeywordType
object
6 properties
accountForecastsType
array
Detail Information about Account Forecast.
dateRangeType
object
Date Range with Start and End dates.
2 properties
aRAccountStatusType
object
Type for the Account Status. Status can be restricted and a message/description added to the Account.
3 properties
profileDetails
object
Response object for fetching multiple detailed profiles by unique identifiers..
3 properties
profileMatchType
object
1 property
benefitType
object
Basic information about membership benefit.
3 properties
forgetProfileResultType
object
Results of Anonymization processing/validation.
4 properties
stayRecord
object
6 properties
billingPrivilegesType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
13 properties
suspendedProfilesErrorsSummaryByProfileTypeInfo
object
Response object for fetch suspended profiles errors summary by profile type. This object contains a collection of profile types and the count of errors found i…
3 properties
reservationTaxTypeInfo
object
Provides information about the Tax Type.
9 properties
stagedProfileTrxInfoType
object
Transaction codes info.
13 properties
allowedActionEnum
string
awardDetails
object
Response of fetch awards request.
3 properties
privacyInfoType
object
Defines Privacy related information for the profile.
15 properties
guestProfileTypeType
string
The types of Profile handled by the web service.
suspendedProfilesMatchStats
object
Response object for fetch suspended profiles match statistics.
3 properties
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 properties
aRAgingInfoType
object
Information regarding the aging balances for an account.
2 properties
relationshipCriteriaType
object
Contains Criteria Information for a profile relationship.
7 properties
operaVersion
object
Response for Ping operation.
3 properties
profileCashieringType
object
Contains cashiering related details for the profile
14 properties
relationshipInfoType
object
Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.
8 properties
membershipTransactionRateType
object
Information related to a membership transaction rate.
7 properties
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 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…
profileToBeMerged
object
Profile Resource will be merged.
5 properties
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
ownersType
array
Generic type for a list of owners.
stagedProfileMembershipType
object
Detailed information of the memberships.
50 properties
webUserHistoryType
object
Creation date time, Creator Id, last modification date time and last Modifier Id.
7 properties
suspendedProfilesMatchStatsByProfileType
object
Response object for fetch suspended profiles match statistics grouped by profile type.
3 properties
profileTransactions
object
Response of the WS operation FetchProfileTransactions.
9 properties
fulfillmentExportedLogs
object
Optional elements whether to update exclude extract or delivery status in membership fulfillment
3 properties
profileCashieringDetailsInfo
object
Response object containing profile routing instructions.
3 properties
negotiatedInfoType
object
This provides information for a profile negotiated rate.
6 properties
mergedProfilesSnapshotDetails
object
Response object for fetching snapshot of merge profiles result.
3 properties
reservationInfoType
object
The Reservation class contains the current reservation being created or altered.
51 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.
stagedProfileBillingInstructionType
object
Configured Billing Instruction which represents a set of Transaction Codes.
7 properties
eCertificateType
object
E-Certificates details.
23 properties
resCashieringType
object
Cashiering Information for the reservation.
14 properties
stagedProfileErrorType
object
Criteria to fetch the staged profile.
2 properties
reservationDepositType
object
Reservation Deposit Type.
7 properties
profileMembershipType
object
Detailed information of the memberships.
43 properties
reservationPaymentMethodType
object
7 properties
profilesMatch
object
Response object for fetching the profiles match.
8 properties
stayProfilesType
object
4 properties 1 required
searchStagedProfilesRequest
object
21 properties
changedMembership
object
Response object for change/update membership. This object contains collection of memberships,Success,Warnings and Errors related to this operation
3 properties
searchProfileMatchesRequest
object
12 properties
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
suspendedProfilesMatchStatsByProfileTypeType
object
Ssuspended profiles match statistics grouped by profile type.
1 property
stagedProfileRoutingInstructionType
object
2 properties
profileTransactionsType
object
Transaction related to the Profile.
19 properties
suspendedAddressesType
object
List of suspended addresses returned, based on the entered seach criteria.
7 properties
suspendedProfilesErrorsSummaryByPropertyType
object
Suspended profiles errors summary by property.
1 property
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
profileSummaries
object
Response object for fetching profiles. This object contains profile primary details,profile summary details,master info list containing code and description us…
4 properties
dateTimeStampGroupType
object
4 properties
hasFuturePastBookingsSearchType
object
Search type for verifying whether there are future and/or past business blocks and/or reservations exist for a Profile.
5 properties
stagedProfileSourceType
string
futurePastBookings
object
This is the Response Message to information regarding existence of profile in future and/or past business blocks and/or reservations.
3 properties
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
relatedProfileTypeEnum
string
stagedProfileSummaryType
object
Basic information about staged profile.
14 properties
activityLogListType
object
7 properties
awardType
object
Detailed information of the awards.
33 properties
identificationInfoType
object
Information on the identification of the customer.
3 properties
masterInfoCodeDetailType
string
profileSummaryType
object
Type provides the basic information about the profile.
37 properties
profileRestrictions
object
3 properties
overrideForecastTypeType
string
Defines values for OverrideForecastType.
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
suspendedProfilesErrorSummaryByProfileType
object
Type which represents a suspended profiles error by profile type.
2 properties
matchCriteriaListType
object
Type which represents suspended profiles match statistics grouped by profile type with detailed view
2 properties
suspendedProfilesMatchStatType
object
Type which represents suspended profiles match statistics information.
7 properties
eCertificateToExtend
object
Request object to Consume an E-Certificate.
4 properties
stagedProfileCharacterUDFType
object
Used to hold user defined field of Character/String Type.
8 properties
fixedChargeScheduleType
object
Holds schedule of fixed charge.
5 properties
profileMatch
object
Response object for fetching profile Match.
3 properties
suspendedProfilesMatchStatsByThreshold
object
Response object for fetch suspended profiles match statistics filtered by threshold type.
3 properties
stayRecordDetails
object
Complex type that contains stay record details
1 property
stayRecordDetail
object
Stay Record details for a single stay record including Revenues, Daily Rates and UDFs.
5 properties
trxInfoType
object
Transaction codes info.
10 properties
suspendedProfilesErrorsSummaryType
object
Profiles errors summary type.
1 property
flexFieldValues
object
Request object for flex fields values.
3 properties
relationshipInfoSummaryType
object
RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact p…
7 properties
profileTypesListType
object
Type which represents suspended profiles match statistics grouped by profile type with detailed view
3 properties
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
resAttachedProfileListType
array
stagedProfileErrorField
string
Simple type for stage profile error filed to specify which filed in the stage profile has error.
eCertificateConsumptionType
object
E-Certificates details.
13 properties
suspendedProfilesMatchStatByThresholdType
object
Type which represents suspended profiles match statistics information.
3 properties
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
relationshipProfileSummaryType
object
11 properties
suspendedProfilesMatchStatByProperty
object
Type which represents suspended profiles match statistics grouped by profile type.
3 properties
forgetProfilesCriteria
object
Operation to validate profiles for forgetting.
3 properties
awardsType
array
List of awards.
givenNameType
string
Given name, first name or names
aRAgingType
object
Aging information for an Aging Bucket.
6 properties
suspendedProfilesMatchStatsByPropertyType
object
Suspended profile match statistics grouped by property.
1 property
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
3 properties
fulfillmentExportLogsType
array
This type holds the export log information for the membership fulfillment record.
companyInfoType
object
Company Information of the Profile.
3 properties
membership
object
Request object for create membership. This object contains unique identifiers for each profile and list of membership details to be created. The standard optio…
4 properties
searchTypeEnum
string
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
9 properties
forgetProfilesCriteriaType
object
Criteria to identify the profiles to be forgotten.
2 properties
imageSetType
object
Represents on image set record.
11 properties
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
membershipTierProjections
object
Response object for fetching Membership Tier Process Text.
3 properties
stageProfileMatchesType
object
1 property
reProcessStageRecordResultType
object
Information about the staged profile after processing.
5 properties
profilesMatchType
object
Type that contains the information of a profile match such as main profile, profile to merge, match id, status of the match, date when the points where compute…
10 properties
accountForecasts
object
Response object for showing forecast information of account profile.
9 properties
rESTPaginationGroup
object
Provides Pagination Information for the REST API.
5 properties
profileAllowedActionsType
array
Allowed actions for profile operations.
alienInfoType
object
immigration/visa information of a foreign person.
3 properties
eCertificateUsageCriteriaType
object
E-Certificates details.
8 properties
companyProfileTypeType
string
The types of Profile handled by the web service.
suspendedProfilesMatchStatsByPropertyAndProfileType
object
Response object for fetch suspended profiles match statistics grouped by property and profile type.
3 properties
stagedProfileCommissionType
object
Information on commission for the customer.
8 properties
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 properties
eCertificateIssueSourceType
string
Indicates that OPERA E-Certificate is issued by external system.
profileAccounts
object
Response of profile accounts.
3 properties
stagedProfileDetails
object
Response object for the staged profile.
3 properties
stagedProfileURLType
object
Web site address.
6 properties
mergedProfileType
object
Provides information for merged profile.
2 properties
profilesType
object
A collection of Profile objects or Unique IDs of Profiles.
3 properties
interfaceRightsStatusType
object
4 properties
guestProfileType
object
Type provides the detailed information about the profile and its children.
45 properties
profileNameType
object
This provides name information for a person.
8 properties
traceTimeInfoType
object
4 properties
primaryProfileInfoType
object
Contains basic information of profile.
3 properties
duplicateExternalSubscriptionsType
object
Contains subscription details about an OPERA Profile that is linked to multiple external profiles within the same external system.
3 properties
stayReservationInfoType
object
The Reservation class contains the current reservation being created or altered.
7 properties
profiles
array
Unique identifier for a profile.
mailingActionsType
object
Defines mailing action list for the profile.
4 properties
duplicateOPERASubscriptionsListType
array
Details of the OPERA Profile subscription to external system
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
30 properties
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 properties
copyProfileCommissionInfoType
object
Contains base info to determine profile commission bank account and code.
6 properties
suspendedProfilesMatchStatsType
object
Suspended profiles match statistics
1 property
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,…
4 properties
recentlyAccessedProfiles
object
Response with the fetched recently accessed profiles.
3 properties
reservationId
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
profileCommissionAccountInfoListType
array
Profile commission info which contains bank account and commission code details.
profileStatusType
string
errorDescType
object
Object for specific error description.
3 properties
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
billingInstructionsType
array
Set of Billing Instruction codes.
stagedProfilePreferenceType
object
Guest Preference details for the profile.
14 properties
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
commissionPayoutToType
string
duplicateOPERASubscriptions
object
Response object for fetching subscriptions where an external profile within a particular external system is linked to multiple OPERA profiles.
9 properties
reProcessStageRecordLogEntry
object
A log entry for a reprocess/rematch job.
9 properties
lastStayInfoType
object
Contains last stay related details for the profile
4 properties
eCertificates
object
Response object for fetch ECertificates. This object contains collection of ECertificates,Success,Warnings and Errors related to this operation.
3 properties
rewardCertificateType
string
Point Saver reward.
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
generateMembershipNumberCriteriaType_2
object
Auto generate membership number criteria.
1 property
profileCommissionAccount
object
Request object for creating profile commission detail.
3 properties
profileSharedLevelType
string
Simple types for Shared level.
reservationFolioWindowsType
array
Collection of reservation folio windows.
membershipTransactionRevenueType
object
Information related to a membership transactions Revenue.
7 properties
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
commentInfoType
object
Comment related to the profile/reservation.
7 properties
reservationIdList
array
Unique Id that references an object uniquely in the system.
suspendedProfilesMatchStatByMatchCriteriaType
object
Type which represents suspended profiles match statistics grouped by match criteria.
2 properties
suspendedProfilesMatchStatByPropertyAndProfileTypeCombined
object
Type which represents suspended profiles match statistics grouped by property with detailed view
3 properties
directBillingType
object
This is the preconfigured routing instruction type.
2 properties
profileStayDetailsType
object
Type provides the stay history and future reservations of specific profile.
1 property
eCertificateStatusType
string
Indicates that OPERA E-Certificate is reserved.
stayRevenuesDetailsType
object
3 properties
eCertificateScopeType
string
Indicates that OPERA E-Certificate is available for a specific list of hotels.
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
gdsNegotiatedInfoType
object
This provides information for a channel negotiated rate.
5 properties
billingInstructionType
object
Configured Billing Instruction which represents a set of Transaction Codes.
4 properties
eCertificateGenerationType
object
E-Certificates details.
3 properties
eCertificatesType
array
List of e-certificates for the profile.
keywordType
object
3 properties
processedStagedProfile
object
3 properties
profileTaxInfoType
object
Profile information related to tax.
7 properties
aRAccountShortInfoType
object
Accounts Receivabales Account details type charged for batched posting.
4 properties
profileRelationship
object
Request object for creating profile relationship.
4 properties
processStagedProfileType
object
Information required to process a atged profile.
3 properties
profileRoutingInstructionsType
object
The type contains routing instructions for the profile.
3 properties
stringLength100
string
Used for Character Strings, length 0 to 100.
vIPStatusType
object
VIP status of the customer.
2 properties
cashierInfoType
object
Cashier information. Contains Id and Name details of the cashier.
2 properties
reservationTurndownInfoType
object
Turndown information for a reservation
2 properties
stayMembershipDetails
object
Complex type that contains stay membership details and instructions to attach or replace.
6 properties 1 required
resProfileTypeType
string
forecastsInformation
object
3 properties
codeListType
array
profileAllowedActionType
string
Flag indicating whether Profile is Enrolled to Primary Membership Program.
profileCommissionAccountInfoType
object
Profile commission info which contains bank account and commission code details
3 properties
profileOwnersDetail
object
Response object to fetch the owners of a profile.
3 properties
membershipTierProjectionType
object
Membership Upgrade/Downgrade Projection.
2 properties
profileCommissionAccountInfo
object
Response object for fetching profile commission detail.
3 properties
reservationStayHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
commentType
object
An indication of a new paragraph for a sub-section of a formatted text message.
16 properties
stagedProfileUserDefinedFieldsType
object
Used to hold user defined fields(UDFs) for staged profile.
3 properties
forgetProfileFailureReasonType
object
Provides information about the reason why the profile is not eligible to be forgotten.
3 properties
aRBalanceType
object
Balance information for AR.
3 properties
profileInfoType
object
Provides information about attached profiles to the block.
5 properties
articlePostItType
object
Post it information of an article.
2 properties
stagedProfileEmailType
object
Information on an email for the customer.
6 properties
nameTypeType
string
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
payeeInfoType
object
Payee information.
7 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
relationshipsSummary
object
Contains details relationships related to a profile.
4 properties
searchProfileMatchRequest
object
10 properties
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
roomClassCodeInfoType
object
Code of the room class type.
3 properties
preference
object
Response object for fetch preference. This object contains collection of preferences,Success,Warnings and Errors related to this operation.
4 properties
attachmentType
object
Attached files.
12 properties
matchProfileType
object
Provides information for match profile.
3 properties
webUserAccountsType
array
Web User Accounts List.
linkedProfiles
object
Response of fetch set of linked Profiles to the requested Profile.
3 properties
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
changeAccountForecastsRS
object
Response Body.
11 properties
stagedProfileNumericUDFsType
array
Used to hold collection of user defined fields of Numeric Type.
profileCashieringDetailType
object
The type contains routing instructions for the profile.
8 properties
aRAccountsType
array
Information regarding the AR Account.
emailInfoType
object
Information on an email for the customer.
3 properties
stayRecordsType
object
61 properties
facilityCodesType
array
List of the facility codes.
matchType
object
Type that contains matchId and if this particular matchId is set to skip profile match or not.
2 properties
personNameTypeType
string
Person's name in an external system.
forgetProfileResultListType
array
Result of processing/validation for forgetting a profile.
dateUDFsType
array
Used to hold collection of user defined fields of Date Type.
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
suspendedAddressesInfoType
object
10 properties
dateUDFType
object
Used to hold user defined field of Date Type.
3 properties
stagedProfileProcessType
string
Process Type enumerator.
profileSummaryInfoType
object
Summary information about a profile and the associated Unique IDs.
2 properties
processStagedProfileResultType
object
Information about the staged profile after processing.
4 properties
uRLInfoType
object
Web site address.
3 properties
profileRelationshipToBeChanged
object
Request object for changing profile relationship.
3 properties
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,…
4 properties
resAttachedProfileType
object
3 properties
reProcessStageRecordsCriteria
object
Object for Reprocessing Stage Records.
3 properties
cityState
object
Response object for fetching City and State based on search criteria. This object contains address information,Success,Warnings and Errors related to this oper…
3 properties
stagedProfileCriteria
object
3 properties
keywordDetailType
object
1 property
taxTypeType
object
Provides information about the Tax Type.
8 properties
stagedProfileCustomerType
object
Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
28 properties
stayDailyRatesType
object
9 properties 2 required
eCertificateIssueType
string
Indicates that guest purchased OPERA E-Certificate.
webUserAccountType
object
Web User Account of the guest.
11 properties
externalReferencesType
array
This type contains unique information of external reference.
fixedChargeDetailType
object
Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.
7 properties
aRInvoiceType
object
Details of an AR Invoice.
53 properties
suspendedProfilesErrorsSummaryByPropertyInfo
object
Response object for fetch suspended profiles errors summary by property. This object contains a collection of suspended profiles match errors and the count of…
3 properties
mergedStageProfileSnapshot
object
Response object to fetch merge profile based on stage and opera profile.
3 properties
profileRelationships
object
3 properties
databaseIDListType
array
Code identifying the external database record which is linked to external systems.
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.
stagedProfileType
object
Detailed information about the staged profile.
22 properties
aRInvoiceCategory
string
profileAdditionalInfoType
object
5 properties
applyToEnum
string
exportLogsDeliveryStatusType
string
Delivery Status for export logs - Not Delivered.
matchListType
object
Type that contains the list of theh matchIds that will be updated to skip or don't skip profile match.
1 property
profileTypeType
string
The types of Profile handled by the web service.
fetchInstructionsEnum
string
profileMatchStatusType
string
Status of the match. It can be one of these 3 options: Match Points Computed, Do Not Merge, Can Not Merge.
profileIdList
array
Unique Id that references an object uniquely in the system.
stagedProfile
object
Request object for changing the staged profile.
4 properties
fBAInfoType
object
FBA ( Flexible Benefits Awards ) related fields.
22 properties
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
stagedProfileDateUDFType
object
Used to hold user defined field of Date Type.
8 properties
profileAttachments
object
Response object with the details of the attachments of a profile.
3 properties
profileStayHistory
object
Response object for showing stay history and future reservations of specific profile.
3 properties
membershipTransactionId
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
awardStatusType
string
Indicates that certificate is in use.
companyProfileType
object
Type provides the detailed information about the profile and its children.
47 properties
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
eCertificateGeneration
object
Request object to issue E-Certificate.
3 properties
stayMembershipAttachMode
string
Flag that indicates if membership should be attached or existing membership should be replaced.
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
checkProfileResultType
object
Status of allowed actions, attached records, and indicators of the profile.
2 properties
namePrefixType
string
Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.). Currently this attribute is not used for PUT and POST operations.
duplicateExternalSubscriptions
object
Response object for fetching subscriptions where the same OPERA profile is linked to multiple external profiles within the same external system.
9 properties
personNameType
object
This provides name information for a person.
13 properties
fBAStatusType
string
Flexible benefit award has been reimbursed.
reProcessStageRecords
object
Request object for processing the staged records.
3 properties
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
applyToType
string
Membership filter of staged profiles.
resPaymentCardType
object
Information on a credit card for the customer.
19 properties
suspendedProfilesMatchStatsByProperty
object
Response object for fetch suspended profiles match statistics grouped by property.
3 properties
bankAccountType
object
Bank account information like Account ID, Bank Name, Currency, etc.
13 properties
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
7 properties
suspendedProfilesErrorSummaryType
object
Type which represents suspended profile errors information.
2 properties
indicatorsType
array
Collection of lamp indicators.
addtionalCodeInfoType
array
Holds name of additional code information
roomOwnershipType
object
Define the search criteria for retrieving room ownership records
9 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,…
3 properties
telephoneType
object
Information on a telephone number for the customer.
12 properties
stagedProfileStatus
string
Simple type for status of the staged profiles.
profileTypeEnum
string
preferenceType
object
Guest Preference details for the profile.
8 properties
tierAdministrationType
string
Do not upgrade membership. The membership may be downgraded.
copyInstructionType
string
Copy Instruction for a profile
profileActivityLog
object
Response object for fetching profile activity log. This object contains collection of user activity log for the profile,Success,Warnings and Errors related to…
3 properties
customizedPrivacyCodesType
object
Customized privacy codes and values
2 properties
basicEmailListType
array
checkProfilesType
array
Collection of profiles and the status of its allowed actions, attached records, and indicators.
stagedProfileNegotiatedRateType
object
This holds a list of NegotiatedInfoType.
6 properties
stayMembershipsType
object
2 properties
traceResolveType
object
2 properties
checkProfileResultsType
array
Collection of status of allowed actions, attached records, and indicators of the profile.
resCommunicationType
object
Communication details for a reservation.
2 properties
masterInfoType
object
2 properties
stagedProfileIdentificationsType
object
Information on the identification of the customer.
6 properties
dateTimeSpanType
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…
2 properties
stagedProfileAddressType
object
Provides address information.
8 properties
basicEmailType
string
Email address
aRInvoicesType
array
A collection of AR Invoices.
profileCommissionType
object
This is the preconfigured routing instruction type.
7 properties
identificationType
object
Identification information of the customer.
10 properties
articleInfoType
object
Information regarding an article.
9 properties
profileMatchTypeType
object
Provides information about the profiles matched.
8 properties
relationshipProfileType
object
13 properties
stagedProfileCommentInfoType
object
Comment related to the profile/reservation.
14 properties
futurePastBookingsCriteria
object
Request for information regarding existence of profile in future and/or past business blocks and/or reservations.
3 properties
shortInfoProfileType
object
This type contains short information of a profile.
3 properties
masterAccountInfoType
object
2 properties
numericUDFsType
array
Used to hold collection of user defined fields of Numeric Type.
profileSummariesType
object
A complex type containing the collection of Profile objects or Unique IDs of Profiles.
7 properties
activityLogType
object
12 properties
masterType
string
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
phoneNumberType
string
Phone number
synchronizeProfileSubscriptionsCriteriaType
object
Criteria for searching profile subscriptions.
2 properties
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
eCertificateConsumeSourceType
string
Indicates that OPERA E-Certificate is consumed by hotelPMS.
accountForecastType
object
Detail Information about Account Forecast.
13 properties
reProcessStageRecordsLogInfo
object
Response object for fetch reProcessStageRecords logs.
9 properties
stringLength40
string
Used for Character Strings, length 0 to 40.
iATAInfoType
object
IATA Information of the profile.
3 properties
reservationCertificateType
string
Certificate is incentive.
awardKindType
string
Indicates that this is electronic certificate.
preferenceTypeType
object
Preference details for the profile.
12 properties
attachmentsType
array
Attachment List.
emailType
object
Information on an email for the customer.
11 properties
validatedForgetProfiles
object
Response object for validating profiles for forgetting.
3 properties
fixedChargeType
object
Holds fixed charge information.
8 properties
eCertificateToVerify
object
Request object to Verify an E-Certificate Number.
5 properties
uRLType
object
Web site address, in IETF(The Internet Engineering Task Force) specified format.
5 properties
codeInfoType
object
4 properties
companyType
object
21 properties
trxCodesInfoType
array
List of Transaction codes info.
changeRelationsType
object
Detailed information regarding the changes made to relationships for the profile.
5 properties
stayHistoryListType
object
A collection of reservation history details attached to Profiles.
4 properties
reservationAllowedActionsType
array
Allowed action.
searchMatchesType
array
List of Generic Name-Value-Pair Parameters used for super search matches.
vIPType
object
The supplier's ranking of the customer.
2 properties
stringLength200
string
Used for Character Strings, length 0 to 200.
marketCodeInfoType
object
4 properties
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
3 properties
copyInstructionsType
object
Copy Instructions for a profile
1 property
stayDetailType
object
The Reservation class contains the current reservation being created or altered.
70 properties
aRPaymentType
object
Details of an AR Payment.
18 properties
suspendedProfilesMatchStatByProfileType
object
Type which represents suspended profiles match statistics grouped by profile type.
3 properties
reservationBlockType
object
Key information about the block for a reservation.
3 properties
fixedChargeFrequencyType
string
Yearly.
checkProfileInstructionType
string
Simple type that corresponds to check profile instructions.
orphanStayRecordType
object
This object stores the elements which user wants to update.
12 properties
anonymizationStatusType
string
Guest has been anonymized.
characterUDFType
object
Used to hold user defined field of Character/String Type.
3 properties
commissionPaymentMethodType
object
This contains a generic code and description information.
3 properties
flexFieldValueType
object
Provides the details of a flex field values
3 properties
searchProfilesRequest
object
57 properties
gdsNegotiatedType
object
This holds a list of GdsNegotiatedInfoType.
4 properties
externalReferenceType
object
This type contains unique information of external reference.
2 properties
profileAccessType
object
4 properties
profileType
object
Type provides the detailed information about the profile and its children.
58 properties
paragraphType
object
An indication of a new paragraph for a sub-section of a formatted text message.
2 properties
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
hotelInterfaceTypeType
string
XML Posting Interface

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-hospitality-profile-api-openapi.yml Raw ↑

Other APIs Oracle Hospitality publishes across the network.

OPERA Cloud RnA Activities GraphQL API
OPERA Cloud RnA ARAccountsReceivable GraphQL API
OPERA Cloud RnA ARAgingReport GraphQL API
OPERA Cloud RnA ARLedger GraphQL API
OPERA Cloud RnA BookingReservationExtended GraphQL API
OPERA Cloud RnA BookingsBlockProductionChanges GraphQL API
OPERA Cloud RnA BookingsBlockStatusChanges GraphQL API
OPERA Cloud RnA BookingsBlock GraphQL API
OPERA Cloud RnA BookingsReservation GraphQL API
OPERA Cloud RnA CateringEventForecast GraphQL API
OPERA Cloud RnA CateringEventPostings GraphQL API
OPERA Cloud RnA CateringEventStatusChanges GraphQL API
Where this information came from

This is an independent, third-party profile of Oracle Hospitality Profile API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.