SOAP WS DOCU 2.2 · This document is the description of the SOAP web service provided by Eurotours....

SOAP WS DOCU 2.2.4 Technical specification of the Eurotours SOAP API

Eurotours Ges.m.b.H. | Kirchberger Straße 8 | 6370 Kitzbühel | [email protected] | www.eurotours.at

1 /

UMPAGES \* Arabic \* MERGEFORMAT125

1 Table of Contents

SOAP WS DOCU 2.2.4 .............................................................................................. 1

Technical specification of the Eurotours SOAP API ................................................ 1

1 Table of Contents ................................................................................................ 1

2 Introduction .......................................................................................................... 5

3 Revision History................................................................................................... 7

4 General Requests................................................................................................ 8

addAdditionalServices ................................................................................... 8

addVouchers (deprecated) ............................................................................ 9

bookAccommodation ................................................................................... 10

cancelBooking ............................................................................................. 14

cancelOption ............................................................................................... 15

changeRemark ............................................................................................ 16

checkBookability .......................................................................................... 17

fixOption ...................................................................................................... 19

getAccommodationAttributes ....................................................................... 20

getAdditionalServices ............................................................................... 22

getAreaOfLocation ................................................................................... 24

getAreas ................................................................................................... 25

getBookingDetails .................................................................................... 26

getCancellationFee .................................................................................. 28

getCancellationRules ............................................................................... 29

getCategory .............................................................................................. 30

getContractRates ..................................................................................... 31

getLanguages .......................................................................................... 33

getLocations ............................................................................................. 34

getMeals ................................................................................................... 35

getObjectDetails ....................................................................................... 36

getObjects ................................................................................................ 38

getOriginalImage ...................................................................................... 41

getRoomSpecifications (deprecated) ....................................................... 42

getSeasons .............................................................................................. 43

getVersion ................................................................................................ 44

replicateObjectDetails (deprecated) ......................................................... 45

searchBookableObjects ........................................................................... 47

searchObjects .......................................................................................... 50


2 /


changePassengerNames ......................................................................... 53

getRoomTypeDetails ................................................................................ 55

5 Individual Requests ........................................................................................... 58

addUser ....................................................................................................... 58

login ............................................................................................................. 59

Lostpassword (deprecated) ......................................................................... 60

getUserdata ................................................................................................. 61

changeUserdata .......................................................................................... 62

getNations ................................................................................................... 63

getPayment (deprecated) ............................................................................ 64

confirmBanktransferTransaction (deprecated) ............................................ 64

confirmCreditcardTransaction (deprecated) ................................................ 65

confirmDirectDebitingService (deprecated) .............................................. 66

confirmInvoiceTransaction (deprecated) .................................................. 67

6 Types ................................................................................................................. 68

Location ....................................................................................................... 68

Airport .......................................................................................................... 69

Description .................................................................................................. 69

Image .......................................................................................................... 70

Version ........................................................................................................ 71

Session ........................................................................................................ 72

Voucher ....................................................................................................... 72

Object .......................................................................................................... 73

AccommodationAttribute ............................................................................. 76

AccommodationAttributeTheme ............................................................... 76

Address .................................................................................................... 77

Contract .................................................................................................... 78

AgeRelatedReduction .............................................................................. 80

AgeRange ................................................................................................ 81

Reduction ................................................................................................. 81

DateRange ............................................................................................... 82

BookingTimeRelatedReduction ................................................................ 83

CancellationRule ...................................................................................... 85

ContractIdentification ................................................................................ 87

DurationRelatedReduction ....................................................................... 90

NumberRange .......................................................................................... 91

Meal ......................................................................................................... 92


3 /


MealRelatedReduction ............................................................................. 93

OccupancyRelatedReduction ................................................................... 94

Rate .......................................................................................................... 95

ChildRate ................................................................................................. 96

Room ........................................................................................................ 97

Supplement .............................................................................................. 98

Map .......................................................................................................... 99

Night ....................................................................................................... 100

ObjectAttributes (deprecated) ................................................................ 101

AdditionalService ................................................................................... 102

Choice .................................................................................................... 105

AdditionalServicePassenger .................................................................. 105

Passenger .............................................................................................. 106

Payment (deprecated) ............................................................................ 106

BanktransferTransaction (deprecated) ................................................... 107

Amount ................................................................................................... 107

CreditcardTransaction (deprecated) ....................................................... 109

DirectDebitingService (deprecated) ....................................................... 109

DirectDebiting (deprectated) .................................................................. 109

InvoiceTransaction (deprecated) ............................................................ 109

Credentials ............................................................................................. 110

Nation ..................................................................................................... 110

Roomtype ............................................................................................... 111

Bookability .............................................................................................. 112

Roomx .................................................................................................... 112

Offer ....................................................................................................... 116

User ........................................................................................................ 117

OriginalImage ......................................................................................... 119

Booking .................................................................................................. 119

BookingPriceDetail ................................................................................. 122

Category ................................................................................................. 122

BookingDetail ......................................................................................... 123

Area ........................................................................................................ 125

Creditcard (deprecated) ......................................................................... 125

Season ................................................................................................... 126

Language ............................................................................................... 126

PricePerPax ........................................................................................... 127


4 /


ageRestrictions ...................................................................................... 128

ageRestriction ........................................................................................ 128

passengerType ...................................................................................... 129

roomTypeRules ...................................................................................... 130


5 /


2 Introduction

This document is the description of the SOAP web service provided by Eurotours. The service consists of several methods that can be used to alter and retrieve booking related information from the underlying Oracle Database.

An example for a booking process is pictured in the diagram below.


6 /


B2C Transaction require a logged in webuser (sessionkey). Webuser related transactions are represented in the sequence diagram below.

To use a webuser it first has to be added to the database using the adduser() method. The response will yield a session key that can be used for b2c transaction. Once the session expires the user will be required to log in again using the login() method. Information related to the webuser can be retrieved with getUserdata() and updated using changeUserdata().


7 /


3 Revision History

Version Date Change

2.2.4 25.02.2020 Added room description to the roomx object for the searchBookabnleOjbect method

2.2.4 26.09.2019 Add new type roomTypeRules, add new request getRoomTypeDetails, add to the Object the new type roomTypeRules. The getRoomSpecifications (deprecated) will now be depraced and replaced with getRoomTypeDetails

2.2.4 13.11.2018 Fixed some typos in the documentation in getObjectDetails[36], getOriginalImage[41], Image[70]

Added some information to Roomx[112]

24.08.2018 Add to passengers object the id [106]

Add new function changePassengerNames [53]

31.07.2018 bookAccommodation TypeOfTransaction Calculation will now deliver Cancellation rules

getContractRates has also a age restriction section now that prevents minimum age a maximum age allowed in rooms

29.09.2016 new property “minStay” in BookingTimeRelatedReduction [83]

new property “mealType” in class CancellationRule [85]

new property “durationOfStayFrom” in class CancellationRule [85]

new property “durationOfStayTo”in class CancellationRule [85]

new property “durationOfStayMethod” in class CancellationRule [85]

new property “cancellationFeeUnit” in class CancellationRule [85]

changed property name “methode” to “method” in class CancellationRule [85]

changed value implication for return values of property “cancellationFeeMethod” in class CancellationRule [85]

new property “country” in class Area [125]

new property “countrycode” in class Area [125]

18.01.2017 added “priceperperson” field of type PricePerPax in class Booking [119]

added “priceperperson” field of type PricePerPax in class BookingDetail [123]

new object type “PricePerPax” [127]

All changes and related notes are marked in red.


8 /


4 General Requests

The methods in this section can be used for both B2C and B2B interactions.

addAdditionalServices

This method can be used to add services to an existing booking. Required parameters are the identification of the booking (bucname) and the service that will be added, identified by a unique id and the date the service will be used.

4.1.1 Request

Name Type Req. Description

language String Language code for the response

Default: “en”

session

Session (X) Required for B2C requests.

bucname String X id of the booking to add additional services to.

Can be obtained through the response of bookAccommodation.

additionalservices AdditionalService X The service to add to the booking.

4.1.1.1 Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:ws="http://ws.eurotours.at/">

<soapenv:Header/>

<soapenv:Body>

<ws:addAdditionalServices>

<language>en</language>

<session>

<id>1xhv8iuvl0obr4nprn40w0nw01w973j8</id>

</session>

<bucname>123456789012</bucname>

<additionalservices>

<date>2015-06-07</date>

<id>123456789</id>

</additionalservices>

</ws:addAdditionalServices>

</soapenv:Body>

</soapenv:Envelope>

4.1.2 Response

If the additional service was successfully booked the response will be empty.

Name Type Description


9 /


addVouchers (deprecated)

This method is currently not supported!

This method can be used to add vouchers to an existing booking.

4.2.1 Request


session




vouchers Voucher X The voucher to add to the booking.

4.2.2 Response

If the voucher was successfully added the response will be empty.



10 /


bookAccommodation

This method can be used to book accommodations, book options for accommodations, or calculate the cost for a booking.

4.3.1 Request



Default: “en”

session


contractidentification ContractIdentification X Information that has to be supplied to identify the contract for the accommodation.

arrival DateTime X The start time of the stay at the accommodation.

duration int X The duration of the stay at the accommodation in days.

latearrival Boolean If true, signifies that the arrival at the accommodation will be after 6 P.M.

mealcode String X The type of boarding to be booked.

A list of possible types can be obtained through getMeals.

Possible meal codes for the accommodation can be obtained through searchObjects and searchBookableObjects.

leadname String X Shot, non-unique label of the booking.

typeoftransaction String X Has to be set to one of the following:

“Booking” / “Option” / “Calculation”

rooms Roomx X Identifies the room and passengers that will be included in the booking

remark String Adds a remark String to the booking.

production boolean If false, the booking will be marked as test booking and cancelled after 30 minutes.

Default: false

mark String Used by some customers to store booking identification.

11 /


4.3.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:bookAccommodation>


<!— Optional: Only needed for B2C requests -->







<contractidentification>

<individual></individual>

<objectcode>OBJECT CODE*4</objectcode>

<!—- id of a product. Has to be supplied if there are at least 2

contracts with different services / rates for an object -->



<servicetype>ZIMMER</servicetype>

<!—- id of a supplier. Has to be supplied if the hotel is

contracted via an agency -->



</contractidentification>

<arrival>2015-07-12</arrival>

<duration>7</duration>

<latearrival>false</latearrival>

<mealcode>FS</mealcode>

<leadname>EXAMPLE BOOKING</leadname>

<typeoftransaction>booking</typeoftransaction>

<rooms>

<passengers>

<age>30</age>

<firstname>test</firstname>

<lastname>test</lastname>

</passengers>

<passengers>

<age>30</age>



</passengers>

<roomcode>Z2DWT</roomcode>

</rooms>

<remark>This is an example booking.</remark>

<production>false</production>

<mark></mark>

</ws:bookAccommodation>

</soapenv:Body>

</soapenv:Envelope>


12 /


4.3.1.2 Remarks

4.3.1.2.1 typeoftransaction

Booking: If the request is valid, books with the given properties. Option: If the request is valid, books an optional booking with the given properties. Optional bookings are held for a certain amount of time before they expire and are released. The time until expiration depends on the amount of time between arrival date and time of booking. 3 weeks or more: option automatically expires after 3 days 2-3 weeks: option automatically expires after 2 days 1-2 weeks: option automatically expires after 1 day 0-1 week: booking an option is not possible Calculation: If the request is valid, gives a response to the request as if a booking occurred, without it actually taking place. Response will show existing CancellationRules. Does not check whether the accommodation is overbooked or not!

4.3.1.2.2 Testuser

A booking made with a test client (testxmlb2b, testxmlb2c) will have its production parameter set to false (and subsequently be cancelled after 30 minutes).


13 /


4.3.2 Response

The response will contain a booking object, which will contain:

Bookingpricedetails - Information about the cost and service booked.

Bucname – A String containing the unique booking id.

CancellationRule –Rules that apply on cancellation of the booking.

AddionalServices – Information that can be used to book available additional

services.


return Booking A booking object containing information regarding the booking.

4.3.2.1 Example <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

<S:Body>

<ns2:bookAccommodationResponse xmlns:ns2="http://ws.eurotours.at/">

