Skip to content

ROOM STATE SEARCH V003

Service Reference Name: S_ROOM_STATE_SEARCH_V003

General

This service searches for room states. The result set contains either a list of rooms or a specific room. In case no input criteria is given, a list of all configured rooms will be returned.

Input

  • room as room number: empty field results a list of rooms related to the other search criteria or all rooms (see above)
  • category: room category; e.g. BD = Business Double
  • floor: floor the room is located
  • changesupplies: as housekeeping state defined in PMS; e.g. 04 - Room OK; 06 - Arrival Not Clean
  • maintenance: as technical state of the room, e.g. 57 - heater faulty,

All the parameters above beside room number are configurable and need to be requested from hotel in forehand

Output

  • room_number: number of the room
  • floor: location of the room, number of the floor as configured in SIHOT
  • status: status of room, e.g. not occupied, checked in with guest name, blocked
  • room_category: category of the room, e.g. BS (business single)
  • housekeeping_state: sanitation state of the room, e.g. 06 = arrival not clean
  • technical_state: technical state of the room, e.g. 99 = all ok

Direction

SIHOT.PMS ← IF Partner

Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:envgen="http://soapenvelopegenerator.eduardocastro.info/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soapenv:Header />
  <soapenv:Body>
    <S_ROOM_STATE_SEARCH_V003Request xmlns="http://www.gubse.com/IFS/SihotServices01.xsd"><!--Optional--><TransactionID>string</TransactionID>
      <Authentication>
        <SecurityID>string</SecurityID>
      </Authentication>
      <RoomSearch><!--Optional--><room>string</room><!--Optional--><category>string</category><!--Optional--><floor>string</floor><!--Optional--><housekeeping>string</housekeeping><!--Optional--><maintenance>string</maintenance>
      </RoomSearch>
    </S_ROOM_STATE_SEARCH_V003Request>
  </soapenv:Body>
</soapenv:Envelope>

Attributes Message

Name Type
S_ROOM_STATE_SEARCH_V003Request
TransactionID string
Authentication Node
SecurityID string
RoomSearch Node
room string
category string
floor string
housekeeping string
maintenance string

Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:envgen="http://soapenvelopegenerator.eduardocastro.info/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soapenv:Header />
  <soapenv:Body>
    <S_ROOM_STATE_SEARCH_V003Response xmlns="http://www.gubse.com/IFS/SihotServices01.xsd"><!--Optional--><TransactionID>string</TransactionID>
      <Result>
        <Success>Base: string Pattern: true or false</Success><!--Optional--><ErrorMsg>string</ErrorMsg><!--Optional--><MSG-LIST><!--Optional--><MSG-ENTRY><!--Optional--><MSG-LEVEL>Base: string Pattern: ERROR or WARNING or INFO</MSG-LEVEL><!--Optional--><MSG-CLASS>string</MSG-CLASS><!--Optional--><MSG-NO>Base: string Pattern: ([0-9])*</MSG-NO><!--Optional--><MSG-TEXT>string</MSG-TEXT><!--Optional--><MSG-ENTRY-PARAM-LIST><!--Optional--><PARAM><!--Optional--><INDEX>Base: string Pattern: ([0-9])*</INDEX><!--Optional--><VALUE>string</VALUE>
              </PARAM>
            </MSG-ENTRY-PARAM-LIST><!--Optional--><MSG-COMMENT>string</MSG-COMMENT><!--Optional--><MSG-SUPRESSED>string</MSG-SUPRESSED>
          </MSG-ENTRY>
        </MSG-LIST>
      </Result><!--Optional--><roomState>
        <ROOM-OBJID>Base: string Pattern: ([0-9])*</ROOM-OBJID>
        <room>string</room>
        <floor>Base: string minLength: 0 maxLength: 2</floor>
        <status>string</status>
        <category>string</category>
        <housekeeping>Base: string minLength: 0 maxLength: 2</housekeeping>
        <maintenance>string</maintenance><!--Optional--><bookingdata>
          <category>Base: string minLength: 0 maxLength: 4</category>
          <datefrom>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</datefrom>
          <dateto>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</dateto>
          <noofpax>Base: string Pattern: ([-+]){0,1}([0-9])*</noofpax>
          <noofnights>Base: string Pattern: ([-+]){0,1}([0-9])*</noofnights><!--Optional--><room>
            <ROOMINGLIST-OBJID>Base: string Pattern: ([0-9])*</ROOMINGLIST-OBJID><!--Optional--><Person>
              <PERSON-OBJID>Base: string Pattern: ([0-9])*</PERSON-OBJID>
              <persontype>Base: string minLength: 0 maxLength: 2</persontype>
              <name1>string</name1>
              <name2>Base: string minLength: 0 maxLength: 50</name2>
              <sex>string</sex>
              <title>string</title>
              <birthdate>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</birthdate>
              <address>string</address>
              <country>string</country>
              <city>Base: string minLength: 0 maxLength: 50</city>
              <street>Base: string minLength: 0 maxLength: 80</street>
              <postcode>Base: string minLength: 0 maxLength: 15</postcode>
              <subcountry>string</subcountry>
              <marketsegment>string</marketsegment>
              <salutation>string</salutation>
              <email1>Base: string minLength: 0 maxLength: 100</email1>
              <mobile1>Base: string minLength: 0 maxLength: 30</mobile1>
              <ratecategory>Base: string minLength: 0 maxLength: 4</ratecategory>
              <datefrom>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</datefrom>
              <dateto>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</dateto>
              <vip>Base: string minLength: 0 maxLength: 3</vip>
              <vip2>Base: string minLength: 0 maxLength: 3</vip2>
            </Person>
          </room>
        </bookingdata>
      </roomState>
    </S_ROOM_STATE_SEARCH_V003Response>
  </soapenv:Body>
