Rates
Standard day rates
Operationcode: RATE
RATE
Direction
SIHOT.PMS → SIHOT.WEB (OC:RATE)
SIHOT.PMS ← SIHOT.WEB (OC:GET-RATES)
Message OC:GET-RATES
To request a full rate update, you could use this simple request. Example:
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-Document>
<TN>8</TN>
<ID>1</ID>
<OC>GET-RATES</OC>
</SIHOT-Document>
Attributes Message
The answer to this request is the same as descried in chapter <OC>RATE</OC>
Response
The standard day rates (RATE) for a defined service, as the case may be several services, are directly sent by SIHOT.PMS to SIHOT.WEB.
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
<OC>RATE</OC>
<ID>1</ID>
<TN>1</TN>
<RC>0</RC>
<ARATELIST>
<RATE>
<CURRENCY>EUR</CURRENCY>
<SID>VP</SID>
<ARR-SERVICE>A</ARR-SERVICE>
<PRICE-PER>P</PRICE-PER>
<RADIO-CHECK>R</RADIO-CHECK>
<PRICE-REQUEST>N</PRICE-REQUEST>
<ORDER>XY</ORDER>
<TYPE>LO</TYPE>
<MIN-PAX>1</MIN-PAX>
<MAX-PAX>1</MAX-PAX>
<MIN-STAY>0</MIN-STAY>
<MAX-STAY>100</MAX-STAY>
<PREBOOKING>7</PREBOOKING>
<RESTRICT-RHYTHM>J7</RESTRICT-RHYTHM>
<TXT>
<LANG>de</LANG>
<T>Vollpension</T>
<DESC>Beschreibung Vollpension</DESC>
<CANCEL>Beschreibung Stornobedingungen Vollpension</CANCEL>
</TXT>
<TXT>
<LANG>en</LANG>
<T>Full board</T>
</TXT>
<R>
<CAT>EZ</CAT>
<DAY-PRICE>
<D>2003-08-24</D>
<PPU>1112.00</PPU>
</DAY-PRICE>
<DAY-PRICE>
<D>2003-08-25</D>
<PPU>1114.00</PPU>
</DAY-PRICE>
<PERS-TYPE>
<TYPE>
<DAY-PRICE>
<D>2003-08-25</D>
<PPU>1114.00</PPU>
</DAY-PRICE>
</TYPE>
</PERS-TYPE>
</R>
<R>
<CAT>DZ</CAT>
<DAY-PRICE>
<D>2003-08-26</D>
<PPU>165.00</PPU>
</DAY-PRICE>
<DAY-PRICE>
<D>2003-08-27</D>
<PPU>166.00</PPU>
</DAY-PRICE>
</R>
</RATE>
</ARATELIST>
</SIHOT-DOCUMENT>
Attributes Message
<RATE> contains the characteristics of a package/service:
| Attribute | Description | Data type |
|---|---|---|
| SID | Short form of the service | String |
| CURRENCY | The currency used for this rate | String |
| ORDER | Contains the order in which the services will be displayed. | Short |
| TYPE | Type of the package/service, types are available through zoom type 32 | String |
| ARR-SERVICE | A = arrangement S = service |
Char |
| PRICE-PER | P = rate per person R = rate per room U = rate per number (not implemented yet) |
Char |
| RADIO-CHECK | R = radio button, only one of these services may be booked. C = checkbox, so many of this services may be booked, as are wished. |
Char |
| PRICE-REQUEST | Y = rate request to SIHOT.PMS necessary. N = rate request not necessary. |
Char |
| MIN-PAX | Minimal number of PAX necessary for this package. | |
| This attribute is only set if |
Integer | |
| MAX-PAX | Maximal number of PAX allowed for this package.See also MIN-PAX | Integer |
| MIN-STAY | Minimal number of days necessary for this package per stay. | |
| This attribute is only set if |
Integer | |
| MAX-STAY | Maximal number of days allowed for this package per stay. | |
| See also MIN-STAY | Integer | |
| RESTRICT-RHYTHM | Rhythm of the restrictions (for instance J7 stands for a period, that is a multiple of 7 days) | Integer |
| PREBOOKING | Necessary pre-booking time in days for this package. | |
| This attribute is only set if |
Integer | |
| TXT | Block with comments in different languages | |
| LANG | Language code for the description | String |
| T | Short package/service description | String |
| DESC | Long comment of the package/service. | String |
| CANCEL | Cancellation conditions of the service/arrangement. | String |
| R | Rate block containing the rate data for each category and day | |
| CAT | Category | String |
| DAY-PRICE | Block containing the rates for each day | |
| D | Day when the rate is valid | Date |
| PPU | = Price per unit, rate for this package at this day and this category | Decimal |
| PERS-TYPE | Block with special person type rates | |
| TYPE | Person type | String |
<TXT> is not required. The elements <ARR-SERVICE>,<PRICE-PER>,
<RADIO-CHECK>, <PRICE-REQUEST> and <ORDER> are only used in
SIHOT.PMS and therefore external systems have not to note these
elements.
Response
This is the answer of SIHOT.WEB.
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
<VER>2.0</VER>
<OC>RATE</OC>
<ID>1</ID>
<TN>1</TN>
<RC>0</RC>
<MSG>OK</MSG>
</SIHOT-DOCUMENT>
By services here the classical services, e. g. garage, and arrangements, e. g. wellness package or overnight accommodation, are understood.
Attributes Response
| RC | MSG | Description |
|---|---|---|
| 0 | OK | Rates were created correctly. |
| 1 | PROCESSING OF THIS MESSAGE FAILED | An unexpected error occurred during the creation of the rates. For further information check the log file named “SIHOTTOWEB.log”. |
| 2 | ROOM CATEGORY –XY- AND ITS DESCRIPTIONS FROM SERVICE/ARRANGEMENT –YZ- COULD NOT BE USED | With the help of an element |
| 3 | GUEST GROUP –XY- AND ITS DESCRIPTIONS FROM ROOM CATEGORY –YZ-, FROM SERVICE/ARRANGEMENT –ZX- COULD NOT BE USED | With the help of the element |
| 4 | THE DAY PRICES FROM GUEST GROUP –XY- ,FROM ROOM CATEGORY –YZ-, FROM SERVICE/ARRANGEMENT –ZX- ARE NOT CORRECT | In the element |
| 5 | THE DAY PRICES WITHOUT A GUEST GROUP FROM ROOM CATEGORY –XY-, FROM SERVICE/ARRANGEMENT –YZ- ARE NOT CORRECT | In the element |
| 6 | YOUR MESSAGE DOES NOT CONTAIN ANY SERVICES/ARRANGEMENTS | There is no |
| 7 | SERVICE/ARRANGEMENT –XY- AND ITS DESCRIPTIONS COULD NOT BE USED | An error occurred by the element |
Examples
Example 1 - Rate exchange with person groups
If the rates per person are computed, the prices can be indicated not only per arrangement and room category, but also per person group.
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
<OC>RATE</OC>
<ID>1</ID>
<TN>1</TN>
<RC>0</RC>
<MSG>OK</MSG>
<ARATELIST>
<CURRENCY>EUR</CURRENCY>
<RATE>
<SID>VP</SID>
<ARR-SERVICE>A</ARR-SERVICE>
<PRICE-PER>P</PRICE-PER>
<RADIO-CHECK>R</RADIO-CHECK>
<PRICE-REQUEST>N</PRICE-REQUEST>
<ORDER>XY</ORDER>
<TXT>
<LANG>de</LANG>
<T>Vollpension</T>
<DESC>Beschreibung Vollpension
</DESC>
<CANCEL>Beschreibung Stornobedingungen Vollpension</CANCEL>
</TXT>
<TXT>
<LANG>en</LANG>
<T>Full board</T>
<DESC>Beschreibung Vollpension</DESC>
<CANCEL>Beschreibung Stornobedingungen Vollpension</CANCEL>
</TXT>
<R>
<CAT>EZ</CAT>
<DAY-PRICE>
<D>2003-08-24</D>
<PPU>1112.00</PPU>
</DAY-PRICE>
<DAY-PRICE>
<D>2003-08-25</D>
<PPU>1114.00</PPU>
</DAY-PRICE>
<PERS-TYPE>
<TYPE>CH</TYPE>
<DAY-PRICE>
<D>2003-08-24</D>
<PPU>1112.00</PPU>
</DAY-PRICE>
<DAY-PRICE>
<D>2003-08-25</D>
<PPU>1114.00</PPU>
</DAY-PRICE>
</PERS-TYPE>
<PERS-TYPE>
<TYPE>AD</TYPE>
<DAY-PRICE>
<D>2003-08-24</D>
<PPU>1112.00</PPU>
</DAY-PRICE>
<DAY-PRICE>
<D>2003-08-25</D>
<PPU>1114.00</PPU>
</DAY-PRICE>
</PERS-TYPE>
</R>
<R>
<CAT>DZ</CAT>
<DAY-PRICE>
<D>2003-08-26</D>
<PPU>165.00</PPU>
</DAY-PRICE>
<DAY-PRICE>
<D>2003-08-27</D>
<PPU>166.00</PPU>
</DAY-PRICE>
</R>
</RATE>
<RATE>
<SID>HP</SID>
<ARR-SERVICE>A</ARR-SERVICE>
<PRICE-PER>R</PRICE-PER>
<RADIO-CHECK>R</RADIO-CHECK>
<PRICE-REQUEST>N</PRICE-REQUEST>
<ORDER>XY</ORDER>
<TXT>
<LANG>de</LANG>
<T>Halbpension</T>
<DESC>Beschreibung Vollpension</DESC>
<CANCEL>Beschreibung Stornobedingungen Vollpension</CANCEL>
</TXT>
<TXT>
<LANG>en</LANG>
<T>Half board</T>
<DESC>Beschreibung Vollpension</DESC>
<CANCEL>Beschreibung Storno bedingungen Vollpension</CANCEL>
</TXT>
<R>
<CAT>EZ</CAT>
<DAY-PRICE>
<D>2003-08-24</D>
<PPU>1112.00</PPU>
</DAY-PRICE>
<DAY-PRICE>
<D>2003-08-25</D>
<PPU>1114.00</PPU>
</DAY-PRICE>
</R>
<R>
<CAT>DZ</CAT>
<DAY-PRICE>
<D>2003-08-26</D>
<PPU>165.00</PPU>
</DAY-PRICE>
<DAY-PRICE>
<D>2003-08-27</D>
<PPU>166.00</PPU>
</DAY-PRICE>
</R>
</RATE>
</ARATELIST>
</SIHOT-DOCUMENT>
In the above example one sees that for the first arrangement „VP“ the
rates for room category “EZ” are given without person group.
Subsequently, under<PERS-TYPE> the rates are given for the person
groups “CH” and “AD”. For the second arrangement “HP” are no person
groups defined, because this arrangement has rates per room.
This is the answer of SIHOT.WEB as the case may be of the external system:
<?xml version="1.0" encoding="ISO-8859-1"?>
<SIHOT-DOCUMENT>
<VER>2.0</VER>
<OC>RATE</OC>
<ID>1</ID>
<TN>1</TN>
<RC>0</RC>
<MSG>OK</MSG>
</SIHOT-DOCUMENT>
If <RC>0</RC>, the rates were created correctly. In all other cases
an error occurred. Is it a confirmation by SIHOT.WEB, the error code is
described in the table before.