<return>

<additionalservices>

<arrival>false</arrival>

<description>Travelinsurance</description>

<displaydate>false</displaydate>

<flight>false</flight>

<group>0</group>

<id>2</id>

<mandatory>false</mandatory>

<modifydate>false</modifydate>

<modifypax>false</modifypax>

<modifyunit>false</modifyunit>

<price>278.0</price>

<unit>0</unit>

</additionalservices>

<bookingpricedetails>

<description>2 Bett Dusche/WC/Balkon,FS</description>

<nrpax>2</nrpax>

<nrunits>1</nrunits>


<service>Hotel Example, Example 7 Nt., Example

Beach,Jesolo</service>

<unitprice>0.0</unitprice>

</bookingpricedetails>

<bucname>123456789012</bucname> <cancellationRules>

<daysAfterBooking>0</daysAfterBooking>

<daysBeforeArrival>14</daysBeforeArrival>

<methode>0</methode>

<valid/>

<value>20.0</value>

</cancellationRules>

<cancellationRules>




<valid/>

<value>50.0</value>


<cancellationRules>




<valid/>

<value>100.0</value>


<currency>EUR</currency>

<optionreleasedate>2015-04-27T00:00:00+02:00</optionreleasedate>


<priceperperson>

<age>42</age>

<facilitynumber>1</facilitynumber>

<firstname>Max</firstname>

<lastname>asd</lastname>


<roomcode>E1DW</roomcode>

</priceperperson>

</return>

</ns2:bookAccommodationResponse>

</S:Body>

</S:Envelope>

14 /


cancelBooking

This method can be used to cancel the booking associated with the supplied booking id (bucname).

4.4.1 Request



Default: “en”

session


bucname String X id of the booking to cancel.


4.4.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:cancelBooking>











</ws:cancelBooking>

</soapenv:Body>

</soapenv:Envelope>

4.4.2 Response

If the cancellation request was successful, the Response will be empty.

15 /


cancelOption

This method can be used to cancel the option associated with the supplied booking id (bucname).

4.5.1 Request



Default: “en”

session


bucname String X id of the booking (option) to cancel.


4.5.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:cancelOption>

<language>de</language>









</ws:cancelOption>

</soapenv:Body>

</soapenv:Envelope>

4.5.2 Response

If the cancellation request was successful, the Response will be empty.

16 /


changeRemark

This method can be used to change the remark String of the booking associated with the supplied id (bucname).

4.6.1 Request



Default: “en”

session


bucname String X id of the booking to change the remark of.


remark String The value of the new remark.

4.6.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:changeRemark>









<booking>115054182739</booking>

<remark>testchangeremark</remark>

</ws:changeRemark>

</soapenv:Body>

</soapenv:Envelope>

4.6.2 Response

If the request to change the remark was successful, the Response will be empty.


17 /


checkBookability

Checks if rooms described in the supplied contract, type and time of stay are available for booking.

4.7.1 Request



Default: “en”

contractdentification

ContractIdentification X Information about the contract that will be checked for bookability.

arrival DateTime X The start time of the stay for which the bookability is to be checked.

duration int X The duration of the stay for which the bookability is to be checked.

roomcode String X Code of the room to get specifications for.

availability int X Minimum of the number of rooms.

default: 1

4.7.1.1 Example

apenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"


<soapenv:Header/>

<soapenv:Body>

<ws:checkBookability>




<objectcode>ACAPULC JESOL*4</objectcode>

<productcode></productcode>


<suppliercode></suppliercode>





<availability>1</availability>

</ws:checkBookability>

</soapenv:Body>

</soapenv:Envelope>


18 /


4.7.2 Response

Returns an object that will contain information about the bookability of the supplied accommodation.


return Bookability An object containing information about whether the specified accommodation is bookable

4.7.2.1 Example A – Bookable

If the checked object is bookable for the specified parameters, the response will contain a boolean with the value true.

<so<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

<S:Body>

<ns2:checkBookabilityResponse xmlns:ns2="http://ws.eurotours.at/">

<return>

<bookable>true</bookable>

</return>

</ns2:checkBookabilityResponse>

</S:Body>

</S:Envelope>

4.7.2.2 Example B – Not bookable

If the checked object is not bookable for the specified parameters, the response will contain a boolean with the value false, as well as a reason.

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

<S:Body>


<return>

<bookable>false</bookable>

<reason>No allotment available!</reason>

</return>


</S:Body>

</S:Envelope>

19 /


fixOption

Transforms the supplied option into a booking.

4.8.1 Request



Default: “en”

session

Session (X) Required for B2C requests



4.8.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:fixOption>











<booking>115054182739</booking>

</ws:fixOption>

</soapenv:Body>

</soapenv:Envelope>


20 /


4.8.2 Response


return boolean True if the option could be successfully booked.

4.8.2.1 Example


<S:Body>

<ns2:fixOptionResponse xmlns:ns2="http://ws.eurotours.at/">

<return>true</return>

</ns2:fixOptionResponse>

</S:Body>

</S:Envelope>

getAccommodationAttributes

Returns a list of containing possible attributes accommodations can have. Accommodation attributes are used to categorize services.

4.9.1 Request



Default: “en”

4.9.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:getAccommodationAttributes>


</ws:getAccommodationAttributes>

</soapenv:Body>

</soapenv:Envelope>

4.9.2 Response


return AccommodationAttribute

Element List

A list containing objects that describe accommodation attributes.


21 /


4.9.2.1 Example


<S:Body>

<ns2:getAccommodationAttributesResponse

xmlns:ns2="http://ws.eurotours.at/">

<return>

<code>ALL IN</code>

<desc>All Inclusive Serviceleistungen</desc>

<kind>Ganzjährig</kind>

<themes>

<desc>All Inclusive Serviceleistungen</desc>

<id>161</id>

</themes>

</return>

<return>

<code>WINTERWONDER</code>

<desc>Wintererlebnis</desc>

<kind>Winter</kind>

<themes>

<desc>Wintererlebnis</desc>

<id>28</id>

</themes>

</return>

</ns2:getAccommodationAttributesResponse>

</S:Body>

</S:Envelope>


22 /


getAdditionalServices

This method returns possible additional services that can be added to an existing booking.

Searching additional services by contract identification and arrival date is currently not supported.

4.10.1 Request



Default: “en”

session


bucname String X* id of the booking to add additional services to.


arrival DateTime X* The start time of the stay at the accommodation.

The use of this attribute is currently not supported!

contractidentification ContractIdentification X* Information that has to be supplied to identify the contract for the accommodation.

The use of this attribute is currently not supported!

* Either bucname or arrival + contractidentification have to be supplied.

23 /


4.10.1.1 Example

Example search for additional services that can be booked to an existing booking.



<soapenv:Header/>

<soapenv:Body>

<ws:getAdditionalServices>


<session>

<id>shxke6rgw9dsro7s7pbook3lj42cx6mh</id>

</session>


<arrival>2015-05-31</arrival> 













</ws:getAdditionalServices>

</soapenv:Body>

</soapenv:Envelope>

4.10.2 Response


return AdditionalService

Element List

A list of additional services that are bookable to the specified

4.10.2.1 Example

Example response for a search for additional services that can be booked to an additional booking.


<S:Body>

<ns2:getAdditionalServicesResponse


<return>


<description>Exampleinsurance</description>



<group>0</group>

<id>2</id>






<unit>0</unit>

</return>

</ns2:getAdditionalServicesResponse>

</S:Body>

</S:Envelope>


24 /


getAreaOfLocation

This method can be used to get a list of areas that a location is associated with.

4.11.1 Request



Default: “en”

locationcode

String X Code to identify the location.

4.11.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:getAreaOfLocation>


<locationcode>Wien</locationcode>

</ws:getAreaOfLocation>

</soapenv:Body>

</soapenv:Envelope>

4.11.2 Response


return Area

Element List

A list of areas the location is located in.

4.11.2.1 Example


<S:Body>

<ns2:getAreaOfLocationResponse xmlns:ns2="http://ws.eurotours.at/">

<return>

<areatype>region</areatype>

<code>Wien</code>

<name>Vienna</name>

</return>

</ns2:getAreaOfLocationResponse>

</S:Body>

</S:Envelope>


25 /


getAreas

This method can be used to retrieve a list of Area objects that contain information about all available areas.

4.12.1 Request


language String Language code for the response.

Default: “en”

4.12.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:getAreas>


</ws:getAreas>

</soapenv:Body>

</soapenv:Envelope>

4.12.2 Response


return Area

Element List

Returns a list of available areas.

4.12.2.1 Example


<S:Body>

<ns2:getAreasResponse xmlns:ns2="http://ws.eurotours.at/">

<return>


<code>Burgenland</code> <country>Österreich</country>

<countrycode>A</countrycode>

<name>Burgenland</name>

</return>

<return>

<areatype>nation</areatype>

<code>Ungarn</code>

<country>Ungarn</country>

<countrycode>H</countrycode>

<name>Ungarn</name>

</return>

</ns2:getAreasResponse>

</S:Body>

</S:Envelope>

26 /


getBookingDetails

This method is currently not supported for b2c requests!

This method can be used to retrieve information about a booking.

4.13.1 Request



Default: “en”

session


bucname String X id of the booking to retrieve details from.

4.13.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:getBookingDetails>











</ws:getBookingDetails>

</soapenv:Body>

</soapenv:Envelope>


27 /


4.13.2 Response


return BookingDetail An object containing information about the supplied booking.


<S:Body>

<ns2:getBookingDetailsResponse xmlns:ns2="http://ws.eurotours.at/">

<return>

<amount>

<amount>0.0</amount>


</amount>

<arrival>2015-07-12T00:00:00+02:00</arrival>


<cancellationDate>2015-02-26T00:00:00+01:00</cancellationDate>

<cancellationRules>




<valid/>

<value>20.0</value>

</cancellationRules> <cancellationRules> <daysAfterBooking>0</daysAfterBooking>



<valid/> <value>50.0</value>


<cancellationRules>






<ci>

<individual>false</individual>

<objectcode>ACAPULC JESOLO</objectcode>


</ci>


<lastModification>2015-02-26T00:00:00+01:00</lastModification>

<leadname>test</leadname>

<meal>

<code>FS</code>

</meal>

<priceperperson>

<age>20</age>


<firstname>Test</firstname>

<lastname>Person</lastname>


<roomcode> Z2DWT </roomcode>

</priceperperson>

<rooms>

<nradults>1</nradults>

<nrchilds>0</nrchilds>

<nrrooms>0</nrrooms>

<passengers>

<age>30</age>



</passengers> <passengers> <age>30</age>



</passengers>


</rooms>

</return>

</ns2:getBookingDetailsResponse>

</S:Body>

</S:Envelope>

28 /


getCancellationFee

This method can be used to get the fee that would arise if the booking would be cancelled at the current date.

4.14.1 Request


bucname String X The id of the booking to look the amount of the cancellation fee up from.

4.14.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:getCancellationFee>




</ws:getCancellationFee>

</soapenv:Body>

</soapenv:Envelope>

4.14.2 Response


return Amount An object containing information about the amount of the cancellation fees of the booking.

4.14.2.1 Example


<S:Body>

<ns2:getCancellationFeeResponse xmlns:ns2="http://ws.eurotours.at/">

<return>



</return>

</ns2:getCancellationFeeResponse>

</S:Body>

</S:Envelope>


29 /


getCancellationRules

This method can be used to retrieve a list of cancellation rules that apply to the provided booking.

4.15.1 Request


bucname String X The id of the booking to look the cancellation rules up from.

4.15.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:getCancellationRules>


</ws:getCancellationRules>

</soapenv:Body>

</soapenv:Envelope>

4.15.2 Response


return CancellationRule

Element List

A list of CancellationRule objects containing information about the rules to calculate the cancellation fee upon cancellation of the booking.


<S:Body>

<ns2:getCancellationRulesResponse xmlns:ns2="http://ws.eurotours.at/">

<return>




<valid/>

<value>20.0</value>

</return>

<return>




<valid/>

<value>50.0</value>

</return>

<return>




<valid/>


</return>

</ns2:getCancellationRulesResponse>

</S:Body>

