Adapter - Oracle Opera OHIP PMS

This page describes version 2.0.1 of the adapter.

Overview

This adapter is used to connect to a PMS hosted in the Oracle Hospitality Integration Platform.

The adapter can be used to look up a guest reservation, check-in or check-out a guest and retrieve certain property and guest related information.



Properties

Name	Display	Is Required	Comments	Type	Default Value	Maximum Value	Minimum Value	Maximum Length	Minimum Length
baseApiUrl	Base API URL	True	The base URL for connecting to OHIP Services	string	https://			1024	1
clientID	Client ID	True	Client ID to use for connecting to OHIP Services	string				64	1
clientSecret	Client Secret	True	Client Secret to use for connecting to OHIP Services	password				64	1
applicationKey	Application Key	True	Application Key to use for connecting to OHIP Services	password				64	1
userName	User Name	True	User Name to use for connecting to OHIP API services	string				64	1
password	Password	True	Password to use for connecting to OHIP API services	password				64	1
hotelID	Hotel ID	True	The hotel ID to use for OHIP Services interrogations	string				64	1
chainCode	Chain Code	True	The chain code of the resort	string				64	1
defaultEmailType	Default Email Type	False	The email type that the adapter should use for the InsertEmail command (when not specified as command parameter). If not specified, the adapter uses EMAIL as default.	string	EMAIL			20	1
defaultPhoneType	Default Phone Type	False	The phone type that the adapter should use for the InsertPhone command (when not specified as command parameter). If not specified, the adapter uses HOME as default.	string	HOME			20	1
defaultAddressType	Default Address Type	False	The address type that the adapter should use for the InsertUpdateAddress command. If not specified, the adapter uses HOME as default.	string	HOME			20	1
defaultGuaranteeType	Default Guarantee Type for New Reservations	False	The default guarantee type that the adapter will use for creating new reservations via CreateBooking. If not specified, the adapter uses CO as default.	string	CO			20	1
defaultRatePlanCode	Default Rate Plan Code for New Reservations	False	The default rate plan code that the adapter will use for creating new reservations via CreateBooking or for modifing an existing reservation via ModifyBooking command. If not specified, the adapter uses NR as default.	string	NR			20	1
defaultPaymentMethod	Default Payment Method for New Reservations	False	The default payment method that the adapter will use for creating new reservations via CreateBooking. If not specified, the adapter uses CA as default.	string	CA			20	1
timeZone	TimeZone	False	The time zone used by the hotel.	string				1024	1



Commands

Find Reservation (findReservation)

Looks up a hotel reservation in the OHIP PMS.

Request Properties

