Skip to content

S_ROOM_STATE_SEARCH_V01

This service searches for room states; the result set contains either a list of rooms or a specific room

Input (searchcriteria, all optional):

=> In case of no input criteria is given, a list of all configured rooms will be returned

  • 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:envgen="http://soapenvelopegenerator.eduardocastro.info/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 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_V01Request xmlns="http://www.gubse.com/IFS/test.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_V01Request>
</soapenv:Body>
</soapenv:Envelope>

Attributes Message

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

Response

<soapenv:Envelope xmlns:envgen="http://soapenvelopegenerator.eduardocastro.info/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 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_V01Response xmlns="http://www.gubse.com/IFS/test.xsd">
<!--Optional-->
<TransactionID>string</TransactionID>
<Result>
<Success>true or false</Success>
<!--Optional-->
<ErrorMsg>string</ErrorMsg>
<!--Optional-->
<MSG-LIST>
<!--Optional-->
<MSG-ENTRY>
<!--Optional-->
<MSG-LEVEL>ERROR or WARNING or INFO</MSG-LEVEL>
<!--Optional-->
<MSG-CLASS>string</MSG-CLASS>
<!--Optional-->
<MSG-NO>([0-9])*</MSG-NO>
<!--Optional-->
<MSG-TEXT>string</MSG-TEXT>
<!--Optional-->
<MSG-ENTRY-PARAM-LIST>
<!--Optional-->
<PARAM>
<!--Optional-->
<INDEX>([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>([0-9])*</ROOM-OBJID>
<room>string</room>
<floor>string</floor>
<status>string</status>
<category>string</category>
<housekeeping>string</housekeeping>
<maintenance>string</maintenance>
</roomState>
</S_ROOM_STATE_SEARCH_V01Response>
</soapenv:Body>
</soapenv:Envelope>

Attributes Response

Name Type
S_ROOM_STATE_SEARCH_V01Response
TransactionID string
Result Node
Success true or false
ErrorMsg string
MSG-LIST Node
roomState Node
ROOM-OBJID ([0-9])*
room string
floor string
status string
category string
housekeeping string
maintenance string