get Hotel Rooms (V1) (for assignment)

GET {{HostName}}/fof/v1/hotels/{{HotelId}}/rooms

To fetch rooms from OPERA

Request Params

KeyDatatypeRequiredDescription
roomTypestringThe room types of hotel rooms to be fetched
roomFeatureCodestringA code representing a room feature
reservationIdstringA unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation
limitstringIndicates maximum number of records a Web Service should return.
offsetstringIndex or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.
roomNumberWildcardstring
hotelRoomStatusstringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService
hotelRoomStatusstringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService
hotelRoomStatusstringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService
hotelRoomStatusstringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService
hotelRoomStatusstringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService
hotelRoomStatusstringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService
hotelFORoomStatusstringSimple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.
hotelFORoomStatusstringSimple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.
fromRoomNumberstringFrom Room Number
toRoomNumberstringTo Room Number
hotelRoomStartDatestringStart date of hotel rooms.
hotelRoomEndDatestringEnd date of hotel rooms.
durationstringDuration
roomClassstringThe room class of hotel rooms to be fetched
floorstringThe floor of room to be fetched
includeDueOutstringThis flag when set to true will include rooms assigned to due out reservations
departureTimestringWhen IncludeDueOut is enable,it is the departure time before which to search
descriptionstringA code representing a room feature
orderSequencestringDisplay Order sequence
quantitystringIndicates quantity
smokingPreferencestringThe smoking preference of room to be fetched
includeAllRoomConditionsstringThis flag when set to true will include all room conditions, when set to false then room with "General Assignment" condition type will be excluded from the result
includeComponentRoomsstringThis flag when set to true will include all component rooms
includePseudoRoomsstringThis flag when set to true will include all pseudo rooms
includeOORoomCheckstringThis flag when set to true will work for Available Rooms functionality
connectingRoomsOnlystringThis flag when set to true will include only connecting rooms
reservationIdContextstringUsed to identify the source of the identifier (e.g., IATA, ABTA)
reservationIdTypestringA reference to the type of object defined by the UniqueID element
pseudoRoomsOnlystringThis flag when set to true will include only pseudo rooms
includeAttendentInRoomstringThis flag when set to true will includes attendent in Rooms
includeRotationRoomstringThis flag when set to true will return the rotation room when room roation parameter is active and the room type is configured for rotation.
ownerRoomsOnlystringWhen this flag is set to true, this API will fetch rooms which are contracted with owner profiles. This is supported when OPERA Control Room Rotation is active
ownerExclusiveRoomsOnlystringWhen this flag is set to true, this API will fetch rooms can only be used by the reservation's profile (owner) of the room. This is supported when OPERA Control Room Rotation is active
perfectFitRoomsOnlystringWhen this flag is set to true, this API will fetch only those rooms that have exactly Y nights free with the reservation guest(s) points.
orderBystringA collection of supported sorting for available rooms search results
unitGradeCodesstringFetches rooms that matches requested unit grade codes. Only returns when Room Rotation and Unit Grade are active
ownerExclusiveRoomProfileIdstringThis OPERA profile?s internal Id will be used with ownerExclusiveRoomOnly flag to return the room which own by this profile. This query parameter is supported when OPERA Control Room Rotation is active
excludeRoomFeaturesstringIt indicates to exclude rooms with the selected Room Feature(s).It allows alphanumeric values(e.g.,TUB,BOLCONY,MV)
excludeFloorPreferencesstringIt indicates to exclude rooms with the selected Floor(s) which are comma separated values.It allows alphanumeric values(e.g.,01,02,03,GROUND,five)

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
x-app-keystring
x-hotelidstring