Name	Display	Description	Is Required	Type
reservationNumber	Reservation Number	Hotel reservation confirmation number	False	string
mobilePhoneNumber	Mobile Phone Number	Currently not supported (property name reserved for future use).	False	string
roomNumber	Room Number	The room number associated with the hotel reservation	False	string
documentNumber	ID Document Number	The ID document number of the guest associated with the hotel reservation. Can be used only when Scope = CheckOut is also specified.	False	string
guestLastName	Guest Last Name	The last name of the guest associated with the hotel reservation	False	string
guestFirstName	Guest First Name	The first name of the guest associated with the hotel reservation	False	string
guestFullName	Guest Full Name	The full name of the guest associated with the hotel reservation	False	string
guestNameID	Guest Name ID	The guest's unique name identifier in the PMS system.	False	string
externalCrsNumber	External CRS number	The reservation's confirmation number, as provided by an external booking system. Needs to be specified along with guestLastName.	False	string
membershipNumber	Membership number	The membership number of the guest - provided that the guest is enrolled in a membership program.	False	string
membershipType	Membership type	The type of the membership program where the guest is enrolled to.	False	string
languageCode	Language Code	The language code used for the response message	False	string
scope	Reservation look type (CheckIn or CheckOut)	Purpose of the reservation look up. (CheckIn or CheckOut). Mandatory when looking up by guest names, room number or membership number.	False	string
partialComparison	Partial Comparison	When set to true - allows search by at least 3 characters when performing a search with last name. Defaults to false(whole words only).	False	boolean

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
reservationNumber	Hotel reservation confirmation number	string
guestFullName	The full name of the guest associated with the hotel reservation	string
nameID	The NameID of the guest associated with the hotel reservation	string
passportNumber	The unique number of the identity document used by the guest for the hotel reservation	string
guestLanguageCode	The language code of the guest associated with the hotel reservation	string
country	The name of the country that represents the nationality of the guest	string
checkInDate	The check-in date of the guest, formatted as yyyy-MM-dd	string
checkOutDate	The check-out date of the guest, formatted as yyyy-MM-dd	string
checkInTime	The estimated check-in time of the guest, formatted as HH:mm:ss, in hotel's time zone. If this is null, standard hotel check-in time is assumed.	string
checkOutTime	The estimated check-out time of the guest, formatted as HH:mm:ss, in hotel's time zone. If this is null, standard hotel check-out time is assumed.	string
beds	The number of beds allocated for the reservation	string
adults	The number of adults associated with the reservation	string
children	The number of children associated with the reservation	string
rooms.count	The number of rooms associated with the profile	string
rooms[0].roomNumber	The room number	string
rooms[0].roomTypeCode	The type of the room (as code)	string
rooms[0].roomType	The type of the room (as full description)	string
rooms[0].roomRate	The room price per night	string
rooms[0].roomRateCurrency	The currency for the room rate	string
rooms[0].ratePlanCode	The rate plan code applicable for the room	string
emails.count	The number of email addressess tied to the guest profile associated with the reservation	string
emails[0].address	The email address, in format user.account@server.name	string
emails[0].format	Email format to be used when sending emails to this address (HTML or TEXT).	string
emails[0].type	Type of the email address as defined in the OHIP system.	string
emails[0].displaySequence	Display Sequence	string
emails[0].primary	Flag indicating whether this is the primary email address for the guest profile associated with the reservation	string
phones.count	The number of phone numbers tied to the guest profile associated with the reservation	string
phones[0].number	The phone number	string
phones[0].type	Type of the phone number as defined in the OHIP system	string
phones[0].displaySequence	Display Sequence	string
phones[0].primary	Flag indicating whether this is the primary phone number for the guest profile associated with the reservation	string
address.addressLine	Guest residence address as recorded in the PMS.	string
address.cityName	The guest's city of residence as recorded in the PMS.	string
address.country	The guest residence country as recorded in the PMS.	string
address.countryCode	The ISO-3166 code of the guest residence country as recorded in the PMS.	string
reservationStatus	Can be one of these values: RESERVED, REQUESTED, NOSHOW, CANCELLED, INHOUSE, CHECKEDOUT, WAITLISTED, DUEIN, DUEOUT, WALKIN, PENDINGCHECKOUT	string
hasCreditCard	The current reservation has/not have a credit card attached.	boolean
lastFourDigits	The last four digits of the credit card on file with the PMS.	string
preCheckIn	Flag indicating whether the current reservation has been already pre checked-in	boolean
memberships.count	The number of memberships for the guest	string
memberships[0].membershipNumber	The membership number of the guest.	string
memberships[0].membershipType	The membership type of the guest.	string
memberships[0].membershipLevel	The membership level.	string
memberships[0].membershipClass	The membership class.	string
memberships[0].usedInReservation	If true this membership is used in the reservation.	boolean
accompanyingGuests.count	The number of accompanying guests associated with this reservation	string
accompanyingGuests[0].guestType	Type of accompanying guest - Sharer (0) or AdditionalGuest (1)	string
accompanyingGuests[0].reservationNumber	The reservation number of the accompanying guest. Only relevant when the guest type is Sharer.	string
accompanyingGuests[0].reservationStatus	The accompanying guest reservation status. Only relevant when the guest type is Sharer.	string
accompanyingGuests[0].ratePlanCode	The rate plan code used for the accompanying guest reservation. Only relevant when the guest type is Sharer.	string
accompanyingGuests[0].guestId	The accompanying guest's unique ID. For OHIP, this corresponds with guest's profile ID / Name ID'	string
accompanyingGuests[0].guestLastName	Accompanying guest's last name	string
accompanyingGuests[0].guestFirstName	Accompanying guest's first name	string
accompanyingGuests[0].guestFullName	Accompanying guest's full name	string
accompanyingGuests[0].primary	A flag indicating whether the accompanying guest is reservation's primary guest	boolean
accompanyingGuests[0].document.firstName	Accompanying guest's first name, as in the scanned ID document	string
accompanyingGuests[0].document.lastName	Accompanying guest's last name, as in the scanned ID document	string
accompanyingGuests[0].document.gender	Accompanying guest's gender	string
accompanyingGuests[0].document.number	Accompanying guest's ID document number	string
accompanyingGuests[0].document.type	Accompanying guest's ID document type	string
accompanyingGuests[0].document.issueDate	Accompanying guest's ID document issue date	string
accompanyingGuests[0].document.expirationDate	Accompanying guest's ID document expiration date	string
accompanyingGuests[0].document.placeOfIssue	Accompanying guest's ID document place of issue (The city or consular office that issued the document)	string
accompanyingGuests[0].document.countryOfIssue	Accompanying guest's ID document country of issue (The country that issued the document)	string
accompanyingGuests[0].document.primary	Flag indicating whether this is the primary document for the associated profile	string
accompanyingGuests[0].document.dateOfBirth	Accompanying guest's date of birth, as in the scanned ID document	string
accompanyingGuests[0].document.nationality	Accompanying guest's nationality	string
accompanyingGuests[0].document.nationalityCode	Accompanying guest's nationality code	string
accompanyingGuests[0].document.title	Accompanying guest's title	string
profile.uDFs[0].valueName	User define field value name	string
profile.uDFs[0].item	User define field item value	string
profile.privacyField[0].optionType	Privacy option type	string
profile.privacyField[0].optionValue	Privacy option value	string

Find First Reservation (findFirstReservation)

Returns the first reservation found in the PMS that is using a specified document number. Filtering by reservation state and guest names is also possible.

Request Properties

Name	Display	Description	Is Required	Type
status	Status of the reservation	The status to be used for the reservations. Can be any of these values: RESERVED, REQUESTED, NOSHOW, CANCELLED, INHOUSE, CHECKEDOUT, WAITLISTED, DUEIN, DUEOUT, WALKIN, PENDINGCHECKOUT. If left empty, or if a bad value is specified, the adapter defaults to INHOUSE (which includes DUEOUT).	False	string
documentNumber	Document number	The document number to be checked.	True	string
firstName	First Name	The first name to be checked. It is optional, but its usage is recommended, for reducing the search scope and the response time.	False	string
lastName	Last Name	The last name to be checked. It is optional, but its usage is recommended, for reducing the search scope and the response time.	False	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
reservationNumber	Hotel reservation confirmation number	string
reservationStatus	Status of the reservation, as returned by the OHIP PMS.	string
checkInDate	The check-in date of the guest, formatted as yyyy-MM-dd	string
checkOutDate	The check-out date of the guest, formatted as yyyy-MM-dd	string
guestLastName	The last name of the guest associated with the hotel reservation	string
guestFirstName	The first name of the guest associated with the hotel reservation	string

Check In (checkIn)

Check in a Guest associated with a hotel reservation/booking

Request Properties

Name	Display	Description	Is Required	Type
reservationNumber	Reservation Number	Hotel reservation confirmation number	True	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
roomNumber	The number of the room where the guest has been checked in.	string
error	When the command failed, this field indicates the failure reason	string
Info	When the command failed, this field provides additional information on the failure reason	string

Check Out (checkOut)

Check out a Guest.

Request Properties

Name	Display	Description	Is Required	Type
reservationNumber	Reservation Number	Hotel reservation confirmation number to be checked out.	False	string
roomNumber	Room Number	The number of the room from where the guest checks out. Can be specified as an alternative to reservation number. If both are specified, the reservation number takes precedence.	False	string
checkoutWithOpenFolio	Check-Out With Open Folio	Instructs the PMS whether to proceed with check-out even when the reservation has an open folio. The default value is true. For production systems, this needs to be set to false.	False	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
Info	When the command failed, this field provides additional information on the failure reason	string