</S:Envelope>


30 /


getCategory

This method can be used to retrieve a list of available hotel categories.

4.16.1 Request



Default: “en”

4.16.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:getCategory>


</ws:getCategory>

</soapenv:Body>

</soapenv:Envelope>

4.16.2 Response


return Category

Element List

A list containing the categories that a hotel can be assigned to.

(Usually star-ratings)

4.16.2.1 Example


<S:Body>

<ns2:getCategoryResponse xmlns:ns2="http://ws.eurotours.at/">

<return>

<code>0</code>

<name>no_cat</name>

</return>

<return>

<code>5</code>

<name>*****</name>

</return>

</ns2:getCategoryResponse>

</S:Body>

</S:Envelope>


31 /


getContractRates

This method can be used to retrieve the price rates that are defined in a specified contract.

A room object with a room type code can be supplied to narrow down the response list.

4.17.1 Request



Default: “en”

date DateTime X The date of arrival at the accommodation. Only rates that are valid at the time of arrival will be returned.

contractidentification ContractIdentification X Information that has to be supplied to identify the contract to get the rates from.

room Room A room object that can be used to narrow down the response list.

4.17.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:getContractRates>


<date>2015-07-27</date>



<objectcode>EXAMPLE HOTEL*4</objectcode>

<productcode></productcode>




<room>

<allotment>1</allotment>

<bookableroomcode></bookableroomcode>

<code>Z2DWT</code>

<description></description>

<paxnights></paxnights>

<price></price>

</room>

</ws:getContractRates>

</soapenv:Body>

</soapenv:Envelope>


32 /


4.17.2 Response


return Contract An object containing contract related lists and objects (e.g. rates, meals, age related prices reductions, duration related price reductions…)


<S:Body>

<ns2:getContractRatesResponse xmlns:ns2="http://ws.eurotours.at/">

<return>

<agerelatedreductions>

<age>

<from>0</from>

<thru>6</thru>

</age>

<fullpayingpassengers>2</fullpayingpassengers>

<reduction>


<value>-100.0</value>

</reduction>

<valid>

<from>2015-05-31T00:00:00+02:00</from>

<thru>2015-09-05T00:00:00+02:00</thru>

</valid>

</agerelatedreductions> <agerelatedreductions>

<age>

<from>7</from>

<thru>12</thru>

</age>


<reduction>



</reduction>

<valid>

<from>2015-05-31T00:00:00+02:00</from>

<thru>2015-09-05T00:00:00+02:00</thru>

</valid>

</agerelatedreductions>


<age> <from>-1</from>

<thru>-1</thru>

</age>


<reduction> <methode>1</methode>


</reduction>

<valid> <from>2015-05-31T00:00:00+02:00</from>

<thru>2015-09-05T00:00:00+02:00</thru>

</valid>


<cancellationRules>




<valid/>

<value>20.0</value>

</cancellationRules> <cancellationRules>




<valid/>

<value>50.0</value>


<cancellationRules> <daysAfterBooking>0</daysAfterBooking>



<valid/>



<contractIdentification>


</contractIdentification>


<meal>

<code>FS</code>

<description>Frühstück</description>

</meal>

<rates>

<baserate>325.0</baserate>


<pricemethode>4</pricemethode>

<room>


<code>Z2DWT</code>

<description>2 Bett Dusche/WC/Balkon</description>

<paxnights>0</paxnights>

<price>0.0</price>

</room>

<valid>

<from>2015-07-27T00:00:00+02:00</from>

<thru>2015-08-08T00:00:00+02:00</thru>

</valid>

</rates> <rates> <baserate>364.0</baserate>



<room>


<code>Z2DWT</code>



<price>0.0</price>

</room>

<valid>

<from>2015-08-09T00:00:00+02:00</from>

<thru>2015-08-22T00:00:00+02:00</thru>

</valid>

</rates>

<rates> <baserate>325.0</baserate>



<room>


<code>Z2DWT</code>



<price>0.0</price>

</room>

<valid>

<from>2015-08-23T00:00:00+02:00</from>

<thru>2015-09-05T00:00:00+02:00</thru>

</valid>

</rates>

</return>

</ns2:getContractRatesResponse>

</S:Body>

</S:Envelope>


33 /


getLanguages

This method can be used to retrieve a list of possible languages.

4.18.1 Request

This method has no parameters.


4.18.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:getLanguages/>

</soapenv:Body>

</soapenv:Envelope>

4.18.2 Response


return Language

Element List

A list of available languages.

4.18.2.1 Example


<S:Body>

<ns2:getLanguagesResponse xmlns:ns2="http://ws.eurotours.at/">

<return>

<code>en</code>

<name>english</name>

</return>

<return>

<code>hu</code>

<name>magyar</name>

</return>

</ns2:getLanguagesResponse>

</S:Body>

</S:Envelope>


34 /


getLocations

This method can be used to get a list of locations that are associated with a provided area. The response will only contain locations for which bookable objects are available, i.e. if the client does not have permission to book at objects in the location, the location will not be returned.

4.19.1 Request



Default: “en”

areaCode String The code of the area for which to look up locations.

4.19.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:getLocations>


<areaCode>Wien</areaCode>

</ws:getLocations>

</soapenv:Body>

</soapenv:Envelope>

4.19.2 Response


return Location

Element List

A list of objects describing the locations contained in the specified area.

4.19.2.1 Example


<S:Body>

<ns2:getLocationsResponse xmlns:ns2="http://ws.eurotours.at/">

<return>

<airport>

<code>VIE</code>

</airport>

<code>Wien</code>

<mapx>16.37308</mapx>

<mapy>48.20828</mapy>

<name>Vienna</name>

</return>

</ns2:getLocationsResponse>

</S:Body>

</S:Envelope>


35 /


getMeals

This method can be used to retrieve a list containing all available meals.

4.20.1 Request



Default: “en”

4.20.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:getMeals>


</ws:getMeals>

</soapenv:Body>

</soapenv:Envelope>

4.20.2 Response


return Meal

Element List

A list of objects describing meal types.

4.20.2.1 Example


<S:Body>

<ns2:getMealsResponse xmlns:ns2="http://ws.eurotours.at/">

<return>

<code>AE</code>

<description>Dinner</description>

</return>

<return>

<code>Z</code>

<description>Meal as program</description>

</return>

</ns2:getMealsResponse>

</S:Body>

</S:Envelope>


36 /


getObjectDetails

This method can be used to retrieve the data of an object via its SVNO.

4.21.1 Request



Default: “en”

descriptionidentification long X The SVNO of the object to get details from.

orgimg boolean If true: Response will contain a token with which to request the original (full-size) image associated with the object.

withaccommodationattributes boolean If true: Response will contain the attributes of the searched object.

This attribute is currently not supported!

4.21.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:getObjectDetails>


<descriptionidentification>1234567</descriptionidentification>

<orgimg></orgimg>

<withaccommodationattributes></withaccommodationattributes>

</ws:getObjectDetails>

</soapenv:Body>

</soapenv:Envelope>


37 /


4.21.2 Response


return Object


<S:Body>

<ns2:getObjectDetailsResponse xmlns:ns2="http://ws.eurotours.at/">

<return>

<accommodationattributethemeproz>0</accommodationattributethemeproz>

<address/>

<bookpricefrom>0.0</bookpricefrom>

<category>0</category>





<descriptions>

<full>A long descriptive text.</full>

<topic>TOPIC</topic>

</descriptions>

<descriptions>

<full>Another description.</full>

<topic>Topic2</topic>

</descriptions>

<images>

<copyright>Eurotours</copyright>

<orgimgtoken>0</orgimgtoken>

<URL>http://URL </URL>

</images>

<images>



<URL> http://URL 2</URL>

</images>

<objectattributes>

<center>false</center>

<creditcard>false</creditcard>

<elevator>false</elevator>

<fitness>false</fitness>

<parking>false</parking>

<pets>false</pets>

<pool>false</pool>

<resturant>false</resturant>

<sauna>false</sauna>

<wheelchair>false</wheelchair>

</objectattributes>

<partner>false</partner>


<pricefrom>0.0</pricefrom>

<pricemethode>-1</pricemethode>

<tpackage>false</tpackage>

<valid/>

</return>

</ns2:getObjectDetailsResponse>

</S:Body>

</S:Envelope>

38 /


getObjects

This method can be used to retrieve a list of objects that are associated with the supplied season and locations.

4.22.1 Request



Default: “en”

seasoncode String X Season code of the requested objects

locationcodes String

Element List

Restricts the response list to objects in the specified location.

A list of possible locations can be retrieved through getLocations.

savepoint boolean Indicates that the next search will only yield objects that have changed since the savepoint has been set.

delta boolean If true, response list will only contain objects that have changed since the last savepoint has been set.

address boolean If true, response will also show the address of the objects.

Will only work if the client has permission to retrieve addresses, otherwise the response will be empty.

4.22.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:getObjects>


<seasoncode>SO15</seasoncode>

<locationcodes>Innsbruck</locationcodes>







</ws:getObjects>

</soapenv:Body>

</soapenv:Envelope>


39 /


4.22.2 Response


return Object

Element List

A list containing objects that match the search criteria.

4.22.2.1 Example


<S:Body>

<ns2:getObjectsResponse xmlns:ns2="http://ws.eurotours.at/">

<return>


<address/>





<objectcode>HOTEL_OBJECTCODE</objectcode>

<productcode>IND_OBBJECTCODE</productcode>





<locationcode>Innsbruck</locationcode>

<map>

<mapexact>false</mapexact>

<mapx>12</mapx>

<mapy>45</mapy>

</map>

<meal>

<code>X</code>

<description>meal according to description</description>

</meal>

<name>The name of the hotel</name>

<nights>

<arrivalpossible>false</arrivalpossible>

<departurepossible>false</departurepossible>

<ismaximum>false</ismaximum>

<minimumstay>0</minimumstay>

<rooms>


<code>E1CW</code>


<price>0.0</price>

</rooms>

<rooms> <allotment>0</allotment>

<code>Z2CW</code>


<price>0.0</price>

</rooms>

<rooms>


<code>Z3CW_K11</code>


<price>0.0</price>

</rooms>

</nights>

<objectattributes>






<pets>false</pets>

<pool>false</pool>



40 /




</objectattributes>





<startdate>2015-05-01T00:00:00+02:00</startdate>


<valid>

<from>2015-04-01T00:00:00+02:00</from>

<thru>2015-10-31T00:00:00+01:00</thru>

</valid>

</return> <return>


<address/>





<objectcode>CONGRESS INNS</objectcode>






<map> <mapexact>true</mapexact>

<mapx>12</mapx>

<mapy>45</mapy>

</map>

<meal>

<code>FS</code>

<description>Breakfast</description>

</meal>

<name>Hotel Name</name>

<nights>





<rooms> <allotment>0</allotment>

<code>POOL</code>


<price>0.0</price>

</rooms>

</nights>

<objectattributes> <center>false</center>





<pets>false</pets>

<pool>false</pool>




</objectattributes>







<valid> <from>2014-11-01T00:00:00+01:00</from>

<thru>2016-04-01T00:00:00+02:00</thru>

</valid>

</return>

</ns2:getObjectsResponse>

</S:Body>

</S:Envelope>

4.22.2.2 Remarks

The Object objects in the getObjects response list will contain neither image, nor description information.


41 /


getOriginalImage

This method can be used to retrieve an original image by using its origimgtoken. The client has to have permission to retrieve images or a fault code will be returned.

4.23.1 Request


orgimgtoken long X The token to identify the requested image.

width int If set, the requested image will be returned with the specified width (aspect ratio will stay the same).

dpi int If set, the requested image will be set to the specified dpi.

4.23.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:getOriginalImage>


<width>500</width>

<dpi>72</dpi>

</ws:getOriginalImage>

</soapenv:Body>

</soapenv:Envelope>

4.23.2 Response


return OriginalImage An object containing the base64 encoded image and its MIME type.

4.23.2.1 Example


<S:Body>

<ns2:getOriginalImageResponse xmlns:ns2="http://ws.eurotours.at/">

<return>

<base64image>BASE64ENCODEDIAMGE</base64image>

<mimetype>image/jpeg</mimetype>

