get Room Interface Status

GET {{HostName}}/fof/v1/hotels/{{HotelId}}/interfaces/{{InterfaceId}}/roomStatuses

Request Params

KeyDatatypeRequiredDescription
interfaceNamestringName of the Hotel Interface
interfaceTypestringXML Posting Interface
Bms", "Cas", "Ccw", "Dls", "Eft", "Exp", "Mak", "Mbs", "Msc", "Pbx", "Pos", "Svs", "Tik", "Vid", "Vms", "Www", "Xml"
logostringHotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create
machineNamestringUnique machine name of the running IFC
statusstringStatus of the Hotel Interface either STOPPED or RUNNING
statusstringStatus of the Hotel Interface either STOPPED or RUNNING
statusstringStatus of the Hotel Interface either STOPPED or RUNNING
statusstringStatus of the Hotel Interface either STOPPED or RUNNING
statusstringStatus of the Hotel Interface either STOPPED or RUNNING
statusstringStatus of the Hotel Interface either STOPPED or RUNNING
statusstringStatus of the Hotel Interface either STOPPED or RUNNING
activeFlagstringIndicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.
codestringCode
blockIdstringA 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
blockIdContextstringUsed to identify the source of the identifier (e.g., IATA, ABTA)
blockIdTypestringA reference to the type of object defined by the UniqueID element
roomIdstringWild card search value for Room number
lastNamestringWild card search value to lookup reservations with this last name
firstNamestringWild card search value to lookup reservations with this first name
reservationIdsstringA 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
reservationIdsContextstringUsed to identify the source of the identifier (e.g., IATA, ABTA)
reservationIdsTypestringA reference to the type of object defined by the UniqueID element
arrivalEndstringThe ending value of the date range
arrivalStartstringThe starting value of the date range
expectedArrivalEndTimestringThe ending value of the time span
expectedArrivalStartTimestringThe starting value of the time span
specialCodesstringSpecial Codes
floorCodesstringFloor Codes
roomFeatureCodesstringRoom Feature Codes
roomClassCodesstringRoom Class Codes
roomStatusstringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
roomStatusstringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
roomStatusstringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
roomStatusstringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
roomStatusstringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
roomStatusstringSimple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
guaranteeCodestringInclude reservations that have Guarantee Code(Reservation Type) only
reservationStatusstringReservation status type for reservations search
reservationStatusstringReservation status type for reservations search
reservationStatusstringReservation status type for reservations search
reservationStatusstringReservation status type for reservations search
reservationStatusstringReservation status type for reservations search
reservationStatusstringReservation status type for reservations search
reservationStatusstringReservation status type for reservations search
reservationStatusstringReservation status type for reservations search
includeLinkedReservationsstringInclude linked reservations
includeBlocksstringInclude reservations attached to a block
orderBystringA collection of supported sorting for Room Interface Status search results
orderBystringA collection of supported sorting for Room Interface Status search results
orderBystringA collection of supported sorting for Room Interface Status search results
orderBystringA collection of supported sorting for Room Interface Status search results
orderTypestringOrder Type
orderTypestringOrder Type
expectedReturnEndTimestringThe ending value of the time span
expectedReturnStartTimestringThe starting value of the time span
advanceCheckedInstringShows whether reservation is in Advance CheckIn state.
guaranteeCodesstringFetches the reservation having Guarantee Codes(Reservation Type) supplied here. Example guaranteeCodes=6PM"

HEADERS

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