Pre Check In (preCheckIn)

Performs Pre Check for a Guest associated with a hotel reservation/booking

Request Properties

Name	Display	Description	Is Required	Type
reservationNumber	Reservation Number	Hotel reservation confirmation number	True	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string

Fetch Document List (fetchDocumentList)

Retrieves the list of documents from a profile, given the name identifier.

Request Properties

Name	Display	Description	Is Required	Type
nameID	Name ID	The name identifier associated with the profile	True	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
documents.count	The number of documents associated with the profile	string
documents[0].number	The document number	string
documents[0].type	Type of the document as defined in OHIP system	string
documents[0].displaySequence	Display Sequence	string
documents[0].primary	Flag indicating whether this is the primary document for the associated profile	string
documents[0].issueDate	The date when the document was issued.	string
documents[0].expirationDate	The date when the document will expire.	string
documents[0].placeOfIssue	The city/consular's office that issued the document.	string
documents[0].countryOfIssue	The country of issuance.	string

Fetch Email List (fetchEmailList)

Retrieves the list of e-mail address records from a profile, given the name identifier.

Request Properties

Name	Display	Description	Is Required	Type
nameID	Name ID	The name identifier associated with the profile	True	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
emails.count	The number of email addressess associated with the profile	string
emails[0].address	The email address, in format user.account@server.name	string
emails[0].format	Email format to be used when sending emails to this address (HTML or TEXT).	string
emails[0].type	Type of the email address as defined in the OHIP system.	string
emails[0].displaySequence	Display Sequence	string
emails[0].primary	Flag indicating whether this is the primary email address for the associated provile	string

Fetch Phone List (fetchPhoneList)

Retrieves the list of phone numbers from a profile, given the name identifier.

Request Properties

Name	Display	Description	Is Required	Type
nameID	Name ID	The name identifier associated with the profile	True	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
phones.count	The number of phone numbers associated with the profile	string
phones[0].number	The phone number	string
phones[0].type	Type of the phone number as defined in the OHIP system	string
phones[0].displaySequence	Display Sequence	string
phones[0].primary	Flag indicating whether this is the primary phone number for the associated provile	string

Get Passport (getPassport)

Retrieves the passport information from a profile, given the name identifier.

Request Properties

Name	Display	Description	Is Required	Type
nameID	Name ID	The name identifier associated with the profile	True	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
number	The document number	string
type	Type of the document as a code (PP, DL, IC, etc).	string
displaySequence	Display Sequence	string
primary	Flag indicating whether this is the primary document for the associated profile	string
issueDate	The date when the document was issued.	string
expirationDate	The date when the document will expire.	string
placeOfIssue	The city/consular's office that issued the document.	string
countryOfIssue	The country of issuance.	string

Fetch Name (fetchName)

Retrieves the name record from a profile, including birthday and gender information, given the name identifier.

Request Properties

Name	Display	Description	Is Required	Type
nameID	Name ID	The name identifier associated with the profile	True	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
firstName	First name of the person	string
middleName	Middle name of the person	string
lastName	Last name of the person	string
birthdate	Birth date of the person	string
gender	Gender of the person	string
nationality	Nationality of the person	string
language	Language of the person	string
keywords.count	The number of keywords assoicated with the person	string
keywords[0].type	The type of the keyword assoicated with the person	string
keywords[0].value	The value of the keyword assoicated with the person	string

Fetch Profile (fetchProfile)

Retrieves entire profile information (including name details, email addresses and phone numbers) given the name identifier.

Request Properties

Name	Display	Description	Is Required	Type
nameID	Name ID	The name identifier associated with the profile	True	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
person.firstName	First name of the person	string
person.middleName	Middle name of the person	string
person.lastName	Last name of the person	string
person.birthdate	Birth date of the person	string
person.gender	Gender of the person	string
person.nationality	Nationality of the person	string
person.language	Language of the person	string
person.keywords.count	The number of keywords associated with the person	string
person.keywords[0].type	The type of the keyword associated with the person	string
person.keywords[0].value	The value of the keyword associated with the person	string
document.number	The document number	string
document.type	Type of the document as defined in the OHIP system	string
document.displaySequence	Display Sequence	string
document.primary	Flag indicating whether this is the primary document for the associated profile	string
document.issueDate	The date when the document was issued.	string
document.expirationDate	The date when the document will expire.	string
document.placeOfIssue	The city/consular's office that issued the document.	string
document.countryOfIssue	The country of issuance.	string
emails.count	The number of email addressess associated with the profile	string
emails[0].address	The email address, in format user.account@server.name	string
emails[0].format	Email format to be used when sending emails to this address (HTML or TEXT).	string
emails[0].type	Type of the email address as defined in the OHIP system	string
emails[0].displaySequence	Display Sequence	string
emails[0].primary	Flag indicating whether this is the primary email address for the associated provile	string
phones.count	The number of phone numbers associated with the profile	string
phones[0].number	The phone number	string
phones[0].type	Type of the phone number as defined in the OHIP system	string
phones[0].displaySequence	Display Sequence	string
phones[0].primary	Flag indicating whether this is the primary phone number for the associated provile	string
uDFs[0].valueName	User define field value name	string
uDFs[0].item	User define field item value	string
privacyField[0].optionType	Privacy option type	string
privacyField[0].optionValue	Privacy option value	string

Fetch Name UDFs (fetchNameUDFs)

Retrieves the list of user-defined field values from a profile, given the name identifier.

Request Properties

Name	Display	Description	Is Required	Type
nameID	NameID	Profile's name ID	True	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
uDFs[0].item	The UDF's value object	string
uDFs[0].valueName	The UDF's value name	string

Insert Email (insertEmail)

Adds an e-mail address record to a profile, given the name identifier and e-mail address to insert.

Request Properties

