|
1
|
Partner retrieves reservation information to verify the entered guest
data or to gather mandatory reservation information and perform post
charges.
getReservations requests can be done by the following query
parameters:
- roomId
- Surname
- First letters of a surname
- keyTrack2 — room key data
Using the query parameter "roomId" or "surname" means that the
partner system knows the room number or the full surname or the
first letters of the surname of the guest. Typically in a
Restaurant, guests are asked to write down their room number or
surname and the waiter enters the data into the POS system which
then sends the inquiry to OPERA Cloud.
HSIA In-room Internet systems typically verify guest information
(such as the surname and the room number) for authentication so that
the guest is granted use of the Internet.
For this option, without posting charges, you can also use the
getReservations operation with query parameter "roomId" and / or
"surname" and compare the related results with the data the guest
enters in the HSIA login.
Inquiring the guest information using the "keyTrack2" data means that
the partner system reads a specific information string from the
guests room key (media) and sends the data as a "keyTrack2" query
parameter in the getReservations operation.
This functionality requires that the connected door lock system
provides the same data string to OPERA Cloud PMS during the room key
creation/activation.
In all above cases, OPERA Cloud sends related guest or reservation
information back in the API response. With this information, the
partner system can then send the charge to the guest's account using
the postBillingCharges API operation.
Note:
Partner systems that subscribe to receiving reservation
information using the CHECK-IN Business Event do not
necessarily need to use the getReservations operation prior
to sending charges.
However, the getReservations operation will confirm the reservation
is really checked in at the time of sending the charge.
|
getReservation
getReservations by RoomId
GET {{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations?searchType=InHouse&roomId=203
200 Response:
{
"reservations": {
"reservationInfo": [
{
"reservationIdList": [
{
"id": "147763",
"type": "Reservation"
},
{
"id": "2256244",
"type": "Confirmation"
}
],
"roomStay": {
"arrivalDate": "2024-01-08",
"departureDate": "2024-01-11",
"originalTimeSpan": {
"startDate": "2024-01-08",
"endDate": "2024-01-11"
},
"expectedTimes": {
"reservationExpectedArrivalTime": "2024-01-08 05:06:47.0",
"reservationExpectedDepartureTime": "2024-01-11"
},
"adultCount": 2,
"childCount": 0,
"roomClass": "STD",
"roomType": "DBL",
"numberOfRooms": 1,
"roomId": "203",
"roomOwnershipType": "Regular",
"ratePlanCode": "USRATE",
"rateAmount": {
"amount": 250,
"currencyCode": "USD"
},
"rateSuppressed": false,
"bookingChannelCode": "PMS",
"fixedRate": false,
"guarantee": {
"guaranteeCode": "CHECKED IN",
"shortDescription": "Checked In"
},
"balance": {
"amount": 0,
"currencyCode": "USD"
},
"roomTypeCharged": "DBL",
"roomNumberLocked": false,
"pseudoRoom": false
},
"reservationGuest": {
"givenName": "Jignesh",
"surname": "Jain",
"language": "EN",
"vip": {},
"address": {
"country": {
"code": "US"
}
},
"anonymization": {},
"accompanyGuests": [],
"guestRestricted": false,
"nameType": "Guest",
"id": "842813",
"type": "Profile"
},
"sharedGuests": [],
"attachedProfiles": [],
"reservationPaymentMethod": {
"paymentMethod": "CA"
},
"reservationFolioWindows": [],
"commissionsInfo": {
"commissionsPaid": false
},
"reservationIndicators": [
{
"indicatorName": "NOPOST"
},
{
"indicatorName": "DEPOSITCANCELLATION",
"count": 1
},
{
"indicatorName": "HISTORYFUTURE",
"count": 1
},
{
"indicatorName": "COMMUNICATION",
"count": 2
},
{
"indicatorName": "ASSOCIATEDPROFILES",
"count": 1
}
],
"roomStatus": "Inspected",
"sourceOfSale": {
"sourceType": "PMS",
"sourceCode": "SAND01CN"
},
"waitlist": {},
"advanceCheckIn": {
"advanceCheckedIn": false
},
"hotelId": "SAND01CN",
"hotelName": "OHIP Sandbox 1",
"roomStayReservation": true,
"createDateTime": "2024-01-08 05:04:54.0",
"lastModifyDateTime": "2024-01-08 05:06:47.0",
"reservationStatus": "InHouse",
"computedReservationStatus": "InHouse",
"walkInIndicator": false,
"commissionPayoutTo": "None",
"paymentMethod": "CA",
"preRegistered": false,
"openFolio": false,
"allowMobileCheckout": false,
"optedForCommunication": false
}
],
"totalPages": 1,
"offset": 20,
"limit": 20,
"hasMore": false,
"totalResults": 1
},
"links": [
{
"href": "https://mtucn1uat.hospitality-api.us-ashburn-1.ocs.oc-test.com/rsv/v1/hotels/SAND01CN/reservations",
"rel": "other",
"templated": false,
"method": "POST",
"operationId": "postReservation"
},
{
"href": "https://mtucn1uat.hospitality-api.us-ashburn-1.ocs.oc-test.com/rsv/v1/hotels/SAND01CN/reservations/147763",
"rel": "self",
"templated": false,
"method": "GET",
"operationId": "getReservation"
},
{
"href": "https://mtucn1uat.hospitality-api.us-ashburn-1.ocs.oc-test.com/rsv/v1/hotels/SAND01CN/reservations/147763",
"rel": "self",
"templated": false,
"method": "PUT",
"operationId": "putReservation"
}
]
}
getReservations by Surname
GET {{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations?surname=Jain&searchType=InHouse&=Reservation
200 Response:
Note: this example returns 2 Results = 2 reservations checked in with Surname = "JAIN"
{
"reservations": {
"reservationInfo": [
{
"reservationIdList": [
{
"id": "147764",
"type": "Reservation"
},
{
"id": "2256306",
"type": "Confirmation"
}
],
"roomStay": {
"arrivalDate": "2024-01-08",
"departureDate": "2024-01-11",
"originalTimeSpan": {
"startDate": "2024-01-08",
"endDate": "2024-01-11"
},
"expectedTimes": {
"reservationExpectedArrivalTime": "2024-01-08 05:19:27.0",
"reservationExpectedDepartureTime": "2024-01-11"
},
"adultCount": 2,
"childCount": 0,
"roomClass": "STD",
"roomType": "DBL",
"numberOfRooms": 1,
"roomId": "204",
"roomOwnershipType": "Regular",
"ratePlanCode": "USRATE",
"rateAmount": {
"amount": 250,
"currencyCode": "USD"
},
"rateSuppressed": false,
"bookingChannelCode": "PMS",
"fixedRate": false,
"guarantee": {
"guaranteeCode": "CHECKED IN",
"shortDescription": "Checked In"
},
"balance": {
"amount": 0,
"currencyCode": "USD"
},
"roomTypeCharged": "DBL",
"roomNumberLocked": false,
"pseudoRoom": false
},
"reservationGuest": {
"givenName": "Jignesh",
"surname": "Jain",
"language": "EN",
"vip": {},
"address": {
"country": {
"code": "US"
}
},
"anonymization": {},
"accompanyGuests": [],
"guestRestricted": false,
"nameType": "Guest",
"id": "842815",
"type": "Profile"
},
"sharedGuests": [],
"attachedProfiles": [],
"reservationPaymentMethod": {
"paymentMethod": "CA"
},
"reservationFolioWindows": [],
"commissionsInfo": {
"commissionsPaid": false
},
"reservationIndicators": [
{
"indicatorName": "NOPOST"
},
{
"indicatorName": "DEPOSITCANCELLATION",
"count": 1
},
{
"indicatorName": "HISTORYFUTURE",
"count": 1
},
{
"indicatorName": "COMMUNICATION",
"count": 2
},
{
"indicatorName": "ASSOCIATEDPROFILES",
"count": 1
}
],
"roomStatus": "Inspected",
"sourceOfSale": {
"sourceType": "PMS",
"sourceCode": "SAND01CN"
},
"waitlist": {},
"advanceCheckIn": {
"advanceCheckedIn": false
},
"hotelId": "SAND01CN",
"hotelName": "OHIP Sandbox 1",
"roomStayReservation": true,
"createDateTime": "2024-01-08 05:17:59.0",
"lastModifyDateTime": "2024-01-08 05:19:27.0",
"reservationStatus": "InHouse",
"computedReservationStatus": "InHouse",
"walkInIndicator": false,
"commissionPayoutTo": "None",
"paymentMethod": "CA",
"preRegistered": false,
"openFolio": false,
"allowMobileCheckout": false,
"optedForCommunication": false
},
{
"reservationIdList": [
{
"id": "147763",
"type": "Reservation"
},
{
"id": "2256244",
"type": "Confirmation"
}
],
"roomStay": {
"arrivalDate": "2024-01-08",
"departureDate": "2024-01-11",
"originalTimeSpan": {
"startDate": "2024-01-08",
"endDate": "2024-01-11"
},
"expectedTimes": {
"reservationExpectedArrivalTime": "2024-01-08 05:06:47.0",
"reservationExpectedDepartureTime": "2024-01-11"
},
"adultCount": 2,
"childCount": 0,
"roomClass": "STD",
"roomType": "DBL",
"numberOfRooms": 1,
"roomId": "203",
"roomOwnershipType": "Regular",
"ratePlanCode": "USRATE",
"rateAmount": {
"amount": 250,
"currencyCode": "USD"
},
"rateSuppressed": false,
"bookingChannelCode": "PMS",
"fixedRate": false,
"guarantee": {
"guaranteeCode": "CHECKED IN",
"shortDescription": "Checked In"
},
"balance": {
"amount": 0,
"currencyCode": "USD"
},
"roomTypeCharged": "DBL",
"roomNumberLocked": false,
"pseudoRoom": false
},
"reservationGuest": {
"givenName": "Jignesh",
"surname": "Jain",
"language": "EN",
"vip": {},
"address": {
"country": {
"code": "US"
}
},
"anonymization": {},
"accompanyGuests": [],
"guestRestricted": false,
"nameType": "Guest",
"id": "842813",
"type": "Profile"
},
"sharedGuests": [],
"attachedProfiles": [],
"reservationPaymentMethod": {
"paymentMethod": "CA"
},
"reservationFolioWindows": [],
"commissionsInfo": {
"commissionsPaid": false
},
"reservationIndicators": [
{
"indicatorName": "NOPOST"
},
{
"indicatorName": "DEPOSITCANCELLATION",
"count": 1
},
{
"indicatorName": "HISTORYFUTURE",
"count": 1
},
{
"indicatorName": "COMMUNICATION",
"count": 2
},
{
"indicatorName": "ASSOCIATEDPROFILES",
"count": 1
}
],
"roomStatus": "Inspected",
"sourceOfSale": {
"sourceType": "PMS",
"sourceCode": "SAND01CN"
},
"waitlist": {},
"advanceCheckIn": {
"advanceCheckedIn": false
},
"hotelId": "SAND01CN",
"hotelName": "OHIP Sandbox 1",
"roomStayReservation": true,
"createDateTime": "2024-01-08 05:04:54.0",
"lastModifyDateTime": "2024-01-08 05:06:47.0",
"reservationStatus": "InHouse",
"computedReservationStatus": "InHouse",
"walkInIndicator": false,
"commissionPayoutTo": "None",
"paymentMethod": "CA",
"preRegistered": false,
"openFolio": false,
"allowMobileCheckout": false,
"optedForCommunication": false
}
],
"totalPages": 1,
"offset": 20,
"limit": 20,
"hasMore": false,
"totalResults": 2
},
"links": [
{
"href": "https://mtucn1uat.hospitality-api.us-ashburn-1.ocs.oc-test.com/rsv/v1/hotels/SAND01CN/reservations",
"rel": "other",
"templated": false,
"method": "POST",
"operationId": "postReservation"
},
{
"href": "https://mtucn1uat.hospitality-api.us-ashburn-1.ocs.oc-test.com/rsv/v1/hotels/SAND01CN/reservations/147764",
"rel": "self",
"templated": false,
"method": "GET",
"operationId": "getReservation"
},
{
"href": "https://mtucn1uat.hospitality-api.us-ashburn-1.ocs.oc-test.com/rsv/v1/hotels/SAND01CN/reservations/147764",
"rel": "self",
"templated": false,
"method": "PUT",
"operationId": "putReservation"
}
]
}
getReservations by First letters of a surname
GET {{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations?searchType=InHouse&=Reservation&surname=Sa
200 Response:
{
"reservations": {
"reservationInfo": [
{
"reservationIdList": [
{
"id": "147749",
"type": "Reservation"
},
{
"id": "2255736",
"type": "Confirmation"
}
],
"roomStay": {
"arrivalDate": "2024-01-08",
"departureDate": "2024-01-08",
"originalTimeSpan": {
"startDate": "2024-01-08",
"endDate": "2024-01-08"
},
"expectedTimes": {
"reservationExpectedArrivalTime": "2024-01-07 21:59:31.0",
"reservationExpectedDepartureTime": "2024-01-08"
},
"adultCount": 1,
"childCount": 0,
"roomClass": "STD",
"roomType": "ECO",
"numberOfRooms": 1,
"roomId": "631",
"roomOwnershipType": "Regular",
"ratePlanCode": "BAR",
"rateAmount": {
"amount": 100,
"currencyCode": "USD"
},
"rateSuppressed": false,
"bookingChannelCode": "PMS",
"fixedRate": true,
"guarantee": {
"guaranteeCode": "CHECKED IN",
"shortDescription": "Checked In"
},
"marketCode": "LEISURE",
"sourceCode": "PHONE",
"sourceCodeDescription": "Telephone",
"balance": {
"amount": 0,
"currencyCode": "USD"
},
"roomTypeCharged": "ECO",
"roomNumberLocked": false,
"pseudoRoom": false
},
"reservationGuest": {
"givenName": "Sahil",
"middleName": "Ku.",
"surname": "Sahoo",
"language": "E",
"vip": {},
"address": {
"country": {}
},
"anonymization": {},
"accompanyGuests": [],
"guestRestricted": false,
"nameType": "Guest",
"id": "842782",
"type": "Profile"
},
"sharedGuests": [],
"attachedProfiles": [],
"reservationPaymentMethod": {
"paymentMethod": "CA"
},
"reservationFolioWindows": [],
"commissionsInfo": {
"commissionsPaid": false
},
"reservationIndicators": [
{
"indicatorName": "NOPOST"
},
{
"indicatorName": "COMMENT",
"count": 1
},
{
"indicatorName": "PACKAGEITEM",
"count": 1
},
{
"indicatorName": "DEPOSITCANCELLATION",
"count": 1
},
{
"indicatorName": "HISTORYFUTURE",
"count": 1
},
{
"indicatorName": "COMMUNICATION",
"count": 1
},
{
"indicatorName": "ASSOCIATEDPROFILES",
"count": 1
}
],
"roomStatus": "Inspected",
"sourceOfSale": {
"sourceType": "PMS",
"sourceCode": "SAND01CN"
},
"waitlist": {},
"advanceCheckIn": {
"advanceCheckedIn": false
},
"hotelId": "SAND01CN",
"hotelName": "OHIP Sandbox 1",
"roomStayReservation": true,
"createDateTime": "2024-01-07 21:58:36.0",
"lastModifyDateTime": "2024-01-07 22:04:19.0",
"reservationStatus": "InHouse",
"computedReservationStatus": "DueOut",
"walkInIndicator": false,
"commissionPayoutTo": "None",
"paymentMethod": "CA",
"preRegistered": false,
"openFolio": false,
"allowMobileCheckout": false,
"optedForCommunication": false
}
],
"totalPages": 1,
"offset": 20,
"limit": 20,
"hasMore": false,
"totalResults": 1
},
"links": [
{
"href": "https://mtucn1uat.hospitality-api.us-ashburn-1.ocs.oc-test.com/rsv/v1/hotels/SAND01CN/reservations",
"rel": "other",
"templated": false,
"method": "POST",
"operationId": "postReservation"
},
{
"href": "https://mtucn1uat.hospitality-api.us-ashburn-1.ocs.oc-test.com/rsv/v1/hotels/SAND01CN/reservations/147749",
"rel": "self",
"templated": false,
"method": "GET",
"operationId": "getReservation"
},
{
"href": "https://mtucn1uat.hospitality-api.us-ashburn-1.ocs.oc-test.com/rsv/v1/hotels/SAND01CN/reservations/147749",
"rel": "self",
"templated": false,
"method": "PUT",
"operationId": "putReservation"
}
]
}
getReservations by keysTrack2
GET {{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations?keyTrack2=10000234567890095025&searchType=InHouse
200 Response:
{
"reservations": {
"reservationInfo": [
{
"reservationIdList": [
{
"id": "147774",
"type": "Reservation"
},
{
"id": "2256485",
"type": "Confirmation"
}
],
"roomStay": {
"arrivalDate": "2024-01-09",
"departureDate": "2024-04-17",
"originalTimeSpan": {
"startDate": "2024-01-09",
"endDate": "2024-04-17"
},
"expectedTimes": {
"reservationExpectedArrivalTime": "2024-01-08 22:50:12.0",
"reservationExpectedDepartureTime": "2024-04-17"
},
"adultCount": 1,
"childCount": 0,
"roomClass": "STD",
"roomType": "ECO",
"numberOfRooms": 1,
"roomId": "670",
"roomOwnershipType": "Regular",
"ratePlanCode": "OPTTOOPR5",
"rateAmount": {
"amount": 100,
"currencyCode": "EUR"
},
"rateSuppressed": false,
"bookingChannelCode": "PMS",
"fixedRate": false,
"guarantee": {
"guaranteeCode": "CHECKED IN",
"shortDescription": "Checked In"
},
"marketCode": "INTERNAL",
"sourceCode": "INTERNAL",
"sourceCodeDescription": "Internal reservation",
"balance": {
"amount": 0,
"currencyCode": "USD"
},
"roomTypeCharged": "ECO",
"roomNumberLocked": false,
"pseudoRoom": false
},
"reservationGuest": {
"givenName": "Do NOT CHANGE",
"surname": "KeyCardTrack2",
"language": "E",
"vip": {},
"address": {
"country": {
"code": "GB"
}
},
"anonymization": {},
"accompanyGuests": [],
"guestRestricted": false,
"nameType": "Guest",
"id": "842847",
"type": "Profile"
},
"sharedGuests": [],
"attachedProfiles": [],
"reservationPaymentMethod": {
"paymentMethod": "CA"
},
"reservationFolioWindows": [],
"commissionsInfo": {
"commissionsPaid": false
},
"reservationIndicators": [
{
"indicatorName": "NOPOST"
},
{
"indicatorName": "COMMENT",
"count": 1
},
{
"indicatorName": "DEPOSITCANCELLATION",
"count": 1
},
{
"indicatorName": "HISTORYFUTURE",
"count": 1
},
{
"indicatorName": "COMMUNICATION",
"count": 1
},
{
"indicatorName": "ASSOCIATEDPROFILES",
"count": 1
}
],
"roomStatus": "Inspected",
"sourceOfSale": {
"sourceType": "PMS",
"sourceCode": "SAND01CN"
},
"waitlist": {},
"advanceCheckIn": {
"advanceCheckedIn": false
},
"hotelId": "SAND01CN",
"hotelName": "OHIP Sandbox 1",
"roomStayReservation": true,
"createDateTime": "2024-01-08 21:17:35.0",
"lastModifyDateTime": "2024-01-08 22:52:53.0",
"reservationStatus": "InHouse",
"computedReservationStatus": "Walkin",
"walkInIndicator": true,
"commissionPayoutTo": "None",
"paymentMethod": "CA",
"preRegistered": false,
"openFolio": false,
"allowMobileCheckout": false,
"optedForCommunication": false
}
],
"totalPages": 1,
"offset": 20,
"limit": 20,
"hasMore": false,
"totalResults": 1
},
"links": [
{
"href": "https://mtucn1uat.hospitality-api.us-ashburn-1.ocs.oc-test.com/rsv/v1/hotels/SAND01CN/reservations",
"rel": "other",
"templated": false,
"method": "POST",
"operationId": "postReservation"
},
{
"href": "https://mtucn1uat.hospitality-api.us-ashburn-1.ocs.oc-test.com/rsv/v1/hotels/SAND01CN/reservations/147774",
"rel": "self",
"templated": false,
"method": "GET",
"operationId": "getReservation"
},
{
"href": "https://mtucn1uat.hospitality-api.us-ashburn-1.ocs.oc-test.com/rsv/v1/hotels/SAND01CN/reservations/147774",
"rel": "self",
"templated": false,
"method": "PUT",
"operationId": "putReservation"
}
]
}
|