</return>

</ns2:getOriginalImageResponse>

</S:Body>

</S:Envelope>


42 /


getRoomSpecifications (deprecated)

This method can be used to get information (capacity, description) about a specified room type.

4.24.1 Request



Default: “en”

roomcode String X Code of the room to get specifications for.

4.24.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:getRoomSpecifications>


<roomcode>Z3CW</roomcode>

</ws:getRoomSpecifications>

</soapenv:Body>

</soapenv:Envelope>

4.24.2 Response


return RoomtyperoomTypeRules An object containing information about the room. (esp. occupancy related information)

4.24.2.1 Example


<S:Body>

<ns2:getRoomSpecificationsResponse


<return>

<maxadults>3</maxadults>

<maxage>17</maxage>

<maxchilds>3</maxchilds>

<maxoccupancy>3</maxoccupancy>

<minoccupancy>2</minoccupancy>

<numberofrooms>0</numberofrooms>


<roomdescription>2-3 Bett Bad/Dusche/WC</roomdescription>

</return>

</ns2:getRoomSpecificationsResponse>

</S:Body>

</S:Envelope>


43 /


getSeasons

Returns an element list containing all seasons whose valid thru date is not yet expired.

4.25.1 Request

This method has no parameters.


4.25.2 Response


return Season

Element List

A list of season objects containing information about available seasons. (code, description, valid period)


<S:Body>

<ns2:getSeasonsResponse xmlns:ns2="http://ws.eurotours.at/">

<return>

<code>WI14/15</code>

<description>Wintersaison 14/15</description>

<valid>

<from>2014-12-01T00:00:00+01:00</from>

<thru>2015-04-30T00:00:00+02:00</thru>

</valid>

</return>

<return>

<code>2015</code>

<description>Städte 2015</description>

<valid>

<from>2014-11-01T00:00:00+01:00</from>

<thru>2015-11-01T00:00:00+01:00</thru>

</valid>

</return>

<return>

<code>SO15</code>

<description>Sommersaison 2015</description>

<valid>

<from>2014-05-01T00:00:00+02:00</from>

<thru>2015-11-30T00:00:00+01:00</thru>

</valid>

</return>

<return>

<code>WI15/16</code>

<description>Wintersaison 15/16</description>

<valid>

<from>2015-12-01T00:00:00+01:00</from>

<thru>2016-04-30T00:00:00+02:00</thru>

</valid>

</return>

<return>

<code>2016</code>


<valid>

<from>2015-11-01T00:00:00+01:00</from>

<thru>2016-11-01T00:00:00+01:00</thru>

</valid>

</return>

</ns2:getSeasonsResponse>

</S:Body>

</S:Envelope>


44 /


getVersion

This method can be used to retrieve information about the version of the service application.

4.26.1 Request


4.26.2 Response


return Version An object containing information about the version of the service.

4.26.2.1 Example


<S:Body>

<ns2:getVersionResponse xmlns:ns2="http://ws.eurotours.at/">

<return>

<application>Eurotours Accommodation WS -

Interface</application>

<fullversion>2.0202</fullversion>

<major>2</major>

<minor>2</minor>

<patchlevel>2</patchlevel>

<version>2.02.02</version>

</return>

</ns2:getVersionResponse>

</S:Body>

</S:Envelope>


45 /


replicateObjectDetails (deprecated)

Retrieves all objects that have a contract with a valid date after the specified date.


4.27.1 Request



Default: “en”

date DateTime X The starting date that will be used to search for vaild contracts.

In the current implementation this date will not be used, instead the current date will be used.

savepoint boolean If true, sets a savepoint for subsequent requests.

delta boolean If true, the response list will only contain objects that changed since the last savepoint was set.

4.27.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:replicateObjectDetails>


<date>2015-05-01</date>

<savepoint>true</savepoint>

<delta>true</delta>

</ws:replicateObjectDetails>

</soapenv:Body>

</soapenv:Envelope>


46 /


4.27.2 Response


return Object

Element List

Contains information about the objects.

4.27.2.1 Example

<return>


<address/>



<changes>ins</changes>



<objectcode>EXAMPLE CODE*7</objectcode>




<descriptions>

<full>Full description.</full>

<topic>Imagetext Hotel</topic>

</descriptions>

<images>

<copyright>(c) Copyright holder</copyright>


<URL>http://URL</URL>

</images>


<map>


<mapx>0.0</mapx>

<mapy>0.0</mapy>

</map>

<meal/>

<objectattributes>






<pets>false</pets>

<pool>false</pool>




</objectattributes>






<valid/>

</return>


47 /


searchBookableObjects

This method can be used to search for bookable objects.

The request is required to specify the date of arrival, the duration of the stay and a room object (with specified PAX and type), as well as some further critera to limit the result list (see remarks).

The response will contain an offer list that fits the search criteria. Offers contain prices for the specified room / PAX and information that can be used to make a booking.

Searching with objectcodes is limited to 30 elements.

4.28.1 Request



Default: “en”

arrival DateTime X The start time of the stay at the accommodation.

duration int X The duration of the stay at the accommodation in days.


Element List

(X) Restricts the response list to offerings in the specified location.


areacodes String

Element List

(X) Restricts the response list to offerings in the specified location.

A list of possible areas can be retrieved through getAreas.

objectcodes String

Element List

(X) Restricts the response list to offerings from the specified objects.

A list of possible locations can be retrieved through getObjects. Possible inputs are the objects code or the objects SVNO.

map Map (X) A Map object that contains longitude and altitude coordinates.

searchradius int (X) The radius from the specified coordinates in map that offerings can be located in.

48 /


rooms Roomx X Restricts the response list to offerings of the specified room criteria. (maximum PAX and room type)

4.28.1.1.1 Remarks

(X): One of the following search Criteria has to be used:

One or more locationcodes object

One or more areacodes object

Map – coordinates and a searchradius

One or more objectcodes object

4.28.1.2 Example



<soapenv:Header/>

<soapenv:Body>

<ws:searchBookableObjects>










<objectcodes>1234567</objectcodes>















<rooms>

<passengers>

<age>30</age>



</passengers>

<passengers>

<age>30</age>



</passengers>


</rooms>

</ws:searchBookableObjects>

</soapenv:Body>

</soapenv:Envelope>


49 /


4.28.2 Response


return Offer

Element List

A list containing accommodation offerings that match the search criteria.


<S:Body>

<ns2:searchBookableObjectsResponse xmlns:ns2="http://ws.eurotours.at/">

<return>

<amount>



</amount>

<object>


<address/>




<giata>123456</giata>


<objectcode>OBJECTCODE</objectcode>




<map>


<mapx>0.0</mapx>

<mapy>0.0</mapy>

</map>

<meal>

<code>FS</code>

</meal>

<objectattributes>






<pets>false</pets>

<pool>false</pool>




</objectattributes>






<valid/>

</object>

<rooms>




<passengers>

<age>30</age>

<firstname>calc</firstname>

<lastname>calc</lastname>

</passengers>

<passengers>

<age>30</age>



</passengers>


</rooms>

</return>

</ns2:searchBookableObjectsResponse>

</S:Body>

</S:Envelope>


50 /


searchObjects

This method can be used to retrieve a list containing object that fit the specified search criteria.

The request is required to specify the date of arrival and the duration of the stay. Since the result list will yield all possible objects (i.e. a lot), it is adviseable to use more search critera than that.

The response will return a list containing objects (extensive information about the object) that fit the search cirteria.

4.29.1 Request



Default: “en”

arrival DateTime X The start time of the stay at the accommodation that is associated with the objects that fit the search criteria.

duration int X The duration of the stay at the accommodation.

availability int The minimum number of rooms available at the object.

This parameter is currently not supported.


Element List

Restricts the response list to offerings in the specified location.


areacodes String

Element List

Restricts the response list to offerings in the specified location.

A list of possible areas can be retrieved through getAreas.

objectscode String Restricts the response list to offerings from the specified object.

Accepts either the object code or the SVNO.

servicetype String Restrict the response list to offerings of the specified type of service.

Can be “ZIMMER” (room) or “APPART” (apartment).

accommodationattributecode String Used for TXA searches, soon to be deprecated.

themecode long Restricts the response list to offerings that have the specified themecode.

category int Restricts the response list to offerings of the specified category.

A list of possible list of categories can be retrieved through getCategory.

51 /


showrate boolean If set to “true”, the price attribute (float Object.Night.Room.price) of the objects in the response list will be set. If the roomtype (String Object.Night.Room.Code) is “POOL”, the price will be set to 0.

Default: false

address boolean If true, response will also show the address of the objects.

Will only work if the client has permission to retrieve addresses, otherwise the response will be empty.

fulldata boolean If true: The description attribute of the response object will contain the full description. Otherwise the full:String will be empty.

4.29.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:searchObjects>










<objectcode>SOLGARD UMAG</objectcode>













<fulldata>true</fulldata>

</ws:searchObjects>

</soapenv:Body>

</soapenv:Envelope>


52 /


4.29.2 Response


return Object

Element List

An object containing information about the objects that fit the search criteria.


<S:Body>

<ns2:searchObjectsResponse xmlns:ns2="http://ws.eurotours.at/">

<return>


<address/>



<contract>


<age>

<from>0</from>

<thru>6</thru>

</age>


<reduction>



</reduction>

<valid>

<from>2015-05-31T00:00:00+02:00</from>

<thru>2015-09-05T00:00:00+02:00</thru>

</valid>


<cancellationRules>




<valid/>

<value>20.0</value>






<meal>

<code>FS</code>


</meal>

<rates>




<room>


<code>Z2DWT</code>

<description>2 bed shower/WC/balcony</description>


<price>0.0</price>

</room>

<valid>

<from>2015-06-29T00:00:00+02:00</from>

<thru>2015-08-08T00:00:00+02:00</thru>

</valid>

</rates>

</contract>




<objectcode>OBJECT IDENTIFICATION</objectcode>






53 /


<descriptions>

<full>Hotel description.</full>

<topic>Imagetext Hotel</topic>

</descriptions>

<images>



<URL> http://URL </URL>

</images>

<includes>

<full>Description of included service<full>

<topic>Topic of service.</topic>

</includes>

<map>


<mapx>0.0</mapx>

<mapy>0.0</mapy>

</map>

<meal>

<code>FS</code>


</meal>

<nights>





<rooms>


<code>Z2DWT</code>



<price>0.0</price>

</rooms>

</nights>

<objectattributes>






<pets>false</pets>

<pool>false</pool>




</objectattributes>







<valid>

<from>2015-05-31T00:00:00+02:00</from>

<thru>2015-09-06T00:00:00+02:00</thru>

</valid>

</return>

</ns2:searchObjectsResponse>

</S:Body>

</S:Envelope>

changePassengerNames



Default: “en”

54 /


session


bucname String X id of the booking that you would like to change.


passenger passengerType X The passengers list you want to change the names from

4.30.1 Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.eurotours.at/">

<soapenv:Header/>

<soapenv:Body>

<ws:changePassengerNames>









<passenger>

<title>mr</title>

<firstname>Anton</firstname>

<lastname>Meier</lastname>

<id>90000000170051</id>

</passenger>

<passenger>

<title>mrs</title>

<firstname>Hansi</firstname>


<id>90000000170052</id>

</passenger>

</ws:changePassengerNames>

</soapenv:Body>

</soapenv:Envelope>


55 /


4.30.2 Response


return Object

Element List

An object containing information about the objects that fit the change Name criteria.

4.30.2.1 Example


<S:Header>

<WorkContext xmlns="http://oracle.com/weblogic/soap/workarea/">rO0ABXdQABZ3ZWJsb2dpYy5hcHAueG1sXzIuMi40AAAA1gAAACN3ZWJsb2dpYy53b3JrYXJlYS5TdHJpbmdXb3JrQ29udGV4dAAJMS4wLjYtNDU1AAA=</WorkContext>

</S:Header>

<S:Body>

<ns0:changePassengerNamesResponse xmlns:ns0="http://ws.eurotours.at/">


</ns0:changePassengerNamesResponse>

</S:Body>

</S:Envelope>

getRoomTypeDetails

