Skip to content

Rate segment request

This request provides valid rate segments defined for a guest profile. Rate segments can be requested for a certain guest profile or for the TOP mother company of the given guest profile.

Operationcode: RATESEGMENT-REQUEST

RATESEGMENT-REQUEST

Direction

SIHOT.PMS ← SIHOT.WEB

Message

<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
        <OC>RATESEGMENT-REQUEST</OC>
        <ID>1</ID>
        <TN>1</TN>
        <VER>1.0</VER>
        <ARRIVAL-DATE>2016-10-17</ARRIVAL-DATE>
        <OBJID>OBJID1</OBJID>
        <MATCHCODE>MATCHCODE1</MATCHCODE>
        <MATCHCODE-ADM>MATCHCODE-ADM1</MATCHCODE-ADM>
        <MATCHCODE-ISN>MATCHCODE-ISN1</MATCHCODE-ISN>
        <MATCHCODE-SM>MATCHCODE-SM1</MATCHCODE-SM>
        <CENTRALGUEST-ID>CENTRALGUEST-ID1</CENTRALGUEST-ID>
       ``<FLAGS>``</FLAGS>
</SIHOT-DOCUMENT>

Attributes Message

Element Description Data type Usage
OC Action type: CGV = Check Gift Voucher String Mandatory
ID SIHOT.WEB ID of the hotel String Mandatory
TN Transaction number Integer Mandatory
VER Used version String Mandatory
MATCHCODE General guest match code String Optional
MATCHCODE-ADM Match code ADM from the guest profile String Optional
MATCHCODE-ISN Match code ISN from the guest profile String Optional
MATCHCODE-SM Match code SM from the guest profile String Optional
CENTRALGUEST-ID The guests central guest id String Optional
OBJID OBJID of the guest profile String Optional
ARRIVAL-DATE Arrival date when the rate segment should be valid String Optional
FLAGS Flags String Optional

Flags

Flag Description
GET-ALL-AVAILABLE-RATE-SEGMENTS If this flag will be passed in, all available rate segments will be returned. If this flag will not be passed in, only one matching rate segment will be returned.
CHECK-MOTHER-COMPANY If this flag is set, the rate segment of the top mother company of the provided guest profile will be checked. Otherwise only the given guest profile
CHECK-ALL-HOTELS If this flag is set, all hotels will be searched. Only available in combination with flag GET-ALL-AVAILABLE-RATE-SEGMENTS

Response

<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
        <SIHOT-Version>
                <Version>Version1</Version>
                <EXE>EXE1</EXE>
        </SIHOT-Version>
        <OC>RATESEGMENT-RESPONSE</OC>
        <ID>1</ID>
        <TN>1</TN>
        <VER>1.0</VER>
        <RC>0</RC>
        <MSG>OK</MSG>
        <RATESEGMENTDEFINITIONLIST>
                <RATESEGMENTDEFINITION>
                        <FROM-DATE>FROM-DATE1</FROM-DATE>
                        <TO-DATE>TO-DATE1</TO-DATE>
                        <HOTEL-NO>HOTEL-NO1</HOTEL-NO>
                        <RATE-SEGMENT>RATE-SEGMENT1</RATE-SEGMENT>
                </RATESEGMENTDEFINITION>
        </RATESEGMENTDEFINITIONLIST>
</SIHOT-DOCUMENT>

Attributes Response

Element Description Data type
ID SIHOT.WEB ID of the hotel String
TN Transaction number Integer
VER Used version String
RC Return code Integer
MSG Message to be shown to the SIHOT.PMS users String
FROM-DATE From date of the validity of the rate segment String
TO-DATE To date of the validity of the rate segment String
HOTEL-NO The Hotel number where this rate segment is valid, 0 = valid for all hotels String
RATE-SEGMENT Rate segment code String