Name	Display	Description	Is Required	Type
nameID	Name ID	The name identifier associated with the profile	True	string
languageCode	Language Code	The language code used for the response message	False	string
email.address	Email address	The email address to insert, in format user.account@server.name	True	string
email.format	Email format to be used	Email format to be used when sending emails to this address (HTML or TEXT). If not specified, 'HTML' format is assumed.	False	string
email.type	Type of the email address	Type of the email address to insert as defined in the OHIP system. If not specified, it will use the value specified as Default Email Type in adapter properties. If this is not specified either, it will use EMAIL.	False	string
email.displaySequence	Display Sequence	Display Sequence. If not specified, 1 is assumed	False	string
email.primary	Primary	Flag indicating whether this is the primary email address for the associated profile. If not specified, false is assumed.	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
operaId	The unique ID (in OHIP system) of the inserted email address.	string

Insert Phone (insertPhone)

Adds a phone record to a profile, given the name identifier and phone number to insert.

Request Properties

Name	Display	Description	Is Required	Type
nameID	Name ID	The name identifier associated with the profile	True	string
languageCode	Language Code	The language code used for the response message	False	string
phone.number	Phone Number	The phone number to insert	True	string
phone.displaySequence	Display Sequence	Display Sequence. If not specified, 1 is assumed	False	string
phone.primary	Primary	Flag indicating whether this is the primary phone number for the associated profile. If not specified, false is assumed.	False	string
phone.type	Type of the phone number	Type of the phone number to insert as defined in the OHIP system. If not specified, it will use the value specified as Default Phone Type in adapter properties. If this is not specified either, it will use HOME.	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
operaId	The unique ID (in OHIP system) of the inserted phone number.	string

Insert/Update Address (insertUpdateAddress)

Adds or updates an address on a profile, given the name identifier and address information to insert or update.

Request Properties

Name	Display	Description	Is Required	Type
nameID	Name ID	The name identifier associated with the profile	True	string
languageCode	Language Code	The language code used for the response message	False	string
address.addressLine	Address line	Address as scanned from the document.	False	string
address.cityName	City Name	The guest's city of residence (from the address).	False	string
address.country	Address Country	The guest residence country (based on the address in the document). If not specified, or not mappable to a known ISO-3166 country, this field is ignored.	False	string
address.countryCode	Address Country Code	The ISO-3166 code of the guest residence country (based on the address in the document). If not specified, or not mappable to a known ISO-3166 country, this field is ignored; otherwise, it takes precedence over Address Country.	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
operaId	The unique ID (in OHIP system) of the address.	string

Insert Update Name UDFs (insertUpdateNameUDFs)

Adds to or modifies the list of user-defined field values in a profile, given the name identifier and a list of UDF records.

Request Properties

Name	Display	Description	Is Required	Type
nameID	NameID	Profile's name ID	True	string
udfValueName	UDF Value Name	UDF's value name. Must be valid from PMS perspective, otherwise the operation may fail.	True	string
udfItemValue	UDF Item Value	UDF's item value	True	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string

Insert/Update Document (insertUpdateDocument)

Adds or updates a document to a profile, given the name identifier and document information to insert or update.

Request Properties

Name	Display	Description	Is Required	Type
nameID	Name ID	The name identifier associated with the profile	True	string
languageCode	Language Code	The language code used for the response message	False	string
document.firstName	First Name	First Name on scanned document	False	string
document.lastName	Last Name	Last Name on scanned document	True	string
document.number	Document number	The document number	True	string
document.type	Type of the document	Type of the document as defined in OHIP system. Must be valid from PMS perspective, otherwise the operation may fail. If not specified, 'PASSPORT' is assumed.	False	string
document.gender	Gender	Gender as scanned from document. Possible values: M, F, Male, Female, male, female. Is anything else is typed in UNKNOWN will be used.	False	string
document.displaySequence	Display Sequence	Display Sequence	False	string
document.primary	Primary	Flag indicating whether this is the primary document for the associated profile	False	string
document.issueDate	Issue Date	The date when the document was issued, formatted as a Date/Time string recognized by UIP. For example, YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SS.	True	string
document.expirationDate	Expiration Date	The date when the document will expire, formatted as a Date/Time string recognized by UIP. For example, YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SS. If not specified, this field is ignored.	False	string
document.placeOfIssue	Place of issue	The local authority that has issued the document. Usually, this is the city where the document was issued. If not specified, this field is ignored.	False	string
document.countryOfIssue	Country of issue	The country that has issued the document. If not specified, or not mappable to a known ISO-3166 country, this field is ignored.	False	string
document.address.addressLine	Address line	Address as scanned from the document.	False	string
document.address.cityName	City Name	The guest's city of residence (from the address).	False	string
document.address.country	Address Country	The guest residence country (based on the address in the document). If not specified, or not mappable to a known ISO-3166 country, this field is ignored.	False	string
document.address.countryCode	Address Country Code	The ISO-3166 code of the guest residence country (based on the address in the document). If not specified, or not mappable to a known ISO-3166 country, this field is ignored; otherwise, it takes precedence over Address Country.	False	string
document.dateOfBirth	Date of Birth	The guest's date of birth, as scanned from the document.	False	string
document.nationality	Nationality	The guest nationality (the country of citizenship). If not specified, or not mappable to a known ISO-3166 country, this field is ignored	False	string
document.nationalityCode	Nationality code.	The ISO-3166 code of the guest nationality. If not specified, or not mappable to a known ISO-3166 country, this field is ignored; otherwise, it takes precedence over Nationality.	False	string
document.title	Title	Guest's title. Default values: Mr., Ms. or '' (empty).	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string

Update Passport (updatePassport)

Adds or modifies the passport record in a profile, given the name identifier and passport information.

Request Properties