This request does take a contract identifier either contractid which will maybe made available in the future or the already available descriptionidentification and will return all available rooms with there relative rules of that contract bause the room information have only a relevance to the contract itself. This request replaces the getRoomSpecifications.

4.31.1 Request



contractid String For the future this Id might be relevant at the moment the interface does not provide this information.

descriptionidentification String This id is available in different request like getOjbect, SearchObjects


56 /


roomtype String If you want to filter for specific Room code inside the contract

4.31.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:getRoomTypeDetails>



</ws:getRoomTypeDetails>

</soapenv:Body>

</soapenv:Envelope>

4.31.2 Response


rooms List of roomTypeRules A list of roomTypeRules

4.31.2.1 Example


<S:Header>

<WorkContext

xmlns="http://oracle.com/weblogic/soap/workarea/">rO0ABXdQABZ3ZWJsb2dpYy5hcHAueG1sX

zIuMi40AAAA1gAAACN3ZWJsb2dpYy53b3JrYXJlYS5TdHJpbmdXb3JrQ29udGV4dAAJMS4wLjYtNDY2AAA=

</WorkContext>

</S:Header>

<S:Body>

<ns0:getRoomTypeDetailsResponse xmlns:ns0="http://ws.eurotours.at/">

<return>


57 /


<room>

<globalcode>SR</globalcode>

<maximumadults>1</maximumadults>

<maximumagechilds>17</maximumagechilds>

<maximumchilds>1</maximumchilds>

<maximumoccupancy>1</maximumoccupancy>

<minimumoccupancy>1</minimumoccupancy>

<roomdescription>single room suite executive</roomdescription>

<roomtypecode>3_P10022</roomtypecode>

</room>

<room>

<globalcode>DR</globalcode>






<roomdescription>double room suite sea view</roomdescription>


</room>

<room>

<globalcode>TR</globalcode>






<roomdescription>double room standard</roomdescription>


</room>

<room>

<global4code>U14K</global4code>

<globalcode>SU</globalcode>






<roomdescription>5 Bed bath/shower/WC/balcony,

Suite</roomdescription>

<roomtypecode>Z5BWT2</roomtypecode>

</room>

</return>

</ns0:getRoomTypeDetailsResponse>

</S:Body>

</S:Envelope>


58 /


5 Individual Requests

The methods in this section are only used for B2C requests or in relation to B2C requests.

addUser

This method adds a user to the client. The response will yield a session object with an id that can be used for B2C transactions.

5.1.1 Request



Default: “en”

user User X The user that is to be added.

5.1.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:addUser>


<user>

<email>[email protected]</email>

<fax>1234567890</fax>

<firstname>Arnold</firstname>

<lastname>Schwarzenegger</lastname>

<location>Graz</location>

<login>

<password>password</password>

<username>Exampleuser</username>

</login>

<nationcode>A</nationcode>

<sex>M</sex>

<street>Fakestreet 123</street>

<taxnumber>1234567890</taxnumber>

<tel>1234567890</tel>

<title>Dr.</title>

<zipcode>12345</zipcode>

</user>

</ws:addUser>

</soapenv:Body>

</soapenv:Envelope>


59 /


5.1.2 Respose


session Session Required for B2C requests.

5.1.2.1

5.1.2.2 Example


<S:Body>

<ns2:addUserResponse xmlns:ns2="http://ws.eurotours.at/">

<return>

<id>wjl5s6egpba7cf2lk8rc617q56q2m9vg</id>

</return>

</ns2:addUserResponse>

</S:Body>

</S:Envelope>

login

This method can be used to log in with the credentials of a user that has been added with the addUser method. The response will yield a session object with an id that can be used for B2C transactions.

5.2.1 Request


credentials Credentials X The credentials of the user to log in with.

5.2.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:login>

<credentials>



</credentials>

</ws:login>

</soapenv:Body>

</soapenv:Envelope>


60 /


5.2.2 Response


return Session An object containing the session id.

Required for B2C requests.

5.2.2.1 Example


<S:Body>

<ns2:loginResponse xmlns:ns2="http://ws.eurotours.at/">

<return>

<id>bnvysvdftq7e8paflqd4ur3ifewyk0it</id>

</return>

</ns2:loginResponse>

</S:Body>

</S:Envelope>

Lostpassword (deprecated)


This method can be used to send the password of a user to the email address specified in the user data.

5.3.1 Request



Default: “en”

email String X The email address to send the password to.

5.3.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:lostpassword>



</ws:lostpassword>

</soapenv:Body>

</soapenv:Envelope>

5.3.2 Response


return boolean Returns


61 /


getUserdata

This method can be used to retrieve the data of a user that correlates to the provided Session id.

5.4.1 Request



Default: “en”

session Session X Code of the room to get specifications for.

5.4.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:getUserdata>


<session>

<id>2fvj0stfiiokmgd62po2erg82w48ey14</id>

</session>

</ws:getUserdata>

</soapenv:Body>

</soapenv:Envelope>

5.4.2 Response


return User An object containing information about the user. (Credential data will be omitted)


<S:Body>

<ns2:getUserdataResponse xmlns:ns2="http://ws.eurotours.at/">

<return>


<fax>1234567890</fax>




<login/>


<sex>M</sex>


<tel>1234567890</tel>

<title>Dr.</title>


</return>

</ns2:getUserdataResponse>

</S:Body>

</S:Envelope>


62 /


changeUserdata

This method can be used to change the data of a user.

5.5.1 Request



Default: “en”

session


user User X An object containing the new user data.

5.5.1.1 Example <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"


<soapenv:Header/>

<soapenv:Body>

<ws:changeUserdata>


<session>

<id>gpo9uwhwlt4ywsx1qybwtn6pc22cmf4e</id>

</session>

<user>


<fax>1234567890</fax>



<location>Florida</location>

<login>



</login>


<sex>M</sex>



<tel>1234567890</tel>

<title>Dr.</title>


</user>

</ws:changeUserdata>

</soapenv:Body>

</soapenv:Envelope>

5.5.2 Response


return boolean Contains “true” if the change of user data was successful.

5.5.2.1 Example


<S:Body>

<ns2:changeUserdataResponse xmlns:ns2="http://ws.eurotours.at/">


</ns2:changeUserdataResponse>

</S:Body>

</S:Envelope>


63 /


getNations

This method can be used to retrieve a list of available nations.

5.6.1 Request



Default: “en”

5.6.1.1 Example



<soapenv:Header/>

<soapenv:Body>

<ws:getNations>


</ws:getNations>

</soapenv:Body>

</soapenv:Envelope>

5.6.2 Response


return Nation

Element List

A list of the nations that are available.

5.6.2.1 Example


<S:Body>

<ns2:getNationsResponse xmlns:ns2="http://ws.eurotours.at/">

<return>

<code>AF</code>

<name>Afghanistan</name>

</return>

<return>

<code>ZW</code>

<name>Zimbabwe</name>

</return>

</ns2:getNationsResponse>

</S:Body>

</S:Envelope>


64 /


getPayment (deprecated)

This method is no longer supported/deprecreated!

5.7.1 Request



Default: “en”

sessions Session (X) Required for B2C requests.

bucname String X Unique id of the booking the get the payment information from.

5.7.2 Response


return Payment A payment object that contains information about the payment associated with the requested booking.

confirmBanktransferTransaction (deprecated)

This method is no longer supported/deprecated!

5.8.1 Request



Default: “en”

session

Session X Required for B2C requests.

bucname String X Unique id of the booking to confirm the bank transfer transaction from.

acceptterms boolean X Boolean to check whether the terms of service have been accepted.


65 /


5.8.2 Response


return boolean Contains “true” if the Transaction could be confirmed.

confirmCreditcardTransaction (deprecated)


5.9.1 Request



Default: “en”

session


bucname String X Unique id of the booking to confirm the credit card transaction for.

creditcard Creditcard X Credit card information.

acceptterms boolean Boolean to check whether the terms of the transaction have been accepted.

5.9.2 Response




66 /


confirmDirectDebitingService (deprecated)


5.10.1 Request



Default: “en”

session


bucname String X Unique id of the booking to confirm the direct debit service from.

directdebiting DirectDebiting X Information about the direct debiting service.

acceptterms boolean Boolean to check whether the terms of service have been accepted.

5.10.2 Response




67 /


confirmInvoiceTransaction (deprecated)


5.11.1 Request



Default: “en”

session


bucname String X Unique id of the booking to confirm the invoice transaction from.

acceptterms boolean Boolean to check whether the terms of service have been accepted.

5.11.2 Response




68 /


6 Types

This section contains descriptions of types used by the methods.

Location

Objects of this type describe locations.

Locations are associated with an area, which may be a region or a nation.


airport Airport Information about airports at the location.

code String A code identifying the location.

descriptions Description

Element List

A list of descriptions of the location.

Currently not in use!

images Image

Element List

A list of images assigned to the location.


mapx float The longitude of the location.

mapy float The latitude of the location.

name String The name of the location. Modified by the language set in the request.

6.1.1 Used by

getLocations

6.1.2 Example

<return>

<airport>

<code>VIE</code>

</airport>

<code>Wien</code>

<mapx>16.37308</mapx>

<mapy>48.20828</mapy>

<name>Vienna</name>

</return>


69 /


Airport


code String A 3-letter code to identify the airport.

description String A description of the airport.

Mostly unused.

6.2.1 Used by

Location

6.2.2 Example

<airport>

<code>VIE</code>

</airport>

Description


full String A String containing the description.

topic String A String containing the topic of the description.

6.3.1 Used by

Location

Object

6.3.2 Example

<descriptions>

<full>Reception, Reception area, Hall/Lobby, Reading Room,

Zirbenstüberl, Boot room, Ski room, Lift, Parking: payable on site,

Euro 14,- per day, 2 restaurants, Bar.</full>

<topic>General facilities</topic>

</descriptions>


70 /


Image

Contains information about a thumbnail and – sufficient rights provided – a token with which to retrieve the full size image.


copyright String Owner of the copyright

orgimgtoken long Identifier of the original full size image

If the user does not have sufficient rights to request origimgtokens, this attribute will be set to 0 or if the original image does not exists anymore.

Note: This token is only valid for 30 minitues after that you would need to get a new one to be able to call the originalimage again.

URL anyURI A URL to the image.

6.4.1 Used by

Location

Object

6.4.2 Example

<images>



<URL>http://www.exampleurl.at/business/docs/example/example.JPG</URL>

</images>


71 /


Version


application String The name of the application providing the service.

fullversion float The full version number in float.

major int The major revision number.

minor int The minor revision number.

patchlevel int The patchlevel number.

version String The version number containing the major, minor and patchlevel number.

6.5.1 Used By

getVersion

6.5.2 Example

<return>

<application>WS - Interface</application>

<fullversion>2.0202</fullversion>

<major>2</major>

<minor>2</minor>

<patchlevel>2</patchlevel>

<version>2.02.02</version>

</return>


72 /


Session


id String Generated session id.

Can be obtained through the responses of login or addUser.

6.6.1 Used By

Most methods only accept requests from B2C clients if a session id is provided.

6.6.2 Example

<return>

<id>a8dmx4g97px9bx4dn2u5w4l3nde5ty39</id>

</return>

Voucher

The methods that use this type are currently not supported!


code String An id to identify the voucher.


73 /


Object

Objects of this type represent bookable objects (which may be hotels, guesthouses, etc.). The contents of the object will vary due to the kind of request that was used to obtain them.


accommodationattrib

utes

AccommodationAttribute

Element List

A list containing elements that describe accommodation attributes.

(for example: ALL INCLUSIVE, SKIINOUT, WELLNESS)

accommodationattrib

utethemeproz

int Currently not in use!

address Address The address of the object.

Clients need sufficient rights to retrieve this attribute.

bookpricefrom float Currently not in use!

category int Hotel category in stars.

changes String Changes of the delta upd del ins

contract Contract An object describing the contract that exists with this object.

contractidentification ContractIdentification An object with attributes to identify the contract with the object.

currency String Currency used at the object.

descriptionidentificat

ion

long The objects SVNO – can be used to identify the object.

descriptions Description

Element List

A list containing elements description elements.

A description contains a topic and a full description.

images Image

Element List

A list containing image elements associated with the object.

Images contain tokens with which to request full size images.

