Oracle Hospitality Profile External 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 ProfileExternal. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
11 operations
across 11 paths,
and defines 92 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.
The identity and technical contract details declared by the specification.
fetchPlayerStatisticsRS
object
Response of the WS operation to fetch player statistics.
2 properties
ownersType
array
Generic type for a list of owners.
cardReIssueType
string
Request to re issue a new card.
lastStayInfoType
object
Contains last stay related details for the profile
4 properties
validatedAddress
object
Response object for fetching full address based on ID from external system.
3 properties
profileSharedLevelType
string
Simple types for Shared level.
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
personNameType
object
This provides name information for a person.
11 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.
commentInfoType
object
Comment related to the profile/reservation.
7 properties
profileMembershipType
object
Detailed information of the memberships.
39 properties
characterUDFsType
array
Used to hold collection of user defined fields of Character/String Type.
indicatorsType
array
Collection of lamp indicators.
profile
object
Object for creation of profiles. This object contains profile details with unique identifiers for each profile.
3 properties
indicatorType
object
Lamp indicator Type.
2 properties
imageStyleType
string
An enumeration of image styles.
addressInfoType
object
Provides address information.
3 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
keywordType
object
3 properties
telephoneType
object
Information on a telephone number for the customer.
11 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
currencyAmountType
object
A monetary value expressed with a currency code.
1 property
customerType
object
Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
21 properties
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
preferenceType
object
Guest Preference details for the profile.
7 properties
tierAdministrationType
string
Do not upgrade membership. The membership may be downgraded.
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
identificationInfoType
object
Information on the identification of the customer.
3 properties
commentType
object
An indication of a new paragraph for a sub-section of a formatted text message.
13 properties
profileRestrictions
object
3 properties
validateMembershipNumber
object
Response object for fetching offers from external system.
2 properties
gamingOffersType
array
Offers that are availabl to be attached
benefitsType
array
Basic information about membership benefit.
externalStatusType
string
Success return when there is no error and operation is successful.
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
identificationType
object
Identification information of the customer.
10 properties
playerStatisticsType
object
Contains Player Statistics information
29 properties
emailInfoType
object
Information on an email for the customer.
3 properties
ownerType
object
Generic type for information about an owner.
11 properties
validatedAddresses
object
Response object for fetching Addresses from external system.
3 properties
gamingOffers
object
Response object for fetching offers from external system.
2 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
numericUDFsType
array
Used to hold collection of user defined fields of Numeric Type.
personNameTypeType
string
Person's name in an external system.
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
externalProfileSummaryType
object
Type provides the basic information about the external profile.
14 properties
imageSetType
object
Represents on image set record.
10 properties
uRLInfoType
object
Web site address.
2 properties
iATAInfoType
object
IATA Information of the profile.
3 properties
preferenceTypeType
object
Preference details for the profile.
13 properties
externalProfileSummaryInfoType
object
Summary information about a external profile and the associated Unique IDs.
2 properties
emailType
object
Information on an email for the customer.
10 properties
alienInfoType
object
immigration/visa information of a foreign person.
3 properties
keywordDetailType
object
1 property
addressType
object
Provides address information.
17 properties
companyType
object
18 properties
checkIataNumberType
object
Type provides the IATA Validation information.
14 properties
countryNameType
object
Code for a country or a nationality.
2 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
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
addressValidationInfoType
object
3 properties
iataNumberDetails
object
Response object to fetch IATA Number validation for Travel Agency Profile.
3 properties
externalProfiles
object
Response object for fetching profiles from external CRM System. This object contains profile primary details, profile summary details, master info list contain…
2 properties
benefitType
object
Basic information about membership benefit.
3 properties
mailingActionsType
object
Defines mailing action list for the profile.
3 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,…
4 properties
profileTypeType
string
The types of Profile handled by the web service.
anonymizationStatusType
string
Guest has been anonymized.
characterUDFType
object
Used to hold user defined field of Character/String Type.
3 properties
profileIdList
array
Unique Id that references an object uniquely in the system.
addressValidationsType
array
A collection of validated Addresses.
privacyInfoType
object
Defines Privacy related information for the profile.
14 properties
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 properties
profileAccessType
object
3 properties
profileType
object
Type provides the detailed information about the profile and its children.
33 properties
paragraphType
object
An indication of a new paragraph for a sub-section of a formatted text message.
1 property
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
externalProfileSummariesType
object
A complex type containing the collection of Profile objects or Unique IDs of Profiles.
4 properties
errorInstance_2
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
exceptionDetailType_2
object
Complex type that contains error details for a REST call.
9 properties
2 required
validatePhoneStatus
object
Response Body.
4 properties
validatePhone
object
Request object for validating phone number from external system.
4 properties
status
object
Response Body.
2 properties
validateEmailStatus
object
Response Body.
4 properties
validateEmail
object
Request object for validating email Id from external system.
4 properties
operaVersion
object
Response for Ping operation.
3 properties
operaVersionNumberType
string
Current Opera Version Number
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle Hospitality publishes across the network.