Name	Display	Description	Is Required	Type
nameID	Name ID	The name identifier associated with the profile	True	string
languageCode	Language Code	The language code used for the response message	False	string
document.firstName	First Name	First Name on scanned document	False	string
document.lastName	Last Name	Last Name on scanned document	True	string
document.number	Document number	The document number	True	string
document.gender	Gender	Gender as scanned from document. Possible values: M, F, Male, Female, male, female. Is anything else is typed in UNKNOWN will be use.	False	string
document.displaySequence	Display Sequence	Display Sequence	False	string
document.primary	Primary	Flag indicating whether this is the primary document for the associated profile	False	string
document.issueDate	Issue Date	The date when the document was issued, formatted as a Date/Time string recognized by UIP. For example, YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SS.	True	string
document.expirationDate	Expiration Date	The date when the document will expire, formatted as a Date/Time string recognized by UIP. For example, YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SS. If not specified, this field is ignored.	False	string
document.placeOfIssue	Place of issue	The local authority that has issued the document. Usually, this is the city where the document was issued. If not specified, this field is ignored.	False	string
document.countryOfIssue	Country of issue	The country that has issued the document. If not specified, or not mappable to a known ISO-3166 country, this field is ignored.	False	string
document.dateOfBirth	Date of Birth	The guest's date of birth, as scanned from the document.	False	string
document.nationality	Nationality	The guest nationality (the country of citizenship). If not specified, or not mappable to a known ISO-3166 country, this field is ignored	False	string
document.nationalityCode	Nationality code.	The ISO-3166 code of the guest nationality. If not specified, or not mappable to a known ISO-3166 country, this field is ignored; otherwise, it takes precedence over Nationality.	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string

Assign Room (assignRoom)

Assign a room for the specified hotel reservation

Request Properties

Name	Display	Description	Is Required	Type
reservationNumber	Reservation Number	Hotel reservation confirmation number	True	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
info	When the command was succesful, this field contains the assigned room number	string
error	When the command failed, this field indicates the failure reason	string

Create Booking (createBooking)

Creates new booking

Request Properties

Name	Display	Description	Is Required	Type
firstName	First Name	First Name of the guest associated with the booking.	False	string
lastName	Last Name	Last Name of the guest associated with the booking.	True	string
adultsNumber	Adults Number	Adults Number for the booking. Must be a positive integer value. If a bad value is entered, 0 is assumed as default.	True	string
childrenNumber	Children Number	Children Number for the booking. Must be a positive integer value. If a bad value is entered, 0 is assumed as default.	True	string
roomTypeCode	Room Type Code	The hotel internal code for the room type the booking is intended to be performed to. Must be set to a correct value from the PMS perspective.	True	string
ratePlanCode	Rate Plan Code	The hotel internal code for the room rate the booking is intended to be performed to. Must be set to a correct value from the PMS perspective. If not specified, it will use the value specified as Default Rate Plan Code in adapter properties. If this is not specified either, it will use NR.	False	string
guaranteeType	Guarantee Type	The hotel code for the specific guarantee type used for the current booking. If not specified, it will use the value specified as Default Guarantee Type in adapter properties. If this is not specified either, it will use CO.	False	string
paymentMethodType	Payment Method Type	The hotel code for the specific payment type used for the current booking. If not specified, it will use the value specified as Default Payment Method in adapter properties. If this is not specified either, it will use CA.	False	string
startDate	Start Date	The start date (check-in date) of the booking to be created. Must be specified in yyyy-MM-dd format.	True	string
endDate	End Date	The end date (check-out date) of the booking to be created. Must be specified in yyyy-MM-dd format.	True	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
reservationNumber	Hotel reservation confirmation number	string
guestFullName	The full name of the guest associated with the hotel reservation	string
nameID	The profile name ID.	string

Create Additional Guest (createAdditionalGuest)

Creates a new additional guest for a specified reservation

Request Properties

Name	Display	Description	Is Required	Type
reservationNumber	Reservation Number	Hotel reservation confirmation number that the additional guest is to be registered under.	True	string
lastName	Last Name	Last Name of the additional guest.	True	string
middleNames	Middle Names	Middle Names of the additional guest, separated by colon (;)	False	string
firstName	First Name	First Name of the additional guest.	False	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
guestDetailID	Unique PMS identifier of the additional guest.	string

Combine Share (combineShare)

Combines two shared reservations.

Request Properties

Name	Display	Description	Is Required	Type
masterSharerResvID	Master share reservation ID.	The reservation ID of the master share reservation.	True	string
joinerSharerResvID	Joiner reservation ID	The reservation ID of the joiner reservation.	True	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
combineSharerResponse[0].reservationNumber	Hotel reservation confirmation number	string
combineSharerResponse[0].guestFullName	The full name of the guest associated with the hotel reservation	string
combineSharerResponse[0].nameID	The profile name ID.	string

Query Addons (queryAddons)

Fetches a list of the hotel packages (addons) that can be used for upgrading an existing booking.

Request Properties

Name	Display	Description	Is Required	Type
languageCode	Language Code	The language code used for the response message	False	string
startDate	Start Date	Start date to be used for the query, in format yyyy-MM-dd. The start date defaults to (Today - 1 year), when it wasn't specified, or a bad format was used, or specified a date earlier than (Today - 1 year).	False	string
endDate	End Date	End date to be used for the query, in format yyyy-MM-dd. The end date defaults to (Today + 1 year), when it wasn't specified, or a bad format was used, or specified a date later than (Today + 1 year). If the specified end date is earlier than the start date, then the end date is defaulted to (Start Date + 1 day).	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
packageGroups.count	The total number of package groups	string
packageGroups[0].code	The unique code of the package group	string
packageGroups[0].desc	The description of the package group	string
packageGroups[0].packageCodes.count	The number of packages within the package group	string
packageGroups[0].packageCodes[0]	The unique code of the package that belongs to the package group	string
packages.count	The total number of packages	string
packages[0].code	The unique code of the package	string
packages[0].shortDesc	Package short description	string
packages[0].desc	Package description	string
packages[0].longDesc	Package long description	string
packages[0].startDate	Start date for the package	string
packages[0].endDate	End date for the package	string
inventoryItemGroups.count	The total number of inventory item groups	string
inventoryItemGroups[0].groupCode	The unique code of the inventory item group	string
inventoryItemGroups[0].description	The description of the inventory item group	string
inventoryItemGroups[0].inventoryItems.count	The number of inventory items within the group	string
inventoryItemGroups[0].inventoryItems[0].code	The unique code of the inventory item	string
inventoryItemGroups[0].inventoryItems[0].name	The name of the inventory item	string
inventoryItemGroups[0].inventoryItems[0].desc	The description of the inventory item	string
inventoryItemGroups[0].inventoryItems[0].itemDate	The date of the inventory item	string
inventoryItemGroups[0].inventoryItems[0].itemGroupCode	The unique code of the group that this item belongs to (if any)	string
inventoryItemGroups[0].inventoryItems[0].itemGroupDescription	The description of the group that this item belongs to (if any)	string
inventoryItemGroups[0].inventoryItems[0].quantity	The available amount of the items of this kind	string