includes Description

Element List


locationcode String The identifying code of the location.

map Map Map coordinates of the object.


74 /


marketexclusions String

Element List

This attribute is not supported!

meal Meal The default type of boarding this object supplies.

name String A string containing the name of the object

nights Night

Element List

Information about the accommodations available at this object.

objetattributes ObjectAttributes Deprecated, may be inaccurate!

partner boolean Only used for specific customers, will be false in most cases.

paxnights int Total number of available bookings at the object during the valid period of the contract.

pricefrom float This attribute is not supported!

pricefromdescription String This attribute is not supported!

pricemethode int Default method with which to calculate the price with. Interval [0,5]

Price per…

0: PAX and night

1: PAX

2: Night and unit

3: Week and unit

4: Week and PAX

5: Unit

shortdescription String A short description of the object.

startdate DateTime The start date of the search, usually the same as the arrival date specified in the request.

tpackage boolean This attribute is not supported!

valid DateRange The period in which the information about this object is valid.

roomtype 6.63roomTypeRules A list of rooms that is available in the contract and there rooms that apply


75 /


Used By getObjects getObjectDetails searchObjects

replicateObjectDetails Offer

6.8.1 Example <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

<S:Body>

<ns2:getObjectsResponse xmlns:ns2="http://ws.eurotours.at/">

<return>


<address/>





<objectcode>HOTEL EXAMPLE*5</objectcode>

<productcode>PRO_DUCT-COD</productcode>






<map>


<mapx>12.34567</mapx>

<mapy>45.67890</mapy>

</map>

<meal>

<code>X</code>

<description>meal according to description</description>

</meal>

<name>Example Name</name>

<nights>





<rooms>


<code>E1CW</code>


<price>0.0</price>

</rooms>

</nights>

<objectattributes>






<pets>false</pets>

<pool>false</pool>




</objectattributes>







<valid>

<from>2015-04-01T00:00:00+02:00</from>

<thru>2015-10-31T00:00:00+01:00</thru>

</valid>

</return>

</ns2:getObjectsResponse>

</S:Body>

</S:Envelope>


76 /




code String The code with which to identify the attribute with.

desc String Description of the attribute in the specified language.

kind String Description of the period the attribute is valid in.

themes AccommodationAttributeTheme The theme associated with the attribute.

6.9.1 Used By

getAccommodationAttributes

Object

6.9.2 Example

<return>

<code>WINTERWONDER</code>

<desc>Winter Wonderland holidays</desc>

<kind>winter</kind>

<themes>


<id>28</id>

</themes>

</return>

AccommodationAttributeTheme


desc String A String containing a description of the theme.

id int An id to identify the theme with.

6.10.1 Used By


6.10.2 Example

<themes>


<id>28</id>

</themes>


77 /


Address

This object contains information (location / contact) about an object.


email String The email address of the object.

fax String The fax number of the object.

location String The name of the location the object is at. In most cases this is not the same as the location code.

nation String The code of the nation the object is located in.

street String The street and house number of the address of the object.

tel String The telephone number of the object of the object.

zip String The zip code of the object.

6.11.1 Used By

Object

6.11.2 Example

<address>


<fax>+43 123 12345678</fax>

<location>Innsbruck</location>

<nation>A</nation>

<street>address 5 - Examplestreet</street>

<tel>+43 123 123456</tel>

<zip>6020</zip>

</address>


78 /


Contract


agerelatedreductions AgeRelatedReduction

Element List

A list containing objects that hold information about age related price reductions.

bookingtimerelatedre

ductions

BookingTimeRelatedReduction

Element List

A list containing objects that hold information about booking related reductions.

cancellationRules CancellationRule

Element List

A list containing objects that hold information about rules that apply on cancellation of a booking.

contractIdentification ContractIdentification An object containing information that distinctively identify the contract.

currency String Contains a short identification of the currency.

durationrelatedreduc

tions

DurationRelatedReduction

Element List

A list containing objects that hold information about duration related price reductions.

meal Meal An object containing information about what kind of board is specified in the contract.

mealrelatedreductions MealRelatedReduction

Element List

A list containing objects that hold information about meal related price reductions.

occupancyrelatedredu

ctions

OccupancyRelatedReduction

Element List

A list containing objects that hold information about occupancy related price reductions.

rates Rate

Element List

A list containing objects that hold information about the rates of accommodations specified in the contract.

supplements Supplement

Element List

A list containing objects describing supplementary services/costs that may arise during the stay.

agerestrictions ageRestrictions

Element

Has list of ageRestriction


79 /


6.12.1 Used By

getContractRates

Object

6.12.2 Example

<return>


<age>

<from>0</from>

<thru>6</thru>

</age>


<reduction>



</reduction>

<valid>

<from>2016-05-31T00:00:00+02:00</from>

<thru>2016-09-05T00:00:00+02:00</thru>

</valid>


<cancellationRules>




<valid/>

<value>20.0</value>






<meal>

<code>FS</code>

<description>Frühstück</description>

</meal>

<rates>




<room>


<code>Z2DWT</code>



<price>0.0</price>

</room>

<valid>

<from>2016-07-27T00:00:00+02:00</from>

<thru>2016-08-08T00:00:00+02:00</thru>

</valid>

</rates>

</return>


80 /


AgeRelatedReduction


age AgeRange The interval of the age of the PAX the price reduction applies to.

fullpayingpassengers int The minimum amount of fully paying customers for the price reduction to apply.

reduction Reduction An object containing information from which to derive the amount of the reduction from.

roomcode String If the price reduction only applies to certain rooms, this string will contain the code with which to identify them.

valid DateRange The reductions is only applied to bookings that fall into the valid period of the reduction.

6.13.1 Used By

Contract

6.13.2 Example


<age>

<from>0</from>

<thru>6</thru>

</age>


<reduction>



</reduction>

<valid>

<from>2016-05-31T00:00:00+02:00</from>

<thru>2016-09-05T00:00:00+02:00</thru>

</valid>



81 /


AgeRange


from int Start of the rage interval.

thru int End of the range interval.

6.14.1 Used By

AgeRelatedReduction MealRelatedReduction

6.14.2 Example

<age>

<from>0</from>

<thru>6</thru>

</age>

Reduction


method int The method of the price reduction.

Possible values:

0: The value of the value attribute is an amount.

1: The value of the value attribute is percentage based.

2: The value of the value attribute represents number of days that do not have to be paid.

value float The value of the price reduction.

This value is usually specified as a negative value (positive value would add to the price of the booking).

6.15.1 Used By

AgeRelatedReduction BookingTimeRelatedReduction DurationRelatedReduction

MealRelatedReduction OccupancyRelatedReduction

6.15.2 Example

<reduction>



</reduction>


82 /


DateRange


from DateTime The beginning of the date range.

thru DateTime The end of the date range.

6.16.1 Used By

Object CancellationRule AgeRelatedReduction

BookingTimeRelatedReduction DurationRelatedReduction

MealRelatedReduction OccupancyRelatedReduction

Rate Season

6.16.2 Example

<valid>

<from>2016-05-31T00:00:00+02:00</from>

<thru>2016-09-05T00:00:00+02:00</thru>

</valid>


83 /


BookingTimeRelatedReduction


bookingdate DateRange The reductions is only applied to bookings that fall into the valid period of the reduction.

daysbeforebooking int The number of days the booking has to be made before arrival for the reduction to apply.

minStay int The minimum duration of the booked stay the rule necessitates to become active.

occupancycontrol int Describes the way in which the bookingdate attribute is interpreted:

For the reduction to apply, the booking has to be made:

0: … between the from and thru attributes of bookingdate (inclusive).

1: …after the from attribute of bookingdate (inclusive).

2: …before the thru attribute of bookingdate (inclusive).

reduction Reduction An object containing information from which to derive the amount of the reduction from.

roomcode String If the price reduction only applies to certain rooms, this string will contain the code with which to identify them.

valid DateRange The reductions is only applied to bookings that fall into the valid period of the reduction.

6.17.1 Used By

Contract


84 /


6.17.2 Example

<bookingtimerelatedreductions>

<bookingdate/>

<daysbeforebooking>60</daysbeforebooking> <minStay>7</minStay>

<occupancycontrol>2</occupancycontrol>

<reduction>


<value>-5.0</value>

</reduction>

<valid>

<from>2015-04-12T00:00:00+02:00</from>

<thru>2015-12-22T00:00:00+01:00</thru>

</valid>

</bookingtimerelatedreductions>


85 /


CancellationRule


daysAfterBooking int Describes how many days it takes for the rule to apply after booking has been made.

daysBeforeArrival int Describes how many days before the arrival date of the booking the rule expires.

fixDate DateTime This attribute is currently not supported!

method int Field was named methode in previous versions.

The meaning of the returned values has changed.

Describes the method used to calculate the fee.

0: Percentage of the booking price.

1: Number of nights booked.

2: An absolute value.

valid DateRange The period in which the rule applies to bookings.

value float The value of the cancellation fee. The actual amount can be calculated by using the correct

mealType String If the current cancellation rule applies to a certain meal type, the type will be specified in this field

durationOfStayFrom int Lower boundry of the length of the booked period in which the cancellation rule applies

durationOfStayTo int Upper boundry of the length of the booked period in which the cancellation rule applies

durationOfStayMethod int Specifies whether the DurationOfStayFrom and DurationOfStayTo fields are inclusive:


86 /


0: DurationOfStayFrom

<= Booking date =< DurationOfStayTo

1: durationOfStayFrom

<= booking date

durationOfStayTo will be set to -1

2: booking date <= durationOfStayTo

durationOfStayFrom will be set to -1

cancellationFeeUnit int Specifies the unit per which the cancellation fee is applied:

0: per booking

1: per unit

2: per PAX

3: same method as specified in contract

Depending on the durationOfStayMethod, the durationOfStayTo and durationOfStayFrom fields may be set to -1. This implicates the field is to be ignored.

Property methode was renamed to method.

6.18.1 Used By

getCancellationRules Contract

Booking BookingDetail

6.18.2 Example

<return>




<valid/>

<value>20.0</value>

<mealType>FS</mealType>

<durationOfStayFrom>3</durationOfStayFrom>

<durationOfStayTo>7</durationOfStayTo>

<durationOfStayMethod>0</durationOfStayMethod>

<cancellationFeeUnit>1</cancellationFeeUnit>

</return>


87 /


ContractIdentification


giata String The GIATA id of the contract. If the contract has no giata identification, this field will be set to “0”.

individual boolean true: The contract is exclusive to a certain client.

false: The contract is available to all clients.

objectcode String A unique identification of the object subject to the contract.

productcode String If there are multiple contracts for the same service, the unique identification is needed to uniquely identify the contract.

servicetype String Describes what kind of accommodation is subject of the contract:

“ZIMMER”: Rooms

“APPART”: Apartments

suppliercode String If the hotel is contracted via an agency, this string will be used to identify it.

6.19.1 Used By

getContractRates checkBookability


88 /


bookAccommodation


89 /


getAdditionalServices Object Contract

BookingDetail

6.19.2 Example




<objectcode>OBJECTCODE*4</objectcode>

<productcode>ETI_M3-4T</productcode>

<servicetype>APPART</servicetype>




90 /




completeStayWithinPe

riode

boolean true: All days of the booking stay have to lie in the period specified in duration/durationcontrol.

description String A description string of the reduction.

duration NumberRange The length interval of the duration of the stay in which the reduction applies.

durationcontrol int Describes the way in which the duration attribute is interpreted:

The number of days of stays to which the reduction applies:

0: …lies between the from and thru attributes of duration (inclusive).

1: …is greater than the from attribute of duration (inclusive).

2: …is smaller than the thru attribute of duration (inclusive).

meal Meal If the duration related reduction is restricted to a specific meal type, this attribute will have a value, otherwise the reduction will apply irrespective of the chosen meal type.

reduction Reduction An object describing the amount of the price reduction.

roomcode String If the price reduction only applies to certain rooms, this string will contain the code with which to identify them

valid DateRange The reduction is only applied to bookings that fall into the valid period of the reduction.


91 /


6.20.1 Used By

Contract

6.20.2 Example

<durationrelatedreductions>