</soapenv:Envelope>

Attributes Response

Name Type
S_ROOM_STATE_SEARCH_V003Response
TransactionID string
Result Node
Success Base: string Pattern: true or false
ErrorMsg string
MSG-LIST Node
MSG-ENTRY Node
MSG-LEVEL Base: string Pattern: ERROR or WARNING or INFO
MSG-CLASS string
MSG-NO Base: string Pattern: ([0-9])*
MSG-TEXT string
MSG-ENTRY-PARAM-LIST Node
PARAM Node
INDEX Base: string Pattern: ([0-9])*
VALUE string
MSG-COMMENT string
MSG-SUPRESSED string
roomState Node
ROOM-OBJID Base: string Pattern: ([0-9])*
room string
floor Base: string minLength: 0 maxLength: 2
status string
category string
housekeeping Base: string minLength: 0 maxLength: 2
maintenance string
bookingdata Node
category Base: string minLength: 0 maxLength: 4
datefrom Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})
dateto Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})
noofpax Base: string Pattern: ([-+]){0,1}([0-9])*
noofnights Base: string Pattern: ([-+]){0,1}([0-9])*
room Node
ROOMINGLIST-OBJID Base: string Pattern: ([0-9])*
Person Node
PERSON-OBJID Base: string Pattern: ([0-9])*
persontype Base: string minLength: 0 maxLength: 2
name1 string
name2 Base: string minLength: 0 maxLength: 50
sex string
title string
birthdate Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})
address string
country string
city Base: string minLength: 0 maxLength: 50
street Base: string minLength: 0 maxLength: 80
postcode Base: string minLength: 0 maxLength: 15
subcountry string
marketsegment string
salutation string
email1 Base: string minLength: 0 maxLength: 100
mobile1 Base: string minLength: 0 maxLength: 30
ratecategory Base: string minLength: 0 maxLength: 4
datefrom Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})
dateto Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})
vip Base: string minLength: 0 maxLength: 3
vip2 Base: string minLength: 0 maxLength: 3