| WS Parameter | Required | Description | Additional Comments | Sample Data | Xpath for XML Message |
|---|---|---|---|---|---|
| Status | Y | Status of Message Request | A successful message will return a ID 2 with the text as being “PROCESSED”, otherwise an error will be returned indicating the failure | 2 | /passkeyRS/Message/Status/@ID |
| EventID | Y | Event ID | Unique ID for the entire event | 146021 | /passkeyRS/Data/AvailableInventory/HotelInventory/EventID |
| BlockID | Y | Block ID | This is a unique ID for the attendee ID. This is required to make a reservation using the Create Reservation, or to Modify a reservation. This is different than what would be supplied in a GetAvailability message for the AttendeeCode | 104585385 | /passkeyRS/Data/AvailableInventory/HotelInventory/BlockID |
| HotelID | Y | Hotel ID | This is the unique ID for the hotel. This is required to make a reservation using the Create Reservation, or to Modify a reservation. A text description will also be provided for the Hotel Name which can be used to Display information to the guest. | 136259 | /passkeyRS/Data/AvailableInventory/HotelInventory/HotelName/@HotelId |
| RoomTypeID | Y | Room Type ID | This is a unique ID for the room type along with a description. This would be required to make a reservation using Create Reservation or Modify a Reservation. A text description will also be provided for the Room Type Name which can be used to Display information to the guest. | 2018-12-03 | /passkeyRS/Data/AvailableInventory/HotelInventory/RoomName/@RoomTypeID |
| RoomTypeDescription | N | Room Type Description | This is a free form description text of the room type | /passkeyRS/Data/AvailableInventory/HotelInventory/RoomTypeDescription | |
| CurrencyID | Y | Currency which the rate information is being delivered in. | Please consult with the meeting planner or event owner to understand what the overall Event Currency. Please consult the ISO 4217 standard on currency code numbers | 840 | /passkeyRS/Data/AvailableInventory/HotelInventory/CurrencyID |
| MinNightStay | Y | This is the minimum number of nights the guest must stay in order to receive this rate | 1 | /passkeyRS/Data/AvailableInventory/HotelInventory/MinNightStay | |
| MaxPersons | Y | This is the maximum number of adults the hotel allows in this room type | 5 | /passkeyRS/Data/AvailableInventory/HotelInventory/MaxPersons | |
| CancelPolicy | Y | This is the cancel policy for this hotel / room type which should be displayed to the guest prior to creating the reservation | /passkeyRS/Data/AvailableInventory/HotelInventory/CancelPolicy | ||
| TaxDisclosure | Y | This text should be displayed with the rate information to the guest as it indicates policies by the hotel regarding taxes and fees. | /passkeyRS/Data/AvailableInventory/HotelInventory/TaxDisclosure | ||
| TaxIncluded | Y | This is a 0 (no) and 1 (yes) type of value and indicates if the taxes are included in the room rate. It still is a good practice to show the Tax Disclosure Policy to the guest since additional information may be defined. | 0 | /passkeyRS/Data/AvailableInventory/HotelInventory/TaxIncluded | |
| RoomRate | Y | This is the room for that specific night of the stay. Please refer to the Date to understand which night of the stay this applies to. | 199.0 | /passkeyRS/Data/AvailableInventory/HotelInventory/RoomRate | |
| AddPersonCharge | Y | This is the amount to be added to the base amount (RoomRate) for 2 guests in the room. | 0.0 | /passkeyRS/Data/AvailableInventory/HotelInventory/AddPersonCharge | |
| RoomRate3rd… Room Rate5thPlus | Y | This is the amount to be added to the base amount (RoomRate) for 2, 3, 4, and 5+ guests in the room. | 0.0 | /passkeyRS/Data/AvailableInventory/HotelInventory/RoomRate3rd /passkeyRS/Data/AvailableInventory/HotelInventory/RoomRate4th /passkeyRS/Data/AvailableInventory/HotelInventory/RoomRate5thPlus | |
| Date | Y | Date in which inventory and rate information is being supplied. | 2018-12-01-05:00 | /passkeyRS/Data/AvailableInventory/HotelInventory/Date | |
| RoomsAvailable | Y | This is the number of rooms which are available to be sold for this night. | 48 | /passkeyRS/Data/AvailableInventory/HotelInventory/RoomsAvailable |
Last updated on