<completeStayWithinPeriode>false</completeStayWithinPeriode>

<description>7=6</description>

<duration>

<from>7</from>

<thru>13</thru>

</duration>

<durationcontrol>0</durationcontrol>

<meal/>

<reduction>


<value>-1.0</value>

</reduction>

<valid>

<from>2015-04-12T00:00:00+02:00</from>

<thru>2015-12-21T00:00:00+01:00</thru>

</valid>

</durationrelatedreductions>

NumberRange


from int The minimum number of the range.

thru int The maximum number of the range.

6.21.1 Example

<duration>

<from>7</from>

<thru>13</thru>

</duration>

6.21.2 Used By




92 /


Meal


code String A short code with which to identify the meal type with.

description String A description of the meal.

The output value of this attribute changes is changed by the specified language of the request.

6.22.1 Used By

getMeals DurationRelatedReduction

MealRelatedReduction Object

Contract BookingDetail

6.22.2 Example

<return>

<code>FS</code>


</return>


93 /


MealRelatedReduction


age AgeRange The age restriction of the reduction (applies only to PAX within the age range)

meal Meal The type of meal the reduction applies to.


valid DateRange The reduction is only applied to bookings that fall into the valid period of the reduction.

6.23.1 Used By

Contract

6.23.2 Example

<mealrelatedreductions>

<age>

<from>0</from>

<thru>5</thru>

</age>

<meal>

<code>HP</code>

<description>Halbpension</description>

</meal>

<reduction>


<value>0.0</value>

</reduction>

<valid>

<from>2015-04-12T00:00:00+02:00</from>

<thru>2015-12-22T00:00:00+01:00</thru>

</valid>

</mealrelatedreductions>


94 /



This type is used to describe price reductions that apply if the number of PAX of the booking lies within a certain range.


nrpax NumberRange The number range of the PAX staying at the accommodation for which the reduction applies.

occupancycontrol int Describes the way in which the nrpax attribute is interpreted:

The number of PAX to which the reduction applies:

0: …lies between the from and thru attributes of nrpax (inclusive).

1: …is greater than the from attribute of nrpax (inclusive).

2: …is smaller than the thru attribute of nrpax (inclusive).


roomcode String The code with which to identify the room code with.

valid DateRange The reduction only applies to bookings that fall within the valid period.

6.24.1 Used By

Contract <occupancyrelatedreductions>

<nrpax>

<from>1</from>

<thru>3</thru>

</nrpax>

<occupancycontrol>0</occupancycontrol>

<reduction>



</reduction>

<roomcode>A2-5T</roomcode>

<valid>

<from>2015-09-05T00:00:00+02:00</from>

<thru>2015-10-17T00:00:00+02:00</thru>

</valid>

</occupancyrelatedreductions>


95 /


Rate

Objects of this type are used to describe the prices of various objects and services.


baserate float The base rate for the price calculation. This usually refers to adults before applying reductions.

childrates ChildRate

Element List

If different rates apply to children, they will be described by this objects in this list.

fullypayingpassengers int The minimum of fully paying customers that have to stay at the accommodation. (PAX to which childRates apply do not count toward)

pricemethode int Method with which to calculate the price with. Interval [0,5]

Price per…

0: PAX and night

1: PAX

2: Night and unit

3: Week and unit

4: Week and PAX

5: Unit

room Room Describes the room type this rate applies to.

valid DateRange The period in which the rate applies.

6.25.1 Used By

Contract Supplement

6.25.2 Example

<rates>




<room>


<code>A2-5T</code>

<description>2-Raum-App, 5 Betten, Balkon</description>


<price>0.0</price>

</room>

<valid>

<from>2015-03-07T00:00:00+01:00</from>


96 /


<thru>2015-03-20T00:00:00+01:00</thru>

</valid>

</rates>

ChildRate

Contains the price for children and the age until which it applies.


age int The age until which the child rate is used.

rate float The price that applies to PAX until the specified age.

6.26.1 Used By

Rate

6.26.2 Example

<childrates>

<age>13</age>

<rate>0.0</rate>

</childrates>


97 /


Room


allotment int Number of rooms of this type available in the contingent.

bookableroomcode String

Element List

If the code is “POOL”, the room codes contained in the pool will be return in this list.

code String The unique identifier of the type of the room.

description String A description string of the room.

paxnights int The total number nights available for booking at the specified room type during the valid period of the object the room is specified in.

Will return 0 if the code:String is “POOL”.

price float Returns the price of a paxnight.

Will be 0 if the user does not have sufficient permissions, if the rooms code is pool or if the room is an attribute of rate.

6.27.1 Used By

Rate Night getContractRates

6.27.2 Example

<rooms>


<code>Z2DWT</code>



<price>0.0</price>

</rooms>


98 /


Supplement

Objects of this type describe supplementary services/costs that may arise during the stay.


description String String containing a description of the supplement.

mandatory boolean If true:

The supplement is mandatory to bookings in the valid period.

rates Rate A price description of the supplement.

6.28.1 Used By

Contract

6.28.2 Example

<supplements>

<description>Kurtaxe</description>

<mandatory>true</mandatory>

<rates>


<childrates>

<age>13</age>

<rate>0.0</rate>

</childrates>



<room>



<price>0.0</price>

</room>

<valid>

<from>2014-11-29T00:00:00+01:00</from>

<thru>2015-04-25T00:00:00+02:00</thru>

</valid>

</rates>

</supplements>


99 /


Map


mapexact boolean true: The coordinates are pointing at the objects exact location.

false: The coordinates only point at the region the object is located in.

mapx float The longitude of the coordinates.

mapy float The latitude of the coordinates.

6.29.1 Used By

Object searchBookableObjects

6.29.2 Example

<map>


<mapx>11.39731</mapx>

<mapy>47.27464</mapy>

</map>


100 /


Night

Objects of this type describe the allotment of room types that can be booked from objects, and additional restrictions that concern them.


arrivalpossible boolean Specifies whether arrival is possible at the startdate specified in the Object this Night is an attribute of.

departurepossible boolean Specifies whether departure is possible at the startdate specified in the Object this Night is an attribute of.

ismaximum boolean Signifies whether the minimumstay amount is the maximum days that the accommodation can be booked.

miniumstay int The minimum days that have to be booked at this accommodation

rooms Room

Element List

A list of the rooms associated with this object.

6.30.1 Used By

Object

6.30.2 Example

<nights>





<rooms>


<code>Z4DWT</code>


<price>0.0</price>

</rooms>

</nights>


101 /


ObjectAttributes (deprecated)

Attributes that describe the facilities available at the object.

Deprected, may be inaccurate on newer objects.


center boolean The object is located in a city center.

creditcard boolean Creditcard payment is possible.

elevator boolean The object has elevators.

fitness boolean The object offers a fitness area.

parking boolean Extra parking facilities are available

pets boolean Pets can stay at the object.

pool boolean There is a pool at the object available.

resturant boolean There is a restaurant at the object.

sauna boolean There is a sauna at the object.

wheelchair boolean Wheelchair access is available.

6.31.1 Used By

Object

6.31.2 Example

<objectattributes>






<pets>false</pets>

<pool>false</pool>




</objectattributes>


102 /


AdditionalService


arrival boolean This attribute is currently not supported!

choices Choice

Element List

This list will contain elements if the mandatory attribute is true.

date DateTime The date for which the service is booked

description String Description of the additional service.

displaydate boolean This attribute is currently not supported!

flight boolean This attribute is currently not supported!

group int If =! 0:

Only one service with the same group value can be added to a booking.

helptxt String The additional service may yield an additional help text describing the offered service.

id long Unique ID of the service.

mandatory boolean If true: The response objects choices attribute will contain a list with possible additional services, of which one must be chosen.

Mandatory services will have their price attribute set to 0.

modifydate boolean If returned true, it is possible to modify the date the service has been booked for.

The valid range of the new date is from arrival until departure.

modifypax boolean If returned true, it is possible to modify the AdditionalService- Passanger attribute of the service.


103 /


modifyunit boolean If returned true, it is possible to modify the unit’s attribute of the service.

passengers AdditionalServicePassenger

Element List

A list comprised passengers for who the service will be booked.

price float The price of the additional service. Will be 0 if the service is mandatory.

unit int Quantity of units the service is comprised of.

6.32.1 Used By

Booking


104 /


getAdditionalServices

addAdditionalServices

6.32.2 Example

<return>


<date>2015-06-07T00:00:00+02:00</date>

<description>Supplement ferry from/to Example City</description>



<group>0</group>

<id>123457890</id>





<passengers>

<id>2912345678</id>

<passenger>

<age>25</age>

<firstname>Testname</firstname>

<lastname>Examplename</lastname>

<title>Mr.</title>

</passenger>

<price>0.0</price>

</passengers> <passengers> <id>2912345679</id>

<passenger> <age>10</age>



</passenger> <price>0.0</price>

</passengers>

<passengers> <id>2912345680</id>

<passenger> <age>25</age>



<title>MR.</title>

</passenger>

<price>0.0</price>

</passengers>

<price>0.0</price>

<unit>0</unit>

</return>


105 /


Choice


code String A code to identify the choice with.

description String A String containing a description of the content of the choice object.

6.33.1 Used By

AdditionalService

AdditionalServicePassenger

Object used as attribute of AdditionalService to provide additional information in relation to passengers.


description String Additional description of the passenger.

id long Unique id of the passenger.

passenger Passenger The passenger this object is providing additional information on.

price float Cost of the additional service for the passenger.

6.34.1 Used By

AdditionalService

6.34.2 Example

<passengers>

<id>2912345678</id>

<passenger>

<age>25</age>



<title>Mr.</title>

</passenger>

<price>0.0</price>

</passengers>


106 /


Passenger

Contains relevant passenger information.


age int The age of the passenger.

birthdate DateTime Birtdate of the passenger.

firstname String The first name of the passenger.

lastname String The last name of the passenger

title String The title of the passenger.

id long Id use for changing the name of a passenger

6.35.1 Used By

AdditionalServicePassenger Roomx

6.35.2 Example

<passenger>

<age>25</age>



<title>Mr.</title>

</passenger>-

Payment (deprecated)

This type is currently not supported!


banktransfertransaction

BanktransferTransaction

creditcardtransaction CreditcardTransactio

directdebitingservice DirectDebitingService

invoicetransaction InvoiceTransaction


107 /


BanktransferTransaction (deprecated)



acount String

amounts Amount

Element List

bankinstitute String

bcn String

iban String

recipient String

swift String

Amount

Used to describe prices and payments.


amount float The value the price amounts to.

currency String The currency that applies to the price.

settlement DateTime If the pending settlement has been payed for, this object will contain the date the payment happened.

6.38.1 Used By


108 /


BanktransferTransaction CreditcardTransactio DirectDebitingService InvoiceTransaction

getCancellationFee Offer

BookingDetail

6.38.2 Example

<return>



</return>


109 /


CreditcardTransaction (deprecated)



amounts Amount

Element List

DirectDebitingService (deprecated)



amount Amount

DirectDebiting (deprectated)



account String

accountowner String

bankcountry String

bankname String

bcn String

6.41.1 Used by

confirmDirectDebitingService

InvoiceTransaction (deprecated)



amount Amount

Element List


110 /


Credentials

Contains data that is used to log in.


password String The password of the user.

username String The name of the user.

6.43.1 Used By

login

User

6.43.2 Example

<credentials>


<username>exampleuser</username>

</credentials>

Nation

Contains information about nations.


code String A short code to uniquely identify the nation.

name String The name of the nation. Modified by the language set in the request.

6.44.1 Used By

getNations

6.44.2 Example

<return>

<code>NR</code>

<name>Nauru</name>

</return>


111 /


Roomtype


maxadults int The maximum number of adults the room can hold.

maxage int PAX below the maxage will count as children (e.g. for age related price reductions).

maxchilds int The maximum number of children the room can hold.

maxoccupancy int The maximum occupancy of the room.

minoccupay int The minimum occupancy of the room.

numberofrooms int Signifies the number of rooms the object is describing.

This attribute is no longer supported!

roomcode String The code to identify the room type with.

roomdescription String The description of the room in the language specified in the request.

6.45.1 Used By

getRoomSpecifications


