Skip to content

Request for GUESTPROGRAM search

The request for guestprogram-search is only allowed for the interaction between SIHOT.WEB and SIHOT.PMS.

GUESTPROGRAM-SEARCH

Direction

SIHOT.PMS ← SIHOT.WEB

Message

<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-Document>
    <VER>2.0</VER>
    <OC>GUESTPROGRAM-SEARCH</OC>
    <ID>2650</ID>
    <TN>10711222</TN>
    <GUESTPROGRAMRQ>
        <FROM>2018-08-01</FROM>
        <TO>2018-08-31</TO>
        <SEARCHPERIOD>FROM-DATE</SEARCHPERIOD>
        <STATE>ACTIVE</STATE>
        <CLOSINGDATE-FROM/>
        <CLOSINGDATE-TO/>
        <EXPIRYDATE-FROM/>
        <EXPIRYDATE-TO/>
        <MAX-PAX>NOT-REACHED</MAX-PAX>
        <MIN-PAX>NOT-REACHED</MIN-PAX>
        <TEMPLATE-ID/>
        <DESCRIPTION/>
        <FLAGS>ALL-HOTELS</FLAGS>
        <IDLIST>
            <ID>2650</ID>
            <ID>2660</ID>
        </IDLIST>
        <GUESTPROGRAM-OBJID>4049614</GUESTPROGRAM-OBJID>
        <CENTRAL-GUESTPROGRAM-ID>12345678789</CENTRAL-GUESTPROGRAM-ID>
    </GUESTPROGRAMRQ>
</SIHOT-Document>

Attributes Message

Attribute Description Data type
OC Operation Code (Mandatory) String
ID Mandatory field identifies the hotel in which guest program is to be searched Unsigned long
GUESTPRROGRAMRQ Block for the search criteria

GUESTPROGRAMRQ

Element Description Data type
FROM Start of search period (Mandatory) Date
TO End of search period (Mandatory) Date
SEARCHPERIOD

Type of search period:

FROM-DATE Guestprogram start is in the search period (Default)
TO-DATE Guestprogram end is in the search period (Default)
OVERLAPPING Guestprogram cuts the search period
COMPLETE Guestprogram is included in the search period
String
STATE State of the guestprogram (ACTIVE, INACTIVE, CANCELED) String
CLOSINGDATE-FROM Closing date must be equal or after this date Date
CLOSINGDATE-TO Closing date must be equal or before this date Date
EXPIRYDATE-FROM Expiry date must be equal or after this date Date
EXPIRYDATE-TO Expiry date must be equal or before this date Data
MAX-PAX Maximum number of participants: ALL (default), REACHED or NOT-REACHED String
MIN-PAX Minimum number of participants: ALL (default), REACHED or NOT-REACHED String
TEMPLATE-ID ID of the guestprogram template String
DESCRIPTION Description of the guestprogram template String
FLAGS Flag ALL-HOTEL causes a search in all hotels. String
IDLIST List of IDs (hotels).
GUESTPROGRAM-OBJID ObjID of the guestprogram. All other criteria are ignored if greater than 0 Unsigned long
CENTRAL-GUESTPROGRAM-ID CentralID of the guestprogram. All other criteria are ignored if greater than 0 Unsigned long

Response

After a GUESTPROGRAM-SEARCH request, SIHOT.PMS sends the following

<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-Document>
    <SIHOT-Version>
        <Version></Version>
        <EXE></EXE>
    </SIHOT-Version>
    <OC>GUESTPROGRAM-SEARCH</OC>
    <RC>0</RC>
    <TN>10711222</TN>
    <MSG/>
    <GUESTPROGRAMLIST>
        <GUESTPROGRAM>
            <HOTEL>4600</HOTEL>
            <GUESTPROGRAM-OBJID>4049614</GUESTPROGRAM-OBJID>
            <CENTRAL-GUESTPROGRAM-ID/>
            <ID/>
            <DESCRIPTION/>
            <FROM>2018-08-1</FROM>
            <FROM-TIME>08:00</FROM-TIME>
            <TO>2013-08-1</TO>
            <TO-TIME>16:00</TO-TIME>
            <MINPAX>10</MINPAX>
            <MAXPAX>20</MAXPAX>
            <NOPAX>13</NOPAX>
            <STATE>ACTIVE</STATE>
            <EXPIRYDATE>2018-07-20</EXPIRYDATE>
            <CLOSINGDATE>2018-07-30</CLOSINGDATE>
            <PRICE-INTERN>20.00</PRICE-INTERN>
            <PRICE-EXTERN>30.00</PRICE-EXTERN>
        </GUESTPROGRAM>
        <GUESTPROGRAM>
                        …
        </GUESTPROGRAM>
    </GUESTPROGRAMLIST>
</SIHOT-Document>

Attributes Response

Element Description Data type
HOTEL Hotel of the guestprogram Unsigned long
GUESTPROGRAM-OBJID ObjID of the guestprogram Unsigned long
CENTRAL-GUESTPROGRAM-ID CentralID of the guestprogram Unsigned long
FROM Start of the guestprogram Date
FROM-TIME Start of the guestprogram Time
TO End of the guestprogram Date
TO-TIME End of the guestprogram Time
MINPAX Minimum number of participants Unsigned long
MAXPAX Maximum number of participants Unsigned long
NOPAX Number of participants Unsigned long
STATE State ( ACTIVE, INACTIVE, CANCELED) String
EXPIRYDATE Expiry date Date
CLOSINGDATE Closing date Date
PRICE-INTERN Price intern String
PRICE-EXTERN Price extern String
PARTICIPANT-STATE Status Participant if in the context of a person: DEFINITIVE, CANCELED or WAITINGLIST String