RATE SEARCH V001
Service Reference Name: S_RATE_SEARCH_V001
General
This service delivers the rate for a specific service for a specific period.
Input
- from: service date from
- to: service date to
- serviceCode: service code for the service
- rateCategory: rate category for the service
- rateSegment: (Optional) rate segment for the service
- scope: (Optional) e.g:
- "FORCECALCDAYPRICE" - price per day will be returned
- discountGroup: (Optional) discount group for the service
- currency: (Optional) currency to which you want to convert
- GUEST-OBJID: (Optional) guest specific price
-
ALLOTMENT-OBJID: (Optional) allotment specific price
-
List of person types (Optional)
- guestType: (Optional) type of the guest
- noOfPax: number of persons
Output
- Rate you are looking for and optional a list with the daily rates
- Within each daily rate node, some occupancy data is also included. Please note that:
- For sales categories, the occupancy percentage is not calculated so 0 will be the returned value
- The number of occupied rooms is a calculated figure between the total and available rooms.
- Consequently, if the request is for a sales category with a defined maximum availability, it can be inaccurate.
References
- S_RATE_SEARCH_V002 - Obtain a list of rates of combined services and categories
Direction
SIHOT.PMS ← IF Partner
Message
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:envgen="http://soapenvelopegenerator.eduardocastro.info/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soapenv:Header />
<soapenv:Body>
<S_RATE_SEARCH_V001Request xmlns="http://www.gubse.com/IFS/SihotServices01.xsd"><!--Optional--><TransactionID>string</TransactionID>
<Authentication>
<SecurityID>string</SecurityID>
</Authentication>
<RATEREQUESTSEARCH>
<from>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</from>
<to>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</to>
<servicecode>string</servicecode>
<ratecategory>string</ratecategory><!--Optional--><ratesegment>string</ratesegment><!--Optional--><scope>string</scope><!--Optional--><discountgroup>string</discountgroup><!--Optional--><currency>string</currency><!--Optional--><GUEST-OBJID>Base: string Pattern: ([0-9])*</GUEST-OBJID><!--Optional--><ALLOTMENT-OBJID>Base: string Pattern: ([0-9])*</ALLOTMENT-OBJID><!--Optional--><PERSONTYPE>
<noofpax>Base: string Pattern: ([-+]){0,1}([0-9])*</noofpax><!--Optional--><guesttype>string</guesttype>
</PERSONTYPE>
</RATEREQUESTSEARCH>
</S_RATE_SEARCH_V001Request>
</soapenv:Body>
</soapenv:Envelope>
Attributes Message
| Name | Type |
|---|---|
| S_RATE_SEARCH_V001Request | |
| TransactionID | string |
| Authentication | Node |
| SecurityID | string |
| RATEREQUESTSEARCH | Node |
| from | Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) |
| to | Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) |
| servicecode | string |
| ratecategory | string |
| ratesegment | string |
| scope | string |
| discountgroup | string |
| currency | string |
| GUEST-OBJID | Base: string Pattern: ([0-9])* |
| ALLOTMENT-OBJID | Base: string Pattern: ([0-9])* |
| PERSONTYPE | Node |
| noofpax | Base: string Pattern: ([-+]){0,1}([0-9])* |
| guesttype | string |
Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:envgen="http://soapenvelopegenerator.eduardocastro.info/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soapenv:Header />
<soapenv:Body>
<S_RATE_SEARCH_V001Response xmlns="http://www.gubse.com/IFS/SihotServices01.xsd"><!--Optional--><TransactionID>string</TransactionID>
<Result>
<Success>Base: string Pattern: true or false</Success><!--Optional--><ErrorMsg>string</ErrorMsg><!--Optional--><MSG-LIST><!--Optional--><MSG-ENTRY><!--Optional--><MSG-LEVEL>Base: string Pattern: ERROR or WARNING or INFO</MSG-LEVEL><!--Optional--><MSG-CLASS>string</MSG-CLASS><!--Optional--><MSG-NO>Base: string Pattern: ([0-9])*</MSG-NO><!--Optional--><MSG-TEXT>string</MSG-TEXT><!--Optional--><MSG-ENTRY-PARAM-LIST><!--Optional--><PARAM><!--Optional--><INDEX>Base: string Pattern: ([0-9])*</INDEX><!--Optional--><VALUE>string</VALUE>
</PARAM>
</MSG-ENTRY-PARAM-LIST><!--Optional--><MSG-COMMENT>string</MSG-COMMENT><!--Optional--><MSG-SUPRESSED>string</MSG-SUPRESSED>
</MSG-ENTRY>
</MSG-LIST>
</Result><!--Optional--><RATERESULT>
<rate>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</rate>
<discount>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</discount>
<currencyamount>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</currencyamount>
<currencydiscount>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</currencydiscount><!--Optional--><DAILYRATERESULT>
<date>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</date>
<rate>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</rate>
<discount>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</discount>
<currencyamount>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</currencyamount>
<currencydiscount>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</currencydiscount>
<totalRooms>Base: string Pattern: ([-+]){0,1}([0-9])*</totalRooms>
<occupiedrooms>Base: string Pattern: ([-+]){0,1}([0-9])*</occupiedrooms>
<availablerooms>Base: string Pattern: ([-+]){0,1}([0-9])*</availablerooms>
<occupancyPercentage>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</occupancyPercentage>
</DAILYRATERESULT>
</RATERESULT>
</S_RATE_SEARCH_V001Response>
</soapenv:Body>
</soapenv:Envelope>
Attributes Response
| Name | Type |
|---|---|
| S_RATE_SEARCH_V001Response | |
| TransactionID | string |
| Result | Node |
| Success | Base: string Pattern: true or false |
| ErrorMsg | string |
| MSG-LIST | Node |
| MSG-ENTRY | Node |
| MSG-LEVEL | Base: string Pattern: ERROR or WARNING or INFO |
| MSG-CLASS | string |
| MSG-NO | Base: string Pattern: ([0-9])* |
| MSG-TEXT | string |
| MSG-ENTRY-PARAM-LIST | Node |
| PARAM | Node |
| INDEX | Base: string Pattern: ([0-9])* |
| VALUE | string |
| MSG-COMMENT | string |
| MSG-SUPRESSED | string |
| RATERESULT | Node |
| rate | Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9]) |
| discount | Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9]) |
| currencyamount | Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9]) |
| currencydiscount | Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9]) |
| DAILYRATERESULT | Node |
| date | Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) |
| rate | Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9]) |
| discount | Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9]) |
| currencyamount | Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9]) |
| currencydiscount | Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9]) |
| totalRooms | Base: string Pattern: ([-+]){0,1}([0-9])* |
| occupiedrooms | Base: string Pattern: ([-+]){0,1}([0-9])* |
| availablerooms | Base: string Pattern: ([-+]){0,1}([0-9])* |
| occupancyPercentage | Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9]) |