<S:Body>

<ns2:getRoomSpecificationsResponse xmlns:ns2="http://URL/">

<return>

<maxadults>3</maxadults>

<maxage>17</maxage>

<maxchilds>3</maxchilds>

<maxoccupancy>3</maxoccupancy>

<minoccupancy>2</minoccupancy>

<numberofrooms>0</numberofrooms>


<roomdescription>2-3 Bett Bad/Dusche/WC</roomdescription>

</return>

</ns2:getRoomSpecificationsResponse>

</S:Body>

</S:Envelope>


112 /


Bookability


bookable boolean true: There are still bookable rooms in the specified allotment.

false: There are no bookable rooms in the specified allotment.

reason String If bookable is false, this string will contain a reason why.

6.46.1 Used By

checkBookability


<S:Body>


<return>

<bookable>false</bookable>

<reason>No allotment available!</reason>

</return>


</S:Body>

</S:Envelope>

Roomx


nradults int The number of adults staying in the room.

Deprecated not needed can be filled with 0

nrchilds int The number of the children staying in the room.

Deprecated not needed can be filled with 0

nrrooms int The number of rooms the object is describing. (Should be 1)

passenger Passenger

Element List

A list containing all the passengers staying in the room.

roomcode String The unique code to identify the type of the room.


113 /


If


is used valid roomCode is X that includes any possible room in any other request use the concrete room code example Z2CW

description String Description of the room


114 /


6.47.1 Used By



115 /


bookAccommodation Offer BookingDetail

6.47.2 Example

<rooms>




<passengers>

<age>30</age>

<firstname>example</firstname>

<lastname>example</lastname>

</passengers>

<passengers>

<age>30</age>



</passengers>


</rooms>


116 /


Offer


amount Amount An object describing the price of the offered accommodation.

object Object Describes the offering object.

rooms Roomx

Element List

Description of the rooms the object is offering.

6.48.1 Used By


6.48.2 Example

<return>

<amount>



</amount>

<object>


<address/>





<objectcode>OBJECT CODE</objectcode>




<map>


<mapx>0.0</mapx>

<mapy>0.0</mapy>

</map>

<meal>

<code>FS</code>

</meal>

<objectattributes>






<pets>false</pets>

<pool>false</pool>




</objectattributes>






<valid/>

</object>


117 /


<rooms>




<passengers>

<age>30</age>



</passengers> <passengers>

<age>30</age>



</passengers>


</rooms>

</return>

User


email String E-mail address of the user.

fax String Fax number of the user.

firstname String First name of the user.

lastname String Last name of the user.

location String Location the user is from.

login Credentials Login credentials of the user.

nationcode String Nation code of the nation the user is from.

sex String Sex of the user.

street String Street and house number of the address of the user.

taxnumber String Tax number of the user.

tel String Telephone number of the user.

title String Title of the user.

zipcode String The ZIP code of the user.

6.49.1 Used By

getUserdata

addUser

changeUserdata


118 /


6.49.2 Example

<user>


<fax>1234567890</fax>




<login>

<password>passwordsd</password>


</login>


<sex>M</sex>



<tel>1234567890</tel>

<title>Dr.</title>


</user>

6.49.3 Remarks

6.49.3.1 Unique identification

The username has to be unique – if it has already been taken the response will contain a fault code.

The combination of lastname, firstname, location, zipcode, street and nation on addUser requests made by the same client has to be unique, otherwise the response will contain a fault code.


119 /


OriginalImage


base64image String A String making up the base64image.

mimetype String The mime type of the image.

6.50.1 Used By

getOriginalImage


<S:Body>

<ns2:getOriginalImageResponse xmlns:ns2="http://ws.eurotours.at/">

<return>

<base64image>BASE64ENCODEDIAMGE</base64image>

<mimetype>image/jpeg</mimetype>

</return>

</ns2:getOriginalImageResponse>

</S:Body>

</S:Envelope>

Booking


additionalservices AdditionalService

Element List

If there are additional services associated with the booking that are available to be booked, this list will contain them.

bookingpricedetails BookingPriceDetail

Element List

A list containing a BookingPriceDetail object for every room that has been booked.

bucname String A unique 12-number code.


Element List

A list containing cancellation rules that apply to the booking.

currency String The currency that applies to the price.

optionreleasedate DateTime If the booking is an option, this parameter will hold the release date.

price float The total price of the booking.

priceperperson 6.59 Contains information about the price that is associated with each individual PAX.


120 /


6.51.1 Used By


121 /


bookAccommodation

6.51.2 Example

<return>

<amount>



</amount>



<cancellationDate>2015-03-04T00:00:00+01:00</cancellationDate>

<cancellationRules>




<valid/>

<value>20.0</value>

</cancellationRules> <cancellationRules> <daysAfterBooking>0</daysAfterBooking>





<cancellationRules> <daysAfterBooking>0</daysAfterBooking>





<ci>


<objectcode>EXAMLE HOTEL*5</objectcode>


</ci>



<leadname>test</leadname>

<meal>

<code>FS</code>

</meal>

<rooms>




<passengers>

<age>30</age>



</passengers>

<passengers>

<age>30</age>



</passengers>


</rooms>

</return>


122 /


BookingPriceDetail


description String Description of the booked accommodation in the language that was specified in the request.

nrpax int How many PAXes are

nrunits int Number of booked units.

price float The price of the booking

service String Short description of the booked service.

unitprice float Price per booking unit.

This attribute is no longer supported.

6.52.1 Used By

Booking

6.52.2 Example

<bookingpricedetails>

<description>2 Bett Dusche/WC/Balkon,FS</description>

<nrpax>2</nrpax>

<nrunits>1</nrunits>


<service>Hotel Example Beach,Town 7 Nt.,Example Beach,Town</service>

<unitprice>0.0</unitprice>

</bookingpricedetails>

Category

Contains information about the category of an object (e.g. hotel).


code String The code to identify the category with.

name String The name of the category (star ratings).

6.53.1 Used By

getCategory

6.53.2 Example

<return>

<code>3</code>

<name>***</name>

</return>


123 /


BookingDetail

Contains information about a specific booking.


amount Amount The amount and currency of the price.

arrival DateTime Arrival date at the accommodation.

bucname String The unique booking id.

cancellationDate DateTime If the booking is already cancelled, this attribute will show the date of cancellation.


Element List

The cancellation rules that apply to the booking.

ci ContractIdentification Information to identify the contract for the booking with.

duration int Duration of the stay at the accommodation

lastModification DateTime Date of the time last time that the booking was modified.

leadname String Lead name of the booking (not unique).

meal Meal The board that was booked.

optionrelease DateTime If the booking is only an option and not an actual booking, this attribute will show the date of release.

priceperperson 6.59 Contains Information about the cost associated with each PAX.

rooms Roomx

Element List

Information about the rooms that are associated with the booking.

6.54.1 Used By

getBookingDetails


124 /


6.54.2 Example

<return>

<amount>



</amount>



<cancellationRules>

<cancellationFeeUnit>-1</cancellationFeeUnit>



<durationOfStayFrom>-1</durationOfStayFrom>

<durationOfStayMethod>-1</durationOfStayMethod>

<durationOfStayTo>-1</durationOfStayTo>

<mealType/>

<method>0</method>

<valid/>

<value>40.0</value>


<ci>


<objectcode>OBJECT CODE*4</objectcode>


</ci>



<leadname>100000000</leadname>

<meal>

<code>AI</code>

</meal>

<priceperperson>

<age>30</age>





<roomcode>Z4CWT</roomcode>

</priceperperson>

<rooms>




<passengers>

<age>12</age>



</passengers>

<roomcode>Z4CWT</roomcode>

</rooms>

</return>


125 /


Area

Used to describe areas.


areatype String The type of the area. Either “region” or “nation”.

code String The code to identify the area with.

country String The country the area is situated in (only relevant for areatype “region”).

countrycode String The code of the country the area is situated in (only relevant for areatype “region”).

name String The name of the area in the requests specified language.

6.55.1 Used By

getAreas

getAreaOfLocation

6.55.2 Example

<return>


<code>Lombardei</code>

<country>Italien</country>

<countrycode>I</countrycode>

<name>Lombardei</name>

</return>

Creditcard (deprecated)

This type is no longer supported / deprecated!


company String Company of the credit card.

expirationmonth int Month the card expires.

expirationyear int Year the card expires.

number String Number of the credit card.

owner String Name of the credit card owner.


126 /


Season


code String A short to code to identify the season with.

description String A description of the season (in german).

valid DateRange The period the season is valid for.

6.57.1 Used By

getSeasons

6.57.2 Example

<return>

<code>2016</code>


<valid>

<from>2015-11-01T00:00:00+01:00</from>

<thru>2016-11-01T00:00:00+01:00</thru>

</valid>

</return>

Language


code String A 1 or 2 letter code to identify the language with.

name String The full name of the language in its own language.

6.58.1 Used by

Most request that have a return value.

6.58.2 Example

<return>

<code>i</code>

<name>italiano</name>

</return>


127 /


PricePerPax


age int Age of the PAX

facilitynumber int The sequence number of the room. Can be used to correlate the PAX with the room.

firstname String First name of the PAX

lastname String Last name of the PAX

price Decimal Price for the requested PAX in the room.

roomcode String Code of the type of room

6.59.1 Used by


128 /


bookAccommodation 6.54

6.59.2 Example

<priceperperson>

<age>42</age>


<firstname>Max</firstname>

<lastname>Muster</lastname>


<roomcode>E1DW</roomcode>

</priceperperson>

ageRestrictions


ageRestriction ElementList Has a list of ageRestriction

ageRestriction


maxage int Maximum age allowed in room. If not set then the value is -1 and has no bound

minage int Minimum age allowed in room. Uf bit set then the value is -1 and has no bound

roomcode String if this has a value then the rules apply for that room if no value is set then it applies for any room that does not already have a value

6.61.1 Used by

4.17 getContractRates

6.61.2 Example

<agerestrictions>

<agerestriction>

<maxage>13</maxage>

<minage>5</minage>


129 /


<roomcode>E1CW</roomcode>

</agerestriction>

<agerestriction>

<maxage>5</maxage>

<minage>5</minage>


</agerestriction>

<agerestriction>

<maxage>5</maxage>

<minage>5</minage>

<roomcode>Z3CW_K12</roomcode>

</agerestriction>

<agerestriction>

<maxage>-1</maxage>

<minage>5</minage>

</agerestriction>

</agerestrictions>

passengerType


title String Valid parameter for tile are mr, mrs, herr and frau

firstname String The new firstname of the passenger

lastname String The new lastname of the passenger

id long The ide of the passenger received from the BookingDetails request

6.62.1 Example

<passenger>

<title>mr</title>

<firstname>Anton</firstname>


<id>90000000170051</id>

</passenger>


130 /


roomTypeRules


global4code String Global4 is the code delivered in our EDF exports

globalcode String Is the general getegory of the room. The available values are ftom the list below

Appart AP

Bungalow BU

Cabin CA

Chalet CH

Cottage CT

Duplex DP

Double DR

Economy ER

Familienzimmer FR

Juniorsuite JS

Maisonette MA

Multibed MB

Mobilehome MH

Penthouse PH

Superior SP

Single SR

Studio ST

Suite SU

Triple TR

Ferienwohnung VF

Ferienhaus VH

Villa VI

Waterbungalow WB

Per Descrition XX

maximumadults int The maximum number of adults that can fit in this room

maximumagechilds int The maximum age that a child is considered

maximumchilds int The maximum number of childs that can fit in the room


131 /


maximumoccupancy int The maximum occupancy that this room allows

minimumoccupancy int The minimum occupancy that this room allows

roomdescription String The Description of the room

roomtypecode String The actual room code

6.63.1.1 Example

<room>

<global4code>U14K</global4code>

<globalcode>SU</globalcode>






<roomdescription>5 Bed bath/shower/WC/balcony, Suite</roomdescription>

<roomtypecode>Z5BWT2</roomtypecode>

</room>

SOAP WS DOCU 2.2 · This document is the description of the SOAP web service provided by Eurotours....

Documents

Transcript of SOAP WS DOCU 2.2 · This document is the description of the SOAP web service provided by Eurotours....