Query Booked Addons (queryBookedAddons)

Fetches a list of the options (addons) that are already addeed to an existing booking.

Request Properties

Name	Display	Description	Is Required	Type
reservationNumber	Reservation Number	Hotel reservation confirmation number	True	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
packages.count	The total number of booked packages	string
packages[0].id	The unique ID of the booked package	string
packages[0].code	The unique code of the booked package	string
packages[0].desc	Booked package description	string
packages[0].totalExpectedCharge	Total amount to be payed for all booked packages of this kind (taxes included)	string
packages[0].expectedCharges.count	Total amount of items that will be charged ofr this booked package	string
packages[0].expectedCharges[0].quantity	Total quantity of booked items	string
packages[0].expectedCharges[0].unitCharge	Charge for the booked item (tax not included)	string
packages[0].expectedCharges[0].unitTax	Tax for the booked item	string
packages[0].expectedCharges[0].startDate	Start date of charge interval for the booked item	string
packages[0].expectedCharges[0].endDate	End date of charge interval for the booked item	string
inventoryItems.count	The number of booked inventory items	string
inventoryItems[0].id	The unique code of the booked inventory item	string
inventoryItems[0].code	The unique ID of the booked inventory item	string
inventoryItems[0].name	The name of the booked inventory item	string
inventoryItems[0].desc	The description of the booked inventory item	string
inventoryItems[0].itemDate	The date of the booked inventory item	string
inventoryItems[0].itemGroup	The unique code of the group that this booked inventory item belongs to (if any)	string
inventoryItems[0].quantity	The total booked amount of the items of this kind	string

Update Booked Addons (updateBookedAddons)

Updates the list of the options (addons) that are already added to an existing booking. It can be also used to delete addons from a reservation.

Request Properties

Name	Display	Description	Is Required	Type
reservationNumber	Reservation Number	Hotel reservation confirmation number (required)	True	string
code	Code	Code of the addon to be updated (as returned by the QueryAddons or QueryBookedAddons command).	True	string
addonType	Addon Type	Type of the addon to be updated. Can be set to Inventory or Package. If not specified, it defaults to Package.	False	string
quantity	Quantity	The number of addons to be added or updated. If not specified, it defaults to 1 which means to add one addon of the specified type and code to the reservation. To delete addons from the reservation, specify quantity = 0.	False	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string

Fetch Housekeeping Room Status (fetchHousekeepingRoomStatus)

Retrieves property rooms and their Front Office and Housekeeping status such as VACANT, OCCUPIED, CLEAN, DIRTY, INSPECTED, and so on.

Request Properties

Name	Display	Description	Is Required	Type
roomNumber	Room Number	The room number we want the command to be executed for. If left empty, it is ignored. If an incorrect value is used, an RoomNotAvailable message will be returned.	False	string
roomTypeCode	Room Type Code	The room type code we want the command to be executed for. It is ignored when Room Number is specified. If left empty all room types are used. If an incorrect value is used a RoomNotAvailable message will be returned.	False	string
hkRoomStatus	Room Status	Cleaning status of the returned rooms. Must be one of these values: CLEAN, DIRTY, PICKUP, INSPECTED, OUTOFORDER, or OUTOFSERVICE. If left empty, the value will not be taken into consideration. If incorrect value typed in, an error is raised.	False	string
hkFosStatus	HouseKeeping Status	HouseKeeping Status of the returned rooms. Must be one of these values: VACANT or OCCUPIED. If left empty, the value will not be taken into consideration. If incorrect value typed in, an error is raised.	False	string
hkResvStatus	Reservation Status	Reservation Status of the returned rooms. Must be one of these values: ARRIVAL, ARRIVED, DAYUSE, DUEOUT, DEPARTED, NOTRESERVED, or STAYOVER. If left empty, the value will not be taken into consideration. If incorrect value typed in, an error is raised.	False	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
hkRoomsStatus[0].HouseKeepingStatus	HouseKeeping Status of the room	string
hkRoomsStatus[0].ReservationStatus	Reservation status of the room	string
hkRoomsStatus[0].RoomNumber	Room number	string
hkRoomsStatus[0].RoomStatus	Room status	string
hkRoomsStatus[0].RoomType	Room type	string

Get Room Info (getRoomInfo)

Returns the info for a room associated with a room number.

Request Properties

Name	Display	Description	Is Required	Type
roomNumber	Room Number	The room number	True	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
roomNumber	The room number	string
roomTypeCode	The type of the room (as code)	string
roomType	The type of the room (as full description)	string
roomRate	The room price per night	string
roomRateCurrency	The currency for the room rate	string
smokingAllowed	Indicates whether smoking is allowed or not in the room	string

Add Membership to Profile (addMembershipToProfile)

Adds a membership record to a profile, given the name identifier and membership information to insert.

Request Properties

Name	Display	Description	Is Required	Type
nameID	Name ID	The name identifier associated with the profile, the membership is added to.	True	string
memberName	Member Name	The name on the face of the membership card.	True	string
membershipType	Membership Type	The membership type code.	True	string
extSystemCode	External System Code	The code of the external system that provides the new membership number. If not specified, the Hotel ID adapter property value is used instead.	False	string
membershipClass	Membership Class	The membership class code.	False	string
membershipLevel	Membership Level	The membership level.	False	string
membershipNumber	Membership Number	The membership number.	False	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
membershipID	The ID of the newly added membership.	string
error	When the command failed, this field indicates the failure reason	string

