Skip to content

Request for reservation search

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

RES-SEARCH

Direction

SIHOT.PMS ← SIHOT.WEB

Message

<?xml version="1.0" encoding="ISO-8859-1"?>
    <SIHOT-Document>
        <OC>RES-SEARCH</OC>
        <ID>1</ID>
        <TN>1</TN>
        <FROM>2014-05-07</FROM>
        <TO>2014-05-24</TO>
        <MATCHCODE></MATCHCODE>
        <NAME1></NAME1>
        <CENTRALGUEST-ID></CENTRALGUEST-ID>
        <SCOPE>EXPORTEXTENDEDCOMMENT;FORCECALCDAYPRICE;CALCSUMDAYPRICE</SCOPE>
    <FLAGS></FLAGS>
        <RT></RT>
        <E-MAIL></E-MAIL>
        <PIPELINE></PIPELINE>
        <MAX-ELEMENTS></MAX-ELEMENTS>
</SIHOT-Document>

Attributes Message

Attribute Description Data type
FROM Start date for the request Date
TO End date for the request Date
MATCHCODE Matchcode of the customer String
NAME1 name of the customer String
CENTRALGUEST-ID Central guest ID in HQ systems Unsigned long
FLAGS See below String
RT Reservation type Char
SCOPE See chapter 13.3.3 String
CENTRAL-RESERVATION-ID Central reservation ID in HQ systems Unsigned long
GDSNO GDS number String
OUTPUTCOUNTER Output counter of the reservations Short
GUEST-OBJID ID of an guest account Unsigned long
RESNO-FROM Starting reservation number of the search range Unsigned long
RESNO-TO Ending reservation number of the search range Unsigned long
E-MAIL Email address of a guest account String
PIPELINE

Possible values are:

‘0’ = orderer,

‘1’ = travel agency,

‘2’ = travel point,

‘3’ = conctact person,

‘4’ = all pipelines

The default value is ‘0’

Char
MAX-ELEMENTS The maximum number of reservations that will be returned Integer

FLAGS

Description of field <FLAGS>:

FLAGS Description
ALL-HOTELS Search in all hotels (ignoring the value of “ID”)
WITH-PERSONS Include persons (from rooming list)
DEFINITIVE If send, only definitive reservations are send. Combinable with the flag TENTATIVE.
TENTATIVE If send, only tentative reservations are send. Combinable with the flag DEFINITIVE.

SCOPE

Description of field <SCOPE>:

FLAG Description
EXPORTEXTENDEDCOMMENT write the extend comment
FORCECALCDAYPRICE list the prices for each day
CALCSUMDAYPRICE calculates the sum of the day price
CALCSUMDAYPRICEONPERSRATE calculates the sum of the day price for person rate

Response

After a RES-SEARCH request, SIHOT.PMS sends the following answer, similar to the request in chapter 13.3.3:

