Transmission of room occupancy

This request is used to retrieve the occupancy state for a given room in a given period.

Operationcode: ROOMOCCUPANCY

ROOMOCCUPANCY

Direction

SIHOT.PMS ← SIHOT.WEB

Message

<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
        <OC>ROOMOCCUPANCY</OC>
        <ID>1</ID>
        <FROM>2017-02-01</FROM>
        <TO>2017-02-28</TO>
        <RN>201</RN>
</SIHOT-DOCUMENT>

Attributes Message

Attribute	Description	Data type	Usage
ID	Hotel ID	Long	Mandatory
FROM	Start date for the request	Date	Mandatory
TO	End date for the request	Date	Mandatory
RN	Room number	String	Mandatory

Response

<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-Document>
    <OC>ROOMOCCUPANCY</OC>
    <ID>1</ID>
    <RN>201</RN>
    <RC>0</RC>
    <OCCUPANCYLIST>
        <OCCUPANCY>
            <FROM>2017-02-01</FROM>
            <TO>2017-02-02</TO>
            <STATE>OCCUPIED</STATE>
            <PERSON>
                <NAME1>Conrad</NAME1>
                <NAME2>Jochen</NAME2>
            </PERSON>
        </OCCUPANCY>
        <OCCUPANCY>
            <FROM>2017-02-02</FROM>
            <TO>2017-02-05</TO>
            <STATE>OCCUPIED</STATE>
            <PERSON>
                <NAME1>Berger</NAME1>
                <NAME2>Jörg</NAME2>
            </PERSON>
        </OCCUPANCY>
        <OCCUPANCY>
            <FROM>2017-02-10</FROM>
            <TO>2017-02-14</TO>
            <STATE>OCCUPIED</STATE>
            <PERSON>
                <NAME1>Wernet</NAME1>
                <NAME2>Norbert</NAME2>
            </PERSON>
        </OCCUPANCY>
        <OCCUPANCY>
            <FROM>2016-10-27</FROM>
            <TO>2017-02-01</TO>
            <STATE>FREE</STATE>
        </OCCUPANCY>
        <OCCUPANCY>
            <FROM>2017-02-05</FROM>
            <TO>2017-02-07</TO>
            <STATE>FREE</STATE>
        </OCCUPANCY>
        <OCCUPANCY>
            <FROM>2017-02-14</FROM>
            <TO>2025-12-31</TO>
            <STATE>FREE</STATE>
        </OCCUPANCY>
        <OCCUPANCY>
            <FROM>2017-02-07</FROM>
            <TO>2017-02-10</TO>
            <STATE>LOCKED</STATE>
        </OCCUPANCY>
    </OCCUPANCYLIST>
</SIHOT-Document>

Attributes Response

Attribute	Description	Data type
ID	Hotel ID	Long
RN	Room number	String
RC	return code for this request: 0..OK 1..an error occurred, see <MSG>	Long
MSG	If <RC> is 1, this element contains the error message	String
OCCUPANCYLIST	List of occupancy values	XML block
OCCUPANCY	Block with single occupancy data	XML block
FROM	Start date of the current occupancy record, might be smaller than the requested from-date if the first occupancy record starts earlier	Date in ISO format
TO	End date of the current occupancy record, might be larger than the requested to-date for the last occupancy record	Date in ISO format
STATE	State of the occupancy record in user readable text form: OCCUPIED FREE LOCKED	String
PERSON	Block with guest data, if room is occupied	XML block
PERSON/NAME1	Surname of the guest	String
PERSON/NAME2	Given name of the guest	String