RESERVATION CHANGE PREVIEW V001
Service Reference Name: S_RESERVATION_CHANGE_PREVIEW_V001
General
Service is calculating the delta amount (Gross in a gross rate system, net in a net rate system) between a persisted reservation (can be found by CentralID or ObjID) and this requested.
Input
- RESERVATION-CENTRALID: CentralID of the reservation. Optional, but one out of RESERVATION-CENTRALID or RESERVATION-OBJID needs to be sent to find the reservation.
-
RESERVATION-OBJID: ObjID of the reservation. Optional, but one out of RESERVATION-CENTRALID or RESERVATION-OBJID needs to be sent to find the reservation.
-
arrival: Mandatory. Arrival date of the reservation to be calculated.
- departure: Mandatory. Departure date of the reservation to be calculated.
- category: Mandatory. Category of the reservation to be calculated.
- ratecategory: Mandatory. Rate category of the reservation to be calculated.
-
ratesegment: Optional. Rate segment of the reservation to be calculated.
-
1:N blocks with reservation packages (ReservationPackage), which consists of service, datefrom and dateto. At least one package needs to fit arrival and departure date of the requested reservation.
- service: Mandatory. Service code of the reservation package/service.
- datefrom: Mandatory. Begin date of the reservation package/service.
-
dateto: Mandatory. End date of the reservation package/service.
-
1:N blocks with rooms, which consists of category, 1:N blocks persons, that also have 1:N blocks person packages.
-
category: Mandatory. Category of the room.
-
person consists of datefrom, dateto, ratecategory, ratesegment and 1:N blocks of person packages (PersonPackage)
- datefrom: Mandatory. Arrival date of the person (must fit the reservation arrival date).
- dateto: Mandatory. Departure date of the person (must fit the reservation departure date).
- ratecategory: Mandatory. Rate category of the person.
-
ratesegment: Optional. Rate segment of the person.
-
personPackages consists of service, datefrom, dateto
- service: Mandatory. Service code of the person package/service.
- datefrom: Mandatory. Begin date of the person package/service.
- dateto: Mandatory. End date of the person package/service.
Output
- RESERVATION-CENTRALID: CentralID of the reservation.
- RESERVATION-OBJID: ObjID of the reservation.
- total: Total amount of the persisted reservation.
- depositrequired: Required deposit amount of the persisted reservation.
- depositpayed: Payed deposit amount of the persisted reservation.
- depositopen: Open deposit amount of the persisted reservation.
- forecast: Forecast amount of the requested reservation (total amount, in case of the requested data would be applied on the reservation).
- delta: Delta amount between the current total amount of the persisted reservation and the calculate rate forecast for the requested reservation.
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_RESERVATION_CHANGE_PREVIEW_V001Request xmlns="http://www.gubse.com/IFS/SihotServices01.xsd"><!--Optional--><TransactionID>string</TransactionID>
<Authentication>
<SecurityID>string</SecurityID>
</Authentication>
<ResForecast><!--Optional--><RESERVATION-CENTRALID>Base: string Pattern: ([0-9])*</RESERVATION-CENTRALID><!--Optional--><RESERVATION-OBJID>Base: string Pattern: ([0-9])*</RESERVATION-OBJID>
<arrival>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</arrival>
<departure>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</departure>
<category>string</category>
<ratecategory>string</ratecategory><!--Optional--><ratesegment>string</ratesegment><!--1 or more repetitions--><ReservationPackage>
<service>string</service>
<datefrom>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</datefrom>
<dateto>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</dateto>
</ReservationPackage><!--1 or more repetitions--><Room>
<category>string</category><!--1 or more repetitions--><Person>
<datefrom>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</datefrom>
<dateto>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</dateto>
<ratecategory>Base: string minLength: 0 maxLength: 4</ratecategory><!--Optional--><ratesegment>Base: string minLength: 0 maxLength: 3</ratesegment><!--1 or more repetitions--><PersonPackage>
<service>string</service>
<datefrom>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</datefrom>
<dateto>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</dateto>
</PersonPackage>
</Person>
</Room>
</ResForecast>
</S_RESERVATION_CHANGE_PREVIEW_V001Request>
</soapenv:Body>
</soapenv:Envelope>
Attributes Message
| Name | Type |
|---|---|
| S_RESERVATION_CHANGE_PREVIEW_V001Request | |
| TransactionID | string |
| Authentication | Node |
| SecurityID | string |
| ResForecast | Node |
| RESERVATION-CENTRALID | Base: string Pattern: ([0-9])* |
| RESERVATION-OBJID | Base: string Pattern: ([0-9])* |
| arrival | Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) |
| departure | Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) |
| category | string |
| ratecategory | string |
| ratesegment | string |
| ReservationPackage | Node |
| service | string |
| datefrom | Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) |
| dateto | Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) |
| Room | Node |
| category | string |
| Person | Node |
| datefrom | Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) |
| dateto | Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) |
| ratecategory | Base: string minLength: 0 maxLength: 4 |
| ratesegment | Base: string minLength: 0 maxLength: 3 |
| PersonPackage | Node |
| service | string |
| datefrom | Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) |
| dateto | Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) |
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_RESERVATION_CHANGE_PREVIEW_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--><ResForecast>
<RESERVATION-CENTRALID>Base: string Pattern: ([0-9])*</RESERVATION-CENTRALID>
<RESERVATION-OBJID>Base: string Pattern: ([0-9])*</RESERVATION-OBJID>
<total>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</total>
<DEPOSIT>
<SUMMARY>
<depositrequired>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</depositrequired>
<depositpayed>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</depositpayed>
<depositopen>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</depositopen>
</SUMMARY>
</DEPOSIT>
<FORECAST>
<forecast>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</forecast>
<delta>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</delta>
</FORECAST>
</ResForecast>
</S_RESERVATION_CHANGE_PREVIEW_V001Response>
</soapenv:Body>
</soapenv:Envelope>
Attributes Response
| Name | Type |
|---|---|
| S_RESERVATION_CHANGE_PREVIEW_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 |
| ResForecast | Node |
| RESERVATION-CENTRALID | Base: string Pattern: ([0-9])* |
| RESERVATION-OBJID | Base: string Pattern: ([0-9])* |
| total | Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9]) |
| DEPOSIT | Node |
| SUMMARY | Node |
| depositrequired | Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9]) |
| depositpayed | Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9]) |
| depositopen | Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9]) |
| FORECAST | Node |
| forecast | Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9]) |
| delta | Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9]) |