<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-Document>
    <OC>RES-SEARCH</OC>
    <RC>0</RC>
    <HAS-MORE-ELEMENTS/>
    <ARESLIST>
        <RESERVATION>
            <PRICE>99</PRICE>
            <RATE>
                <ISDEFAULT>Y</ISDEFAULT>
                <R>UF1</R>
                <PRICE>99</PRICE>
            </RATE>
            <PERSON>
                <SEX>0</SEX>
                <ROOM-SEQ>0</ROOM-SEQ>
                <ROOM-PERS-SEQ>0</ROOM-PERS-SEQ>
                <CITY>Schiffweiler</CITY>
                <DOB/>
                <EMAIL/>
                <COUNTRY>DE</COUNTRY>
                <NAME>GUBSE AG</NAME>
                <PERS-TYPE>1A</PERS-TYPE>
                <TITLE/>
                <COMMENT/>
                <ADDRESS/>
                <NAME2/>
                <PHONE/>
                <ZIP>66578</ZIP>
                <STREET/>
                <FAX/>
                <ARR>2009-02-23</ARR>
                <DEP>2009-03-01</DEP>
                <CAT/>
                <PCAT>EZ</PCAT>
                <RN>102</RN>
                <CENTRALGUEST-ID>0</CENTRALGUEST-ID>
                <MATCHCODE-ADM/>
                <EXT-REFERENCE/>
                <VOUCHERNUMBER/>
                <MATCHCODE/>
                <GUESTPROGRAMLIST>
                    <GUESTPROGRAM>
                        <HOTEL>1</HOTEL>
                        <GUESTPROGRAM-OBJID>115</GUESTPROGRAM-OBJID>
                        <CENTRAL-GUESTPROGRAM-ID>0</CENTRAL-GUESTPROGRAM-ID>
                        <ID>1</ID>
                        <DESCRIPTION>Wanderung</DESCRIPTION>
                        <FROM>2018-06-04</FROM>
                        <FROM-TIME>09:00:00</FROM-TIME>
                        <TO>2018-06-06</TO>
                        <TO-TIME>18:00:00</TO-TIME>
                        <MINPAX>2</MINPAX>
                        <MAXPAX>10</MAXPAX>
                        <NOPAX>2</NOPAX>
                        <STATE>ACTIVE</STATE>
                        <EXPIRYDATE>2018-06-03</EXPIRYDATE>
                        <CLOSINGDATE>2018-06-04</CLOSINGDATE>
                        <PRICE-INTERN>20</PRICE-INTERN>
                        <PRICE-EXTERN>0</PRICE-EXTERN>
                        <PARTICIPANT-STATE>DEFINITIVE</PARTICIPANT-STATE>
                    </GUESTPROGRAM>
                </GUESTPROGRAMLIST>
            </PERSON>
            <RESCHANNELLIST>
                <RESCHANNEL>
                    <IDX>0</IDX>
                    <MATCHCODE>GUBSE</MATCHCODE>
                    <CENTRALGUEST-ID>0</CENTRALGUEST-ID>
                    <CONTACT-ID>0</CONTACT-ID>
                    <COMMISSION>
                        <PC>0</PC>
                        <TOTAL>0</TOTAL>
                    </COMMISSION>
                </RESCHANNEL>
            </RESCHANNELLIST>
            <CHECKLIST>
                <CHECKLISTENTRY>
                    <TYPE>6</TYPE>
                    <DATE>2009-02-23</DATE>
                    <USER>ADM</USER>
                </CHECKLISTENTRY>
            </CHECKLIST>
            <APERS-TYPE-LIST>
                <PERS-TYPE>
                    <TYPE>1A</TYPE>
                    <NO>1</NO>
                </PERS-TYPE>
            </APERS-TYPE-LIST>
            <CCLIST/>
            <FIDELITYLIST/>
            <RES-HOTEL>1</RES-HOTEL>
            <RES-NR>20000003</RES-NR>
            <SUB-NR>1</SUB-NR>
            <OBJID>2</OBJID>
            <OUTPUTCOUNTER>1</OUTPUTCOUNTER>
            <RT>1</RT>
            <ALLOTMENT-NO>0</ALLOTMENT-NO>
            <GUARANTEE-TYPE/>
            <GUARANTEE-TYPE-DESC/>
            <CANCELLATION-POLICY/>
            <CANCELLATION-POLICY-DESC/>
            <ARR>2009-02-23</ARR>
            <DEP>2009-03-01</DEP>
            <ARR-TIME/>
            <DEP-TIME/>
            <CAT>EZ</CAT>
            <PCAT>EZ</PCAT>
            <CENTRAL-RESERVATION-ID>0</CENTRAL-RESERVATION-ID>
            <COMMENT/>
            <GDSNO/>
            <EXT-REFERENCE/>
            <EXT-KEY/>
            <LAST-MOD>2009-02-23</LAST-MOD>
            <MARKETCODE>F2</MARKETCODE>
            <MEDIA/>
            <SOURCE/>
            <CHANNEL/>
            <NN/>
            <NOPAX>1</NOPAX>
            <NOROOMS>1</NOROOMS>
            <PERS-TYPE>1A</PERS-TYPE>
            <DISCOUNT-GROUP/>
            <RATE-SEGMENT/>
            <T-POST-COMMISSION>0</T-POST-COMMISSION>
            <ASSIGNED-TO/>
            <DISABLE-DEPOSIT>N</DISABLE-DEPOSIT>
            <ADDRESS>0</ADDRESS>
            <CENTRALGUEST-ID>0</CENTRALGUEST-ID>
            <CITY>Schiffweiler</CITY>
            <COUNTRY>DE</COUNTRY>
            <DOB/>
            <EMAIL1>info@gubse.com</EMAIL1>
            <FAX1>+49 6821 9646 110</FAX1>
            <RT>2</RT>
            <LANG>DE</LANG>
            <MATCHCODE>GUBSE</MATCHCODE>
            <NAME2/>
            <NAME>GUBSE AG</NAME>
            <PHONE1>+49 6821 9646 0</PHONE1>
            <STREET>Bahnhofstr. 28</STREET>
            <ZIP>66578</ZIP>
            <DEPOSIT-DATE1/>
            <DEPOSIT-AMOUNT1>0</DEPOSIT-AMOUNT1>
            <DEPOSIT-DATE2/>
            <DEPOSIT-AMOUNT2>0</DEPOSIT-AMOUNT2>
            <DEPOSIT-DATE3/>
            <DEPOSIT-AMOUNT3>0</DEPOSIT-AMOUNT3>
            <IS-LOCKED>N</IS-LOCKED>
        </RESERVATION>
        <RESERVATION>
            <!-- same xml-fragment as above -->
        </RESERVATION>
    </ARESLIST>
