get Hotel Rooms (V1) (for assignment)
GET {{HostName}}/fof/v1/hotels/{{HotelId}}/rooms
To fetch rooms from OPERA
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
roomType | string | The room types of hotel rooms to be fetched | |
roomFeatureCode | string | A code representing a room feature | |
reservationId | string | A 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 | |
limit | string | Indicates maximum number of records a Web Service should return. | |
offset | string | Index 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. | |
roomNumberWildcard | string | ||
hotelRoomStatus | string | Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService | |
hotelRoomStatus | string | Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService | |
hotelRoomStatus | string | Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService | |
hotelRoomStatus | string | Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService | |
hotelRoomStatus | string | Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService | |
hotelRoomStatus | string | Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService | |
hotelFORoomStatus | string | Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied. | |
hotelFORoomStatus | string | Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied. | |
fromRoomNumber | string | From Room Number | |
toRoomNumber | string | To Room Number | |
hotelRoomStartDate | string | Start date of hotel rooms. | |
hotelRoomEndDate | string | End date of hotel rooms. | |
duration | string | Duration | |
roomClass | string | The room class of hotel rooms to be fetched | |
floor | string | The floor of room to be fetched | |
includeDueOut | string | This flag when set to true will include rooms assigned to due out reservations | |
departureTime | string | When IncludeDueOut is enable,it is the departure time before which to search | |
description | string | A code representing a room feature | |
orderSequence | string | Display Order sequence | |
quantity | string | Indicates quantity | |
smokingPreference | string | The smoking preference of room to be fetched | |
includeAllRoomConditions | string | This 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 | |
includeComponentRooms | string | This flag when set to true will include all component rooms | |
includePseudoRooms | string | This flag when set to true will include all pseudo rooms | |
includeOORoomCheck | string | This flag when set to true will work for Available Rooms functionality | |
connectingRoomsOnly | string | This flag when set to true will include only connecting rooms | |
reservationIdContext | string | Used to identify the source of the identifier (e.g., IATA, ABTA) | |
reservationIdType | string | A reference to the type of object defined by the UniqueID element | |
pseudoRoomsOnly | string | This flag when set to true will include only pseudo rooms | |
includeAttendentInRoom | string | This flag when set to true will includes attendent in Rooms | |
includeRotationRoom | string | This flag when set to true will return the rotation room when room roation parameter is active and the room type is configured for rotation. | |
ownerRoomsOnly | string | When 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 | |
ownerExclusiveRoomsOnly | string | When 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 | |
perfectFitRoomsOnly | string | When 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. | |
orderBy | string | A collection of supported sorting for available rooms search results | |
unitGradeCodes | string | Fetches rooms that matches requested unit grade codes. Only returns when Room Rotation and Unit Grade are active | |
ownerExclusiveRoomProfileId | string | This 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 | |
excludeRoomFeatures | string | It indicates to exclude rooms with the selected Room Feature(s).It allows alphanumeric values(e.g.,TUB,BOLCONY,MV) | |
excludeFloorPreferences | string | It 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
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
x-app-key | string | ||
x-hotelid | string |