Skip to content

Guest information

SIHOT.PMS can provide several types of information releated to guest. The idea is that SIHOT has the statistical/loyalty information. This can be gathered in order to present this to tgh guest.

Operationcode: GUEST-HISTORY

GUEST-HISTORY

Direction

SIHOT.PMS ← SIHOT.WEB

Message

SIHOT.WEB sends the following request (GUEST-HISTORY) to SIHOT.PMS in order to receive guest history data.

<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
        <OC>GUEST-HISTORY</OC>
        <TN>1</TN>
        <MATCHCODE>Match</MATCHCODE>
        <CENTRALGUEST-ID>3453<CENTRALGUEST-ID>
        <MANDATOR-NO>1<MANDATOR-NO>
        <FROM>2011-08-22</FROM>
        <TO>2011-08-23</TO>
        <SCOPE>DETAILED</SCOPE>
</SIHOT-DOCUMENT>

To find a specific guest generally, following elements are used in this given order:

Element Description Data type
CENTRALGUEST-ID Unique ID in an HQ environment Unsigned Long
MATCHCODE Unique matchcode of the guest String
OBJID Unique Object ID of the guest Unsigned Long

If no CENTRALGUEST-ID is given, the Matchcode is used. If no MATCHCODE is given, the ObjID is used. To search for this guest’s history data, following elements need to be set (they are all mandatory):

Element Description Data type
MANDATOR-NO Hotel number ( 0 means all hotels) Long
FROM Start date Date
TO End date Date
SCOPE = DETAILED means, that the guest history data is returned in a detailed form. If = ACCUMULATED, the data is returned in an accumulated form. String

Answer OC:GUEST-HISTORY-ANSWER

This is the answer GUEST-HISTORY-ANSWER for the request GUEST-HISTORY. There are two different types of answers, depending on the element (possible values are DETAILED or ACCUMULATED).

Details for DETAILED

<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
        <OC>GUEST-HISTORY-ANSWER</OC>
        <TN>1</TN>
        <RC>0</RC>
        <MSG>OK</MSG>
        <AHISTORY-LIST>
                <AHISTORY>
                        <MANDATOR-NO>GRANDHOTEL GUBSE</MANDATOR-NO>
                        <TEXT>Number of reservations</TEXT>
                        <FIGURE>5</FIGURE>
                </AHISTORY>
        </AHISTORY-LIST>
</SIHOT-DOCUMENT>

For this scope, the history data is returned for each hotel. The corresponding hotel name is returned inside the Element MANDATOR-NO (data type String!)

Details for ACCUMULATED

<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
        <OC>GUEST-HISTORY-ANSWER</OC>
        <TN>1</TN>
        <RC>0</RC>
        <MSG>OK</MSG>
        <AHISTORY-LIST>
                <AHISTORY>
                        <TEXT>Number of reservations</TEXT>
                        <FIGURE>70</FIGURE>
                </AHISTORY>
        </AHISTORY-LIST>
</SIHOT-DOCUMENT>

For this scope, the history data is returned accumulated for all hotels.

Guest history chronological

Direction

SIHOT.PMS ← SIHOT.WEB

Message OC:GUEST-HISTORY-CHRON

SIHOT.WEB sends the following request (GUEST-HISTORY-CHRON) to SIHOT.PMS in order to receive the guest history chronological data.

<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
        <OC>GUEST-HISTORY-CHRON</OC>
        <TN>1</TN>
        <MATCHCODE>Match</MATCHCODE>
        <CENTRALGUEST-ID>3453</CENTRALGUEST-ID>
        <MANDATOR-NO>1</MANDATOR-NO>
</SIHOT-DOCUMENT>

To find a specific guest generally, following elements are used in this given order:

Element Description Data type
CENTRALGUEST-ID Unique ID in an HQ environment Unsigned Long
MATCHCODE Unique Matchcode of the guest String
OBJID Unique Object ID of the guest Unsigned Long

If no CENTRALGUEST-ID is given, the Matchcode is used. If no MATCHCODE is given, the ObjID is used. To search for this guest’s history data, following elements need to be set (they are all mandatory): Search in period:

Element Description Data type
MANDATOR-NO Hotel number ( 0 means all hotels) Long
FROM Start date (alternatively Invoice Dates*) Date
TO End date Date

Search in period (invoice creation date):

Element Description Data type
MANDATOR-NO Hotel number ( 0 means all hotels) Long
INVOICE_FROM Start Date (Invoice created) Date
INVOICE_TO End Date Date

Answer OC:GUEST-HISTORY-CHRON-ANSWER

This is the answer GUEST-HISTORY-CHRON-ANSWER for the request GUEST-HISTORY-CHRON, sent by SIHOT.PMS.

<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
        <OC>GUEST-HISTORY-CHRON-ANSWER</OC>
        <TN>1</TN>
        <RC>0</RC>
        <MSG>OK</MSG>
        <AHISTORY-LIST>
                <AHISTORY>
                        <D></D>
                        <MANDATOR-NO></MANDATOR-NO>
                        <INVOICE-NO></INVOICE-NO>
                        <TURNOVER></TURNOVER>
                        <COMMISSION-TURNOVER></COMMISSION-TURNOVER>
                        <ROOM-NO></ROOM-NO>
                        <PRICE-TOTAL></PRICE-TOTAL>
                        <NONIGHTS></NONIGHTS>
                        <NOPAX></NOPAX>
                        <GDSNO></GDSNO>
                        <COMMISSION></COMMISSION>
                </AHISTORY>
        </AHISTORY-LIST>