</SIHOT-Document>

Attributes Response

Element Description Data type
HAS-MORE-ELEMENTS This attribute will be returned, if the attribute in the request was set. Specifies the number of other reservations, which fits the search criteria. Bool
PRICE Total price Decimal
PERSON One person of the rooming list
FIDELITYLIST Loyalty card list
RES-HOTEL Hotel number Long
RES-NR Reservation number Long
SUB-NR Sub-reservation number Short
OBJID Unique ID for this reservation Unsigned long
ALLOTMENT-NO Internal allotment number Long
GUARANTEE-TYPE Guarantee type String
CANCELLATION-POLICY Cancellation policy String
GUARANTEE-TYPE-DESC Guarantee type description String
CANCELLATION-POLICY-DESC Cancellation policy description String
NIGHTS Overnight stays Long
LAST-MOD Last modification date Date
LAST-MOD-BY Last modification user String
LAST-MOD-RU Last modification real user date Date
LAST-MOD-RU-BY Last modification real user String
MARKETCODE Market code String
ROOMINGLIST-STATISTICS Information about the rooming list
CREATION-DATE Creation date Date
CREATION-TIME Creation time Time
CREATED-BY Created by user String
SALES-DATE Sales Date Date
GUEST-OBJID Unique ID for the client Unsigned long
PERS-ADDRESS Salutation of the client Char
T-TITLE Title of the client. If the client is a company, T-TITLE is empty Char
TAX-NUMBER1 Tax number 1 String
TAX-NUMBER2 Tax number 2 String
TAX-NUMBER3 Tax number 3 String
MATCHCODE Matchcode String
MATCHCODE-SM Matchcode SOL Melia HQ String
INSURANCETYPE Insurance type String
VIP VIP String
VIP2 VIP2 String
ADDRESS-CORRESPONDENCE Correspondence address String
NAME-CORRESPONDENCE Correspondence name String
FIDELITYORDERLIST Loyalty card list client. Content like FIDELITYLIST
DEFINITIVE “on”, if reservation type is definitive String
CENTRALGUEST-ID Central guest ID of the client String
OPTIONAL “on”, if reservation type is tentative String
RESNO-FROM Smallest possible reservation number to search Long
RESNO-TO Biggest possible reservation number to search Long
SALES-CATEGORY The sales category for this reservation if the reservation was created for sales category String

FIDELITYLIST

Inside <FIDELITYLIST>, there are the following elements:

Element Description Data type
FC One loyalty card
FIDELITY-TYPE Loyalty card type String
FIDELITY-NO Loyalty card number String
VALIDFROM Valid from Date
VALIDTO Valid to Date
EXTREF Extern reference String
LEVEL Level String
STATE State String
STATECAUSE Cause of state String
TEXT Text String

ROOMINGLIST-STATISTICS

Inside ROOMINGLIST-STATISTICS, there are the following elements:

Element Description Data type
ROOMINGLISTISCOMPLETE Rooming list is complete = Y, otherwise = N String
NOADULTS Number of adults in the rooming list Short
NOCHILDS Number of children in the rooming list Short
NOADULTSFREE Number of adults in the rooming list for free Short
NOCHILDSFREE Number of children in the rooming list for free Short
ROOMNIGHTS Number of rooms * number of nights Short
PERSONNIGHTS Number of persons * number of nights Short

GUESTPROGRAM

See chapter 21.2.2

Element Description Data type
INVOICE Block with a single invoice information
HOTEL-NO Hotel number where the invoice was issued long
INVOICE-NO Invoice number long
INVOICE-NUMBERSET The invoice number set where the invoice was created in String
EXTERNAL-INVOICE-NO The external invoice number, if configured String

Return Codes (RC):

RC Description
0 The search was successful. If no reservation with the given search criteria was found, the element returns the respective information.
1 The data inside the element is not a valid reservation type.
2 There is no guest with this central guest ID available.
3 There is no guest with this matchcode available.
4 The given search data is not valid
5 An (internal) error occurred when searching for reservations.