Modify Booking With Membership (modifyBookingWithMembership)

Modifies an existing booking by adding a specific membership to it.

Request Properties

Name	Display	Description	Is Required	Type
reservationNumber	Reservation Number	The reservation number of the modified booking.	True	string
membershipType	Membership Type	The membership type associated with the modified reservation.	True	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
reservationNumber	Hotel reservation confirmation number	string
membershipNumber	The membershio number tied to current reservation.	string
guestFullName	The full name of the guest associated with the hotel reservation	string
nameID	The profile name ID of the guest associated with the hotel reservation.	string
memberships[0].MembershipType	The membership type.	string
memberships[0].MembershipNumber	The membership number.	string
memberships[0].MembershipClass	The membership class.	string
memberships[0].MembershipLevel	The membership level.	string
memberships[0].UsedInReservation	UsedInReservation flag.	string

Modify Booking (modifyBooking)

Modifies an existing booking

Request Properties

Name	Display	Description	Is Required	Type
reservationNumber	Reservation Number	The reservation number of the modified booking.	True	string
adultsNumber	Adults Number	Adults Number for the booking. Must be a positive integer value. If a bad value is entered, 0 is assumed as default.	True	string
childrenNumber	Children Number	Children Number for the booking. Must be a positive integer value. If a bad value is entered, 0 is assumed as default.	True	string
roomTypeCode	Room Type Code	The hotel internal code for the room type the booking is intended to be performed to. Must be set to a correct value from the PMS perspective.	True	string
ratePlanCode	Rate Plan Code	The hotel internal code for the room rate the booking is intended to be performed to. Must be set to a correct value from the PMS perspective. If left empty, the value specified in the adapter's setup page (field named Default Rate Plan Code for New Reservations) will be used. If that field is left empty too, the default value used is NR.	False	string
unitsNumber	Units Number	Number of rooms from the reservation.	True	string
startDate	Start Date	The start date (check-in date) of the booking to be created. Must be specified in yyyy-MM-dd format.	True	string
endDate	End Date	The end date (check-out date) of the booking to be created. Must be specified in yyyy-MM-dd format.	True	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
reservationNumber	Hotel reservation confirmation number	string
guestFullName	The full name of the guest associated with the hotel reservation	string
adultsNumber	The number of adults from the reservation	string
childrenNumber	The number of children from the reservation	string
nameID	The profile name ID of the guest associated with the hotel reservation.	string

Get Countries (getCountries)

Get the list of all known countries from the PMS

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
countries.count	The number of countries known to the PMS	string
countries[0].countryName	Country name	string
countries[0].countryCode	Country code	string

Get Currencies (getCurrencies)

Get the list of all known currencies from the PMS

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
currencies.count	The number of currencies known to the PMS	string
currencies[0].currencyName	Currency name	string
currencies[0].currencyCode	Currency code	string

Get Room Features (getFeatures)

Get the list of all known room features from the PMS

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
features.count	The number of room features known to the PMS	string
features[0].featureName	Feature name	string
features[0].featureCode	Feature code	string

Get Languages (getLanguages)

Get the list of all known languages from the PMS

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
languages.count	The number of languages known to the PMS	string
languages[0].languageName	Language name	string
languages[0].languageCode	Language code	string

Get Room Types (getRoomTypes)

Get the list of all room types available on the PMS

Request Properties

Name	Display	Description	Is Required	Type
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
roomTypes.count	The number of room types known to the PMS	string
roomTypes[0].roomType	Room Type description	string
roomTypes[0].roomTypeCode	Room Type code	string

Get Resort Room Types (getResortRoomTypes)

Get the list of all room types available on the PMS

Request Properties

Name	Display	Description	Is Required	Type
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
roomTypes.count	The number of room types known to the PMS	string
roomTypes[0].roomType	Room Type description	string
roomTypes[0].roomTypeCode	Room Type code	string

Get Credit Card Types (getCreditCardTypes)

Get the list of all credit card types available on the PMS

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
creditCardTypes.count	The number of credit card types known to the PMS	string
creditCardTypes[0].description	Credit Card Type description	string
creditCardTypes[0].code	Credit Card Type code	string

Get Phone Types (getPhoneTypes)

Get the list of all phone types available on the PMS

Request Properties

Name	Display	Description	Is Required	Type
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
phoneTypes.count	The number of phone types known to the PMS	string
phoneTypes[0].description	Phone Type description	string
phoneTypes[0].code	Phone Type code	string

Get Property Codes (getPropertyCodes)

Get the list of all property codes available on the PMS

Request Properties

Name	Display	Description	Is Required	Type
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
propertycodes.count	The number of phone types known to the PMS	string
propertycodes.description	Property Code description	string
propertycodes.value	Property Code value	string

Get Supported Features (getSupportedFeatures)

Reads a collection of the features supported by the PMS.

Request Properties

Name	Display	Description	Is Required	Type
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
features.count	The number of room features known to the PMS	string
features[0].featureName	Feature name	string
features[0].featureCode	Feature code	string
languages.count	The number of languages known to the PMS	string
languages[0].languageName	Language name	string
languages[0].languageCode	Language code	string
roomTypes.count	The number of room types known to the PMS	string
roomTypes[0].roomType	Room Type description	string
roomTypes[0].roomTypeCode	Room Type code	string
roomTypes[0].maxOccupancy	Maximum accomodated guest number.	string
currencies.count	The number of currencies known to the PMS	string
currencies[0].currencyName	Currency name	string
currencies[0].currencyCode	Currency code	string
countries.count	The number of countries known to the PMS	string
countries[0].countryName	Country name	string
countries[0].countryCode	Country code	string
resortRoomTypes.count	The number of room types known to the PMS	string
resortRoomTypes[0].roomType	Room Type description	string
resortRoomTypes[0].roomTypeCode	Room Type code	string
creditCardTypes.count	The number of credit card types known to the PMS	string
creditCardTypes[0].description	Credit card description (e.g. American Express)	string
creditCardTypes[0].code	Credit card type code (e.g. AMEX)	string
phoneTypes.count	The number of phone types known to the PMS	string
phoneTypes[0].description	Phone Type description	string
phoneTypes[0].code	Phone type code	string
propertyCodes.count	The number of property codes known to the PMS	string
propertyCodes[0].description	Property code description	string
propertyCodes[0].value	Property code value	string

Add Payment (addPayment)

Initiates a Credit Card Authorization operation

Request Properties

Name	Display	Description	Is Required	Type
reservationNumber	Reservation Number	Hotel reservation confirmation number	True	string
paymentType	Payment Type	The type of the credit card to use as payment method. Must use one of the credit card types defined in the OHIP system.	True	string
terminalCode	Terminal Code	The code of the terminal where the credit card is swiped	True	string
window	Window	The window number to be used for the operation. If not specified, 1 is assumed.	False	string
action	Action Type	The action to be associated with the operation. If not specified, 'KIOSK' is assumed.	False	string
requestedAmount	Requested Amount	Amount to be authorized on the credit card, as a decimal number. When we provide 0, or a negative amount, or no amount at all, we inquiry OHIP for the correct amount to use.	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
cardType	Credit card type	string
paymentType	Payment type	string
cardId	Credit card Id	string
cardNumber	Credit card number	string
expirationDate	Credit card expiration date	string
approvalCode	Approval code	string
approvalAmount	Approval amount	string

Register Payment (registerPayment)

Register an external payment

Request Properties

Name	Display	Description	Is Required	Type
reservationNumber	Reservation Number	The number of the reservation for which the payment was made.	True	string
transactionId	Transaction Id	Payment transaction ID. If not specified, it defaults to the reservation number.	False	string
authorizedAmount	Authorized Amount	Authorized transaction amount as received from external payment system.	True	string
transactionAmount	Transaction Amount	Requested transaction amount (might be different than the approval amount)	True	string
authorizationCode	Authorization Code	Authorization code as received from external payment system. Mandatory and relevant only for credit card payments.	False	string
maskedCardNumber	Masked Card Number	Credit card number used for payment. Must have 12..19 characters, consisting in digits [0-9] and X-es (mask characters). Mandatory and relevant only for credit card payments.	False	string
cardExpirationDate	Card Expiration Date	Credit card expiration date, in one of these formats: YYMM, MMYY, or YYYY-MM-DD. Mandatory and relevant only for credit card payments.	False	string
accountToken	Account Token	Account token as received from external payment system. Relevant only for credit card payments.	False	string
terminalCode	Terminal Code	The code of the terminal where the payment was made	True	string
paymentType	Payment Type	Credit card type used for payment, if this was a credit card payment. Leave empty for cash payments.	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string

Get Folio (getFolio)

Returns the folio (i.e. the billing info) for a room.

Request Properties

Name	Display	Description	Is Required	Type
reservationNumber	Reservation Number	Hotel reservation confirmation number	True	string
roomNumber	Room Number	The number of the room for which we're retriving the folio info	False	string
languageCode	Language Code	The language code used for the response message	False	string
invoiceAsPdf	Invoice As PDF	When set to true, it tries getting the invoice in PDF format. Default value is false. Currently OHIP does not have this capability, so this parameter is ignored.	False	string
window	Billing window	Billing window number to query. Must be an integer in range 1..8. If an empty, a non-integer, or an out-of-range value is specified, it defaults to 1.	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
reservationNumber	Hotel reservation confirmation number	string
guestFullName	The full name of the guest checked in to the room	string
checkInDate	The guest's check in date, formatted as yyyy-MM-dd	string
checkOutDate	The guest's check out date, formatted as yyyy-MM-dd	string
totalBillableAmount	The total amount to be payed for the room	string
currency	The currency in which the payment will be made	string
billDetails.count	The number of the items in the detailed billing info	string
billDetails[0].amount	The amount to be payed for the item in the detailed billing info	string
billDetails[0].desc	The description of the item in the detailed billing info	string
lastFourDigits	The last four digits of the credit card on file with the PMS.	string
folioPdfData	The folio in PDF format, in base-64 format, as provided by the OHIP PMS. Currently, OHIP cannot provide PDF invoices, so this will be empty.	string

Get Reservations (getReservations)

Retrieves the list of reservations expected to check-in or check-out on a certain date

Request Properties

Name	Display	Description	Is Required	Type
daysOffset	Days Offset	The number of days between today and the target lookup date. Must be in range 0..7, otherwise an error will be returned. When not specified, or when a non-integer value is used, 1 is assumed - that is, target lookup date == tomorrow.	False	string
timeZone	TimeZone	The time zone to be used for the reservations. If not specified, the adapter will look next for a value in the adapter's TimeZone property, and then in the hotel's PMS. If no time zone value is found UTC is assumed.	False	string
action	Action	The expected action to be done with the reservations. Can be either CHECKIN (get all reservations expected to check-in on the target lookup date) or CHECKOUT (get all reservations expected to check-out on the target lookup date). If not specified, or an invalid value was used, CHECKIN is assumed.	False	string
languageCode	Language Code	The language code used for the response message	False	string

Response Properties

Name	Description	Type
error	When the command failed, this field indicates the failure reason	string
reservations	Reservations	array
reservations.count	The number of reservations	string
reservations[0].reservationNumber	Hotel reservation confirmation number	string
reservations[0].reservationStatus	Status of the reservation, as returned by the OHIP PMS.	string
reservations[0].checkInDate	The check-in date of the guest, formatted as yyyy-MM-dd	string
reservations[0].checkOutDate	The check-out date of the guest, formatted as yyyy-MM-dd	string
reservations[0].guestLastName	The last name of the guest associated with the hotel reservation	string
reservations[0].guestFirstName	The first name of the guest associated with the hotel reservation	string
reservations[0].email	The email address, in format user.account@server.name	string

Release History