</SIHOT-DOCUMENT>

Attributes

Element Description Data type
D Check out date Date
MANDATOR-NO Name of the hotel String
INVOICE-NO Invoice number Long
TURNOVER Total revenue of the stay Decimal
COMMISSION-TURNOVER Commissionable revenue Decimal
ROOM-NR Room number String
PRICE-TOTAL Room rate Decimal
NONIGHTS Number of nights Short
NOPAX Number of guests Short
GDSNO Reservation number Long
COMMISSION Commission paid on this invoice Decimal

Fidelity points

Direction

SIHOT.PMS ← SIHOT.WEB

Message OC:FIDELITY

SIHOT.WEB sends the following request (FIDELITY) to SIHOT.PMS in order to receive the fidelity data.

<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
        <OC>FIDELITY</OC>
        <TN>1</TN>
        <MATCHCODE>Match</MATCHCODE>
        <CENTRALGUEST-ID>3453</CENTRALGUEST-ID>
        <MANDATOR-NO>1</MANDATOR-NO>
</SIHOT-DOCUMENT>

To find a specific guest generally, following elements are used in this given order:

Element Description Data type
CENTRALGUEST-ID Unique ID in an HQ environment Unsigned Long
MATCHCODE Unique Matchcode of the guest String
OBJID Unique Object ID of the guest Unsigned Long

If no CENTRALGUEST-ID is given, the Matchcode is used. If no MATCHCODE is given, the ObjID is used. To search for this guest’s history data, following elements need to be set (they are all mandatory):

Element Description Data type
FROM Start date Date
TO End date Date

Answer OC:FIDELITY-ANSWER

This is the answer FIDELITY-ANSWER for the request FIDELITY, sent by SIHOT.PMS.

<?xml version="1.0" encoding="ISO-8859-1"?>
        <SIHOT-DOCUMENT>
        <OC>FIDELITY </OC>
        <TN>1</TN>
        <RC>0</RC>
        <ID>1</ID>
        <MSG>OK</MSG>
        <AFIDELITY-LIST>
                <AFIDELITY-HEADER>
                        <BALANCE></BALANCE>
                </AFIDELITY-HEADER>

                <FIDELITY>
                        <FIDELITY-TYPE></FIDELITY-TYPE>
                        <D></D>
                        <BALANCE></BALANCE>
                        <T-ORIGIN></T-ORIGIN>
                        <SOURCE></SOURCE>
                        <FIDELITY-NO></FIDELITY-NO>
                        <INVOICE-NO></INVOICE-NO>
                        <DESC></DESC>
                </FIDELITY>
        </AFIDELITY-LIST>
</SIHOT-DOCUMENT>
Element
AFIDELITY-HEADER
BALANCE
FIDELITY
FIDELITY-TYPE
D
BALANCE
T-ORIGIN
SOURCE
FIDELITY-NO
INVOICE-NO
DESC

Transmission of guest data

Direction

SIHOT.PMS ← SIHOT.WEB

Message OC:GUEST-DATA

SIHOT.WEB sends the following request (GUEST-DATA) to SIHOT.PMS in order to receive the guest data.

<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
        <OC>GUEST-DATA</OC>
        <TN>1</TN>
        <MATCHCODE>Match</MATCHCODE>
        <CENTRALGUEST-ID>3453</CENTRALGUEST-ID>
</SIHOT-DOCUMENT>

To find a specific guest generally, following elements are used in this given order:

Element Description Data type
CENTRALGUEST-ID Unique ID in an HQ environment Unsigned Long
MATCHCODE Unique Matchcode of the guest String
MATCHCODE-ADM Special Matchcode of the guest String
MATCHCODE-ISN Special Matchcode of the guest String
MATCHCODE-SM Special Matchcode of the guest String
OBJID Unique Object ID of the guest Unsigned Long
CONTACT-PERSON-FILTER This field takes a (;) separated list of contact person functions and returns only contact persons with the matching function. String
FLAGS Flags to influence the results in the answer. See table below. Elements are separated by a semicolon (;) String

If no CENTRALGUEST-ID is given, the Matchcode is used. If no MATCHCODE is given, the ObjID is used.

Available flags

Flag Description
RETURN-ALL-GUEST-COMMENTS All non-empty guest comments are returned in a separate block ACOMMENTLIST (see Transmission of Guests)
RETURN-ASSIGNED-AS-CONTACT-PERSON-LIST If this flag is passed in, for natural guest profiles a list will be returned where the guest is assigned as contact person.

Answer OC:GUEST

This is the answer to the request GUEST-DATA. The answer for this request is described in Transmission of Guests.

Message OC:GUEST-DATA_AES

By changing the OC from GUEST-DATA to GUEST-DATA _AES, you could request guests AES crypted (analogous to RES and RES_AES). You need to set the AES crypted data into a CONTENT-Block and the answer will contain the CONTENT-Block with the AES crypted answer (operation code GUEST_AES).

SIHOT.WEB sends the following request (GUEST-SEARCH) to SIHOT.PMS in order to receive data of one or more guests.

<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
    <OC>GUEST-SEARCH</OC>
    <TN>1</TN>
    <GUESTTYPE/>
    <MATCHCODE/>
    <MATCHCODE-ADM/>
    <MATCHCODE-ISN/>
    <MATCHCODE-SM/>
    <ADDRESS/>
    <NAME/>
    <NAME2/>
    <STREET/>
    <ZIP/>
    <CITY/>
    <COUNTRY/>
    <VIP/>
    <VIP2/>
    <MAX-ELEMENTS/>
    <SORT/>
    <MOTHER-COMPANY/>
    <GUESTNO/>
    <CENTRALGUEST-ID/>
    <ACCOUNTNO/>
    <IATA/>
    <PHONE1/>
    <PHONE2/>
    <EMAIL1/>
    <DOCUMENT-NO/>
    <CONTACT-PERSON-FILTER/>
    <FLAGS/>
</SIHOT-DOCUMENT>

Attributes

Element Description Data type
GUESTTYPE

Type of the Guest profile

‘1’ -> Guest

‘2’ -> Company

 Char
CENTRALGUEST-ID Unique ID in an HQ environment Unsigned Long
MATCHCODE Unique Matchcode of the guest String
MATCHCODE-ADM Special Matchcode of the guest String
MATCHCODE-ISN Special Matchcode of the guest String
MATCHCODE-SM Special Matchcode of the guest String
ADDRESS Address token char
NAME Surname String
NAME2 Forename String
STREET Street String
ZIP Postal code String
CITY City String
COUNTRY Country String
VIP VIP field of the guest String
VIP2 VIP2 field of the guest String
MAX-ELEMENTS Number of max elements allowed in the answer Long
SORT Key to sort the answer elements, see table below String
MOTHER-COMPANY Name of the mother company String
GUESTNO Guest number Long
CENTRALGUEST-ID ID of the guest in a HQ system Unsigned Long
ACCOUNTNO Account number of the client Long
IATA IATA Code for travel agencies String
PHONE1 Office telephone number String
PHONE2 Home telephone number String
EMAIL1 The email address of the guest String
DOCUMENT-NO Document number String
CONTACT-PERSON-FILTER This field takes a (;) separated list of contact person functions and returns only contact persons with the matching function. String
FLAGS Flags to influence the results in the answer. See table below. Elements are separated by a semicolon (;) String

Available flags

Flag Description
NO-LOCAL-GUESTS Only guests with a Centralguest-ID are returned
MATCH-EXACT-MATCHCODE In combination with a requested matchcode the result returns only the one element with the requested matchcode. Otherwise you could ask for every matchcode starting with “A” by sending MATCHCODE “A” only.
FIND-ALSO-DELETED-GUESTS Normally, deleted guests aren’t returned
FIND-GUESTS-WITH-EMPTY-MATCHCODE With this flag, only guests without matchcode are returned
RETURN-ALL-GUEST-COMMENTS All non-empty guest comments are returned in a separate block ACOMMENTLIST Transmission of guests changes
RETURN-ASSIGNED-AS-CONTACT-PERSON-LIST If this flag is passed in, for natural guest profiles a list will be returned where the guest is assigned as contact person.

Available sorting keys

Key Description
NAME Elements are sorted by NAME-1
GUESTNO Guest number
MATCHCODE Matchcode
ZIP Zip

This is the answer to the request GUEST-SEARCH. The answer for this request is described in Transmission of guests. For this request, the element described there contains an additional part at the end as follows. If there are more guests than included in the list, has the value true, otherwise false.

Guest log in

The GUEST-LOGIN request is used to check if the guest has entered his proper password in SIHOT.WEB.

Direction

SIHOT.PMS ← SIHOT.WEB

Message OC:GUEST-LOGIN

The structure of this request is similar to the GUEST-DATA request. See GUEST-DATA for more information. There is only one new field for the password:

Element Description Data type Usage
PASSWORD Password of this guest String Mandatory

Answer OC:GUEST

The answer is identical to the response of the GUEST-DATA.

Transmission of allotments for a guest

Direction

SIHOT.PMS ← SIHOT.WEB

Message OC:ALLOT

SIHOT.WEB sends the following request (ALLOTMENT) to SIHOT.PMS in order to receive all available allotment for the guest data.

<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
        <OC>ALLOT</OC>
        <TN>1</TN>
        <MATCHCODE>Match</MATCHCODE>
        <CENTRALGUEST-ID>3453</CENTRALGUEST-ID>
        <MANDATOR-NO>1</MANDATOR-NO>
</SIHOT-DOCUMENT>

If MANDATOR-NO is 0, the allotments for all hotels are transferred. If neither Matchcode nor Centralguest-ID are given, the same request as described in chapter 26 is returned.

Answer OC:ALLOT

The answer for this request is described in chapter 26 allotments.