XML API, version 1.

2
Release 2018:46
Document version: 2018.09.13

The API contains two different search methods that can be implemented, static
or non-static. We recommend implementing the non-static as this will result in
better performance (lower response times, less data transferred), and it is also
the expected solution for any customer with 250 requests/hour or more (peak
load over 1 hour, not average over 24 hours). Static endpoint can only be used if
previously agreed with WebBeds.
Table of contents

Table of contents ..................................................................................................................................... 2

Introduction .............................................................................................................................................. 3
Global errors ............................................................................................................................................ 4
Searching ................................................................................................................................................. 6
PreBook ................................................................................................................................................. 19
Booking .................................................................................................................................................. 22
Retrieving room type list ........................................................................................................................ 29
Checking price difference for an amendment ........................................................................................ 30
Booking an amendment ......................................................................................................................... 32
Cancelling a booking ............................................................................................................................. 34
Retrieving a list of transfer types ........................................................................................................... 36
Retrieving a list of themes ..................................................................................................................... 37
Retrieving a list of destinations .............................................................................................................. 38
Retrieving a list of resorts ...................................................................................................................... 40
Transfer searching ................................................................................................................................. 42
Retrieving a list of static hotels and rooms ............................................................................................ 45
Retrieving booking information .............................................................................................................. 50
Retrieving transfer booking information ................................................................................................. 52
Booking a transfer ................................................................................................................................. 55
Cancelling a transfer booking ................................................................................................................ 59
Downloading static data ........................................................................................................................ 61
Country, Destination and Resort notes ................................................................................................. 66
Retrieving all supported languages ....................................................................................................... 67
Retrieving all meals ............................................................................................................................... 68
Retrieving all features ............................................................................................................................ 69
Retrieving all hotel note descriptions ..................................................................................................... 70
Retrieving all room note descriptions .................................................................................................... 71
Retrieving booking special request ....................................................................................................... 72
Updating booking special request ......................................................................................................... 73

FIT Ruums XML API version 1.2 2

Introduction
Welcome to FIT Ruums XML API version 1, the solution will be WSDL based, it has a lot of new features,
especially when you look at the search method. Many of our customers will appreciate that all available meals
and meal prices is included directly in the search response. You can also find information about cancellation
rules and airport transfers in the search result. We believe that this will lower the number of round trips
needed to present a good search result to your customers.

Static / Non static search

The hotel search will be available in two versions. One will send static data that isn’t likely to change, and the
other will leave that information out. Examples of static data is hotel name, hotel description and transfer
description. We recommend all customers to use the non-static search if possible. This will lower the amount
of data transferred to you and will increase the response time. Look at the documentation for
“DownloadExport” for more information about how to fetch our static data so you can cache it at your side.
The cache is also useful if you have to map FIT Ruums hotels to the hotels in your system.

SOAP / POST / GET

FIT Ruums XML API will be available using POST /GET or SOAP. SOAP will be the recommended protocol to use
from now on. The functionality will however not differ depending of protocol. We have decided to expose the
POST/GET and the SOAP interfaces on two different pages.
Most of the documentation below will be based on the response from a GET request despite the fact that we
recommend SOAP since it’s easier to understand the XML. It should however not be hard to understand how
the SOAP response will work since it basically uses the same structure.

Correct URL for the web service

There exist four public web services that basically does the same work but is adjusted to if you want to make
POST / GET / SOAP requests or if you want Static / Non static response.

POST / GET SOAP

Show static /1/PostGet/StaticXMLAPI.asmx /1/SOAP/StaticXMLAPI.asmx
data
Do not show /1/PostGet/NonStaticXMLAPI.asmx /1/SOAP/NonStaticXMLAPI.asmx
static data

If you for example want to search hotels and POST data and want to receive non static data you should make
the request to: http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx

Compression
We will compress the data we send as response from version 13 and forward. We will look for the request
header named “Accept-Encoding” and see if it contains gzip or deflate. Make sure your HTTP client doesn’t
send this to us if you don’t wish to receive compressed content from FIT Ruums. Compression will give a bit
CPU overhead but since XML isn’t a very compact format it will give a boost when transferring over internet.

FIT Ruums XML API version 1.2 3

Global errors
Listed below are common errors that may be returned under the “Error” element in the XML output for all
functions.
Error Type Description Resolution
CheckOutDatePrecedesCheckInDateException The provided check-out Change the check-out
date precedes the date to a date later than
provided check-out date. the check-in date.
DateCannotBeInPastException A date has been provided Change the date to a
for a parameter that future date.
does not accept dates in
the past.
InconsistentParameterValuesException The value of a parameter Change the value of one
is inconsistent with the of the parameters
parameter of another. described in the error
For example, the message in accordance
parameter “A” may only with the instructions.
be set if parameter “B” is
set to true.
InvalidCurrencyException The provided currency Refer to the error
code is not valid. message for valid
currency codes.
InvalidParameterFormatException A parameter was not Modify the parameter
provided in the correct value to conform to the
format. The name of the format.
format is included in the
error message.
InvalidParameterValueException An invalid value was Change the value of the
provided for a parameter to one of the
parameter. valid values mentioned
in the error message.
InvalidSortByCriteriaException Invalid sort criteria have Refer to the error
been provided. message for valid sort
criteria.
InvalidSortOrderException An invalid sort direction Change the value of the
has been provided. sort direction to either
“Ascending” or
“Descending”.
InvalidUserNameAndPasswordException The provided user name Make sure that the user
and/or password to the name and password are
function were incorrect. correct.
ListCountDoesNotEqualCountParameterException The number of items in a Change the value of the
list parameter does not count parameter to
equal the value provided match the size of the
in a parameter that provided list.
represents the count of
said items.
ListSizeExceedsMaximumException The number of items in a Reduce the number of
list parameter has items in the list to the
exceeded the maximum allowed number of
allowed number. items.
MaxValueLessThanMinValueException The value of a parameter Change the value of the
representing a maximum maximum value
value is less than the parameter to be greater
value of a parameter than the value of the
representing a minimum

FIT Ruums XML API version 1.2 4

 value. The names and minimum value
values of the parameters parameter, or vice versa.
involved are described in
the error message.
MissingAlternativeParametersException Occurs when no Make sure that one of
parameters in a group of the parameters
alternative parameters mentioned in the error
have been entered into a message has been
function. entered.
MissingRequiredParameterException A required parameter Provide a value for the
was not provided to the required parameter.
function. The name of
the required parameter
is included in the error
message.
ParameterGroupIncompleteException Not all parameters have Provide values for all or
been provided in a group none of the parameters
of parameters that must described in the error
be entered together. message.
ParameterOutOfRangeException The value of a parameter Change the value of the
was out of range. parameter to fall within
the range described in
the message.
ParameterValueGreaterThanMaximumException The value of a parameter Change the value of the
is greater than the parameter to be equal to
allowed maximum value. or less than the
described maximum
value.
ParameterValueLessThanMinimumException The value of a parameter Change the value of the
is less than the allowed parameter to be equal to
minimum value. or greater than the
described minimum
value.
ToDatePrecedesFromDateException The value of a parameter Change the value of the
representing a “to” date “to” date parameter to a
(e.g “checkOutDate” later date than the value
precedes a of the “from” date
corresponding date parameter.
parameter representing
a “from” date (e.g.
“checkInDate”)
TooManyAlternativeParametersException Occurs when too many Make sure that the
parameters in a group of correct number of
alternative parameters parameters (as
have been entered into a mentioned in the error
function. message) has been
entered.

FIT Ruums XML API version 1.2 5

Searching
This function is used to search for available rooms/apartments/villas in the system on a given date.

Non-static searching
Example URL with input for non-static results:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx/Search?userName=[YourUsername]&password
=[YourPassword]&language=en&currencies=EUR&checkInDate=2017-12-02&checkOutDate=2018-05-
04&numberOfRooms=1&destination=&destinationID=695&hotelIDs=&resortIDs=&accommodationTypes=&nu
mberOfAdults=2&numberOfChildren=0&childrenAges=&infant=0&sortBy=&sortOrder=&exactDestinationMatc
h=&blockSuperdeal=&showTransfer=&mealIds=&showCoordinates=&showReviews=&referencePointLatitude=
&referencePointLongitude=&maxDistanceFromReferencePoint=&minStarRating=&maxStarRating=&featureIds
=&minPrice=&maxPrice=&themeIds=&excludeSharedRooms=&excludeSharedFacilities=&prioritizedHotelIds=&
totalRoomsInBatch=&paymentMethodId=&CustomerCountry=gb&b2c=0

Static searching
Example URL with input for static results:
http://search.fitruums.com/1/PostGet/StaticXMLAPI.asmx/Search?userName=[YourUsername]&password=[Yo
urPassword]&language=en&currencies=EUR&checkInDate=2017-12-02&checkOutDate=2018-05-
04&numberOfRooms=1&destination=&destinationID=695&hotelIDs=&resortIDs=&accommodationTypes=&nu
mberOfAdults=2&numberOfChildren=0&childrenAges=&infant=0&sortBy=&sortOrder=&exactDestinationMatc
h=&blockSuperdeal=&showTransfer=&mealIds=&showCoordinates=&showReviews=&referencePointLatitude=
&referencePointLongitude=&maxDistanceFromReferencePoint=&minStarRating=&maxStarRating=&featureIds
=&minPrice=&maxPrice=&themeIds=&excludeSharedRooms=&excludeSharedFacilities=&prioritizedHotelIds=&
totalRoomsInBatch=&paymentMethodId=&CustomerCountry=gb&b2c=0

Function inputs
The search function is to be called with the following parameters.
*: Mandatory input
**: Required alternative (one, and only one, of these parameters must be specified)

Parameter name Description Valid Input Values

*userName The user name of the agent performing the Non-empty strings
search.
*password The password of the agent performing the Non-empty strings
search.
*language The language that the search results will be A valid ISO code
displayed in. from the
“GetLanguages”
function.
*currencies The currencies that the prices in the search String representing
results will be converted to. one or more
currency codes,
e.g. “GBP” or “GBP,
USD”

*checkInDate This value determines the date when the client A date in the
wishes to check into the hotel. Only the rooms format ‘YYYY-MM-
that are available on this date are returned in DD”
the search results. This date must be a future YYYY = Year
date. MM = Month
number
Check-in date is set to DateTime format and DD = Day number
time is set to 00:00:000 as it is referring to
day, not time.
earliestNonFreeCancellationDate tag is set
only in Book response, but can be
calculated with the hotel time zone
(GetStaticHotelsAndRooms) and Check-in
time (local time 12:00 pm on Check-in Date)

FIT Ruums XML API version 1.2 6

 *checkOutDate This value determines the date when the client A date in the
wishes to check out of the hotel. Only the format ‘YYYY-MM-
rooms that are available on this date are DD”, where
returned in the search results. This date cannot YYYY = Year
be earlier than checkInDate and must be a MM = Month
future date. number
DD = Day number
*numberOfRooms The number of rooms that the client is An integer value
interested in. between 1 and the
number of adults
specified in
“numberOfAdults”
**destination The IATA-code for the airport that the client String value
wishes to be available for transfer to or from representing an
the room(s). IATA-code

**destinationID The ID of the destination where the client An integer value

wishes to look for rooms. referring to an
existing
destination.
**hotelIDs The ID(s) of the hotel(s) where the client wishes A string containing
to look for rooms. hotel IDs,
Note: For multiple hotels request, our API can separated by
accept up to 1000 unique Hotel ID if you are commas. Example:
using SOAP “12,34,56”
**resortIDs The ID(s) of the resort(s) where the client A string containing
wishes to look for rooms. resort IDs,
separated by
commas. Example:
“12,34,56”
accommodationTypes The types of accommodation the client wants “Hotel”,
to search for (separated by commas). If this “Apartment”,
parameter is not entered, all types of “Villa”
accommodations will be searched.
*numberOfAdults The total number of adults the client wants the An integer value
rooms to be able to accommodate. between 1 and 9.
*numberOfChildren The total number of children the client wants An integer value
the rooms to be able to accommodate. between 0 and 9

Note: Child is between 2 and 17 years old. 0-1

years old is infant, above 17 years is adult.
*childrenAges Ages of the children informed in A string containing
numberOfChildren field. Allows values between children ages,
2 and 17 between 2 and 17,
separated by
commas. Example:
“7,12”
*infant This value determines if infants (Children 0-1 An integer value, 0
year old) are included in search. Note: MAX or 1.
VALUE is 1 infant per searched/booked unit.
sortBy This value determines which property the “Hotel”, “Resort”,
search results should be sorted after. If this “Price” or
value is not specified, the results will be sorted “Classification”
by hotel names by default.

FIT Ruums XML API version 1.2 7

 sortOrder This value determines the sorting order of the “Ascending” or
search results. If this value is not specified, the “Descending”
results will be sorted in ascending order by
default.
exactDestinationMatch When this value is set to “true” or “1” and the “true”/“1” or
destination code is set, the search results will “false”/“0”.
only contain rooms where the destination code
is the primary destination code.
blockSuperdeal When this value is set to “true” or “1”, all “true”/“1” or
rooms that are SUPERDEAL will be excluded “false”/”0”
from the search.
mealIds The IDs of the meals that should be available on A string containing
all rooms (separated by commas). meal IDs,
separated by
Note: To retrieve the IDs to use for this commas. Example:
parameter, use the new “GetMeals” function. “1,3,4,5,6”
showCoordinates When this value is set to “true” or “1” and the “true”/”1” to
agent is allowed to view the coordinates (in include
latitude and longitude) for a hotel, the coordinates.
coordinates are included in the search results.

Note: The coordinates will only be included

when performing a static search.
showReviews Determines whether average review values “true”/”1” to
(rating, price value) should be displayed for display review
reach found hotel (where reviews have been values.
made).
referencePointLatitude The latitude of the geographical point to use in A decimal value
order to only display hotels whose distance (in >= -90 and
kilometers) from the geographical point are less <= 90
than the value specified in the
maxDistanceFromReferencePoint (see below).

Note: If provided, the referencePointLongitude

and maxDistanceFromReferencePoint
parameters must also be provided.
referencePointLongitude The longitude of the geographical point to use A decimal value
in order to only display hotels whose distance >= -180 and
(in kilometers) from the geographical point are <= 180
less than the value specified in the
maxDistanceFromReferencePoint (see below).

Note: If provided, the referencePointLatitude

and maxDistanceFromReferencePoint
parameters must also be provided.
maxDistanceFromReferencePoint The maximum distance (in kilometers) that all A decimal value >=
hotels should be located from the 0
referencepoint (whose latitude is provided in
referencePointLatitude and longitude is
provided in referencePointLongitude)

Note: If provided, the referencePointLatitude

and referencePointLongitude parameters must
also be provided.

FIT Ruums XML API version 1.2 8

 minStarRating The minimum star rating that all hotels should An integer value >=
have. Cannot be greater than the value 1 and <= 5
provided in maxStarRating.
maxStarRating The maximum star rating that all hotels should An integer value >=
have. Cannot be lesser than the value provided 1 and <= 5
in minStarRating.
featureIds The IDs of the features that the hotels and A string containing
rooms should have. feature IDs,
separated by
Note: To retrieve the IDs to use for this commas. Example:
parameter, use the new “GetFeatures” “1,2,10”
function.
minPrice The minimum total price (in the currency A decimal value >=
specified in the currency parameter) that the 0
rooms may cost.
maxPrice The maximum total price (in the currency A decimal value >=
specified in the currency parameter) that the 0
rooms may cost.
themeIds The IDs of the themes that the hotels must A string containing
have. the theme IDs,
separated by
Note: To get available theme IDs, use the commas, e.g. “1,2”
“GetThemes” function.
excludeSharedRooms Whether or not to exclude shared rooms. “true”/“1” or
Note: When a room is shared the minimum age “false”/“0”.
to book this room is 18.
excludeSharedFacilities Whether or not to exclude shared facilities. “true”/“1” or
Note: When facilities are shared the minimum “false”/“0”.
age to book this room is 18.
prioritizedHotelIds The ID of a hotel that should be prioritized in A string containing
the search results. the ID of the hotel
to prioritize.
totalRoomsInBatch A value representing total number of rooms An integer value
requested by your client. between 1 and 9.
Use this when 2 or more searches are made
separately for same client.
paymentMethodId The payment method id the result must have. An integer of either
1 or 2, where 1 =
“Regular” and 2 =
“Pay At Hotel”.
NULL will return
both "Regular" and
"Pay At Hotel".
customerCountry A 2 letter country code representing the A valid country
nationality of the client. code from
“GetDestinations”
function or
“downloadexport”
xmltype = places.
*b2c Whether or not the client derives from a “true”/“1” or
B2C/non-package point of sales. “false”/“0”.

FIT Ruums XML API version 1.2 9

Function output
Depending on the web service that is used, the search function that is called will yield different outputs.

“NonStaticXMLAPI” web service

This is the web service that is used for only retrieving non-static information about hotels, etc. and ignoring
static information such as the hotel name, address, etc.
Specification of output of search method can be found at:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx?op=Search

XML output
<?xml version="1.0" encoding="utf-8"?>
<searchresult>
<!--All retrieved hotels-->
<hotels>
<hotel isPrioritized="false">
<!--The unique ID of the hotel-->
<hotel.id></hotel.id>
<!--The ID of the destination where the hotel is located-->
<destination_id></destination_id>
<!--The ID of the resort where the hotel is located-->
<resort_id></resort_id>
<!--Integer value indicating whether it is at all possible to
add transfer to the hotel. NOTE! Availability of transfers to
the hotel is depending on date and time for arrival and departure.
To verify transfers available a TransferSearch has to be performed.
1 = adding transfer possible, 0 = adding transfer not possible-->
<transfer></transfer>
<!--All room types that are available for the hotel.-->
<roomtypes>
<roomtype>
<!--The ID of the room type.-->
<roomtype.ID></roomtype.ID>
<!--All rooms for the room type that belong
to the hotel and match the search criteria-->
<rooms>
<room>
<!--The ID of the room-->
<id></id>
<!--The number of adult that the room can accommodate-->
<beds></beds>
<!--The number of child that the room can accommodate, extra beds are not guaranteed-->
<extrabeds></extrabeds>
<!--Meals that are available for the current room-->
<meals>
<meal>
<!--The ID of the meal.-->
<id></id>
<!--The ID of the meal label for this hotel.-->
<labelId></labelId>
<!--The combined prices for the room and the meal,
in all searched currencies-->
<prices>
<!--currency: The currency code that the price applies to
paymentMethods: The IDs of the payment methods that the
price applies to
(separated by whitespaces) -->

FIT Ruums XML API version 1.2 10

 <price currency="" paymentMethods="">
<!--The amount is stored as content of the
"price" element -->
</price>
</prices>
<!--The discount that has been deducted from the price.-->
<discount>
<!--The ID of the discount type-->
<typeId></typeId>
<!--The discount amounts, in all searched currencies-->
<amounts>
<!--currency: The currency code that the discount
amount applies to
paymentMethods: The IDs of the payment methods that
the discount amount applies to
(separated by a single whitespace) -->
<amount currency="" paymentMethods="">
<!--The discount amount is stored as
content of the "amount" element -->
</amount>
</amounts>
</discount>
</meal>
</meals>
<!--The cancellation policies for the current
room during the specified stay-->
<cancellation_policies>
<cancellation_policy>
<!--The deadline for the cancellation policy, i.e. the
number of hours before the check-in date after which
you will be charged with a certain penalty when
cancelling the booking. Empty deadline means that the
policy is effective at the time of the booking.
Example: empty deadline and percentage 100 = Non-refundable.-->
<deadline></deadline>
<!--The percentage of the total booking price that will be charged when the
deadline of this policy is reached.-->
<percentage></percentage>
</cancellation_policy>
</cancellation_policies>
<!--Special notes regarding this room at a specific time.
NOTE: Important to inform client through booking process.-->
<notes>
<!--start_date: The start date of the note,
end_date: The end date of the note-->
<note start_date="" end_date="">
<!--The text content of the note-->
<text></text>
</note>
</notes>
<!--Determines whether the room is a "Super Deal" room-->
<isSuperDeal></isSuperDeal>
<!--Determines whether the room is a "Best Buy" room-->
<isBestBuy></isBestBuy>
<!--The available payment methods for the room-->
<paymentMethods>

FIT Ruums XML API version 1.2 11

 <!--id: The ID of the payment method. 1: Regular, 2: Pay at hotel -->
<paymentMethod xsi:type="StaticPaymentMethod" id="1" name="Invoice" />
<!--Depending on the payment method,
different properties may appear here.-->
<property key="" value=""/>
<property key="" value=""/>
</paymentMethod>
</paymentMethods>
</room>
</rooms>
</roomtype>
</roomtypes>
<!--Contains review information for this hotel-->
<review>
<!--Average rating (1 - 7)-->
<rating></rating>
<!--Average price value (1 - 7)-->
<pricevalue></pricevalue>
<!--Number of reviews-->
<count></count>
<!--Number of recommendations-->
<recommendCount></recommendCount>
</review>
<notes />
<!--The distance between the hotel and the reference point-->
<distance></distance>
<codes>
<!-- Codes.-->
<code type="" value=""></code>
</codes>
</hotel>
</hotels>
<!--This element only appears when an error has occurred.-->
<Error>
<!--The type of error (exception).-->
<ErrorType></ErrorType>
<!--A description of the error.-->
<Message></Message>
</Error>
</searchresult>

FIT Ruums XML API version 1.2 12

“StaticXMLAPI” web service
This is the web service that is used for including static information such as the hotel name, address, etc. in
addition to the non-static information in the search results.
Specification of output of search method can be found at:
http://search.fitruums.com/1/PostGet/StaticXMLAPI.asmx?op=Search

XML output

<?xml version="1.0" encoding="utf-8"?>

<searchresult>
<hotels>
<hotel xsi:type="StaticHotel" isPrioritized="false">
<!--The unique ID of the hotel-->
<hotel.id></hotel.id>
<!--The ID of the destination where the hotel is located-->
<destination_id></destination_id>
<!--The ID of the resort where the hotel is located-->
<resort_id></resort_id>
<!--Integer value indicating whether it is at all possible to
add transfer to the hotel. NOTE! Availability of transfers to
the hotel is depending on date and time for arrival and departure.
To verify transfers available a TransferSearch has to be performed.
1 = adding transfer possible, 0 = adding transfer not possible-->
<transfer></transfer>
<!--All room types that are available for the hotel.-->
<roomtypes>
<roomtype xsi:type="StaticRoomTypeWithRooms">
<!--The ID of the room type.-->
<roomtype.ID></roomtype.ID>
<!--All rooms for the room type that belong
to the hotel and match the search criteria-->
<rooms>
<room xsi:type="StaticRoom">
<!--The ID of the room-->
<id></id>
<!--The number of adult that the room can accommodate-->
<beds></beds>
<!--The number of child that the room can accommodate, extra beds are not guaranteed-->
<extrabeds></extrabeds>
<!--Meals that are available for the current room-->
<meals>
<meal xsi:type="StaticRoomMeal">
<!--The ID of the meal.-->
<id></id>
<!--The ID of the meal label for this hotel.-->
<labelId></labelId>
<!--The combined prices for the room and the meal,
in all searched currencies-->
<prices>
<!--currency: The currency code that the price applies to
paymentMethods: The IDs of the payment methods that the
price applies to
(separated by a whitespace) -->
<price currency="" paymentMethods="">
<!--The amount is stored as content of the

FIT Ruums XML API version 1.2 13

 "price" element -->
</price>
</prices>
<!--The discount that is included in the price.-->
<discount>
<!--The ID of the discount type-->
<typeId></typeId>
<!--The discount amounts, in all searched currencies-->
<amounts>
<!--currency: The currency code that the discount
amount applies to
paymentMethods: The IDs of the payment methods that
the discount amount applies to
(separated by a single whitespace) -->
<amount currency="" paymentMethods="">
<!--The discount amount is stored as
content of the "amount" element -->
</amount>
</amounts>
</discount>
<!--The name of the meal (translated to the language specified
for the search-->
<name></name>
<!--The text for the meal label (translated to the language
specified for the search-->
<labelText></labelText>
</meal>
</meals>
<!--The cancellation policies for the current
room during the specified stay-->
<cancellation_policies>
<cancellation_policy>
<!--The deadline for the cancellation policy, i.e. the number of hours before the check-in date after
Which you will be charged with a certain penalty when cancelling the booking. Empty deadline
means that the policy is effective at the time of the booking.
Example: empty deadline and percentage 100 = Non-Refundable.-->
<deadline></deadline>
<!--The percentage of the total booking price that will be charged when the
deadline of this policy is reached.-->
<percentage></percentage>
<!--An auto-generated summary of the details
of the cancellation policy-->
<text></text>
</cancellation_policy>
</cancellation_policies>
<!--Special notes regarding this room at a specific time.
NOTE: Important to inform client through booking process.-->
<notes>
<!--start_date: The start date of the note,
end_date: The end date of the note-->
<note start_date="" end_date="">
<!--The text content of the note-->
<text></text>
</note>
</notes>

FIT Ruums XML API version 1.2 14

 <!--Whether the room is a "Super Deal" room-->
<isSuperDeal></isSuperDeal>
<!--Whether the room is a "Best Buy" room-->
<isBestBuy></isBestBuy>
<!--The available payment methods for the room-->
<paymentMethods>
<!--id: The ID of the payment method. 1: Regular, 2: Pay at hotel
name: The translated name of the payment method. -->
<paymentMethod xsi:type="StaticPaymentMethod" id="" name="">
<!--Depending on the payment method,
different properties may appear here.-->
<property key="" value=""/>
<property key="" value=""/>
</paymentMethod>
</paymentMethods>
<!--The features of the room-->
<features>
<!--id: The id of the feature, name: The name of the feature-->
<feature id="" name="" />
</features>
<!--The themes of the room-->
<themes>
<!--id: The id of the theme, name: The name of the theme, image:
The image associated with the theme-->
<theme id="" name="" image="" />
</themes>
</room>
</rooms>
<!--The name of the room type (translated to the language specified for the current search)-->
<room.type></room.type>
<!--Whether rooms are shared for this room type, if true minimum age is 18 years.-->
<sharedRoom></sharedRoom>
<!--Whether facilities are shared for this room type, if true minimum age is 18 years.-->
<sharedFacilities></sharedFacilities>
</roomtype>
</roomtypes>
<!--Contains review information for this hotel-->
<review>
<!--Average rating (1 – 7)-->
<rating></rating>
<!--Average price value (1 – 7)-->
<pricevalue></pricevalue>
<!--Number of reviews-->
<count></count>
<!--Number of recommendations for the hotel-->
<recommendCount></recommendCount>
</review>
<!--Special notes regarding this hotel at a specific time-->
<notes>
<!--start_date: The start date of the note,
end_date: The end date of the note-->
<note start_date="" end_date="">
<!--The text content of the note-->
<text></text>
</note>
</notes>

FIT Ruums XML API version 1.2 15

 <!--Type of accommodation, e.g. "Hotel", "Apartment" or "Villa"-->
<type></type>
<!--The name of the accommodation-->
<name></name>
<!--First address line of the accommodation-->
<hotel.addr.1></hotel.addr.1>
<!--Second address line of the accommodation-->
<hotel.addr.2></hotel.addr.2>
<!--Zip code of the accommodation-->
<hotel.addr.zip></hotel.addr.zip>
<!--The city where the accommodation is located-->
<hotel.addr.city></hotel.addr.city>
<!--The state where the accommodation is located-->
<hotel.addr.state></hotel.addr.state>
<!--The country where the accommodation is located-->
<hotel.addr.country></hotel.addr.country>
<!--The country code of the country where the accommodation is located-->
<hotel.addr.countrycode></hotel.addr.countrycode>
<!--The complete address of the accommodation-->
<hotel.address></hotel.address>
<!--The URL to a map view of the accommodation-->
<hotel.mapurl></hotel.mapurl>
<!--The accomodation headline-->
<headline></headline>
<!--The description of the accommodation-->
<description></description>
<!--The name of the resort where the accommodation is located-->
<resort></resort>
<!--The name of the destination where the accommodation is located.-->
<destination></destination>
<!--The themes of the accommodation-->
<themes>
<!--id: The id of the theme, name: The name of the theme, image: The image associated with the theme-->
<theme id="" name="" image="" />
</themes>
<!--All images for the accommodation-->
<images>
<!--The id of the image-->
<image id="">
<!--The full-size version of the image
url: The url to the image
(needs to be prepended with "https://hotelimages.sunhotels.net/HotelInfo/hotelImage.aspx?id=10473272&full=1")
height: The height of the image (in pixels)
width: The width of the image (in pixels)-->
<fullSizeImage url="" height="" width="" />
<!--The small version of the image
url: The url to the image
(needs to be prepended with "https://hotelimages.sunhotels.net/HotelInfo/hotelImage.aspx?id=10473272")
height: The height of the image (in pixels)
width: The width of the image (in pixels)-->
<smallImage url="" height="" width="" />
</image>
</images>
<!--The features of the accomodation-->

FIT Ruums XML API version 1.2 16

 <features>
<!--id: The id of the feature, name: The name of the feature-->
<feature id="" name="" />
</features>
<!--The accommodation classification,
e.g. a digit between 1 and 5 plus an optional character, e.g. "+"-->
<classification></classification>
<!--The coordinates for the hotel (if the "showCoordinates" parameter has been
set to "true"/"1" and the agent is allowed to view coordinates).-->
<coordinates>
<!--The latitude coordinate for the hotel.-->
<latitude></latitude>
<!--The longitude coordinate for the hotel.-->
<longitude></longitude>
</coordinates>
<!--A list of distance types linked to the hotel,
i.e. distances to various beaches, airports, etc.-->
<distanceTypes>
<distanceType>
<!--The ID of the distance type-->
<hotelDistanceTypeId></hotelDistanceTypeId>
<!--The description of the type of place the child distances refer to-->
<description></description>
<distances>
<distance>
<!--The distance (in meters)-->
<distanceInMeters></distanceInMeters>
<!--The name of a place-->
<placeName></placeName>
<!--Coordinates for the described place-->
<coordinates>
<!--The latitude coordinate-->
<latitude></latitude>
<!--The longitude coordinate-->
<longitude></longitude>
</coordinates>
</distance>
</distances>
</distanceType>
</distanceTypes>
<!--The time zone where the hotel is located-->
<timeZone></timeZone>
<!--Whether hotel is "Best Buy" or not.-->
<isBestBuy></isBestBuy>
<!--The distance between the hotel and the reference point-->
<distance></distance>
<codes>
<!-- Codes.-->
<code type="" value=""></code>
</codes>
</hotel>
</hotels>
<!--This element only appears when an error has occurred.-->
<Error>
<!--The type of error (exception).-->
<ErrorType></ErrorType>

FIT Ruums XML API version 1.2 17

 <!--A description of the error.-->
<Message></Message>
</Error>
</searchresult>

Errors
Listed below are common errors that may appear under the “Error” element.
Should any errors occur that are not listed here, contact WebBeds.
Error Type Description Resolution
InvalidEmailAddressException The provided e-mail Provide a valid e-mail address
address was not valid. in the format “x@y.z”

Terminology
Listed below are common concepts that appear in the search and searchV2.
Concept Description
SuperDeal A room that is always non-
Refundable and non-Amendable.

If a grace period is agreed this

applies to these rooms unless
booking is made less than 48 hours
before arrival.
BestBuy Informative tag about a room being
a Best Buy.

FIT Ruums XML API version 1.2 18

PreBook
This method is to be used as step 2 in the context of a 3 step booking process, after the search and before the
booking request. The purpose of the PreBook call is to validate the price, availability and cancellation policy
retrieved in search. This will allow the customer to be prompted to reconfirm a new price and cancellation
policy prior to completing the booking.

The PreBook response will additionally return Notes (Erratas, renovations, city taxes etc) important to share
with the customer prior to proceeding with the final Book request.

Important
• This function must only be used prior to a booking request and must be used ONCE per booking.
• The PreBook code given at the response is valid for 30 minutes.

Example URL with input:

http://book.fitruums.com/1/PostGet/Booking.asmx/PreBook?userName=[YourUsername]&password=[YourPas
sword]&currency=EUR&language=en&checkInDate=2018-05-04&checkOutDate=2018-05-
05&roomId=33513&rooms=1&adults=1&children=1&childrenAges=5&infant=0&mealId=3&CustomerCountry=
gb&b2c=0&searchPrice=100

Function inputs
*: Mandatory input
**: Required only when children value is greater than 0

Parameter name Description Valid Input Values

*username The user name of the agent that is calling Non-empty strings
the function.
*password The password of the agent that is calling the Non-empty strings
function.
*currency The currency used for the booking price. String
representing a
currency code, e.g.
“GBP”.
*language This string will determine the language that A valid ISO code
the booking result will be displayed in. from the
“GetLanguages”
function.
*checkInDate The date for the check-in. A date in the
format ‘YYYY-MM-
Check-in date is set to DateTime format and DD”
time is set to 00:00:000 as it is referring to
day, not time. YYYY = Year
earliestNonFreeCancellationDate tag is set MM = Month
only in Book response, but can be number
calculated with the hotel time zone DD = Day number
(GetStaticHotelsAndRooms) and Check-in
time (local time 12:00 pm on Check-in Date)
*checkOutDate The date for the check-out. A date in the
format ‘YYYY-MM-
DD”, where
YYYY = Year
MM = Month
number
DD = Day number
*roomId The ID of the room to be booked. Integer
representing a
room ID

FIT Ruums XML API version 1.2 19

 *rooms The total number of rooms to be booked. An integer value
between 1 and the
number of adult
guests.
*adults The total number of adult guests. An integer value >
0
*children The total number of child guests. An integer value
>= 0
**childrenAges Ages of the children informed in A string containing
numberOfChildren field. Allows values children ages,
between 2 and 17 between 2 and 17,
separated by
commas. Example:
“7,12”
*infant This value determines if infants (Children 0-1 An integer value, 0
year old) are included in booking. Note: MAX or 1
VALUE is 1 infant per searched/booked unit.
*mealId The ID of the meal that is to be booked. A valid meal ID
(can be fetched
using the
“GetMeals”
function)
customerCountry A 2 letter country code representing the A valid country
nationality of the client. The same code from
parameter as used in search are required. “GetDestinations”
function or
“downloadexport”
xmltype = places.
*b2c Whether or not the client derives from a “true”/“1” or
B2C/non-package point of sales. The same “false”/“0”.
parameter as used in search are required.
searchPrice The price that was received in Search Price, optional
response for the selected roomId and mealId

Function outputs
Specification of output of function can be found at:
http://book.fitruums.com/1/PostGet/Booking.asmx?op=PreBook

XML output
<?xml version="1.0" encoding="utf-8" ?>
<PreBookResult>
<!-- -->
<Notes>
<!—List of errata, resort fee, city tax - important to display to client -->
<Note end_date="" start_date="" >
<Text></Text>
</Note>
<!—Operation code, to be used in Book request-->
<PreBookCode></PreBookCode>
<!—Definite price of the booking-->
<Price currency=""></Price>
<!--All cancellation policies that apply for this booking. →
<!--Please keep in mind that default check-in time is considered 12:00hrs on check-in date at hotel local time.
Time difference calculations can be done utilizing hotel local time in “GetStaticHotelsAndRooms” method-->
<CancellationPolicies>

FIT Ruums XML API version 1.2 20

 <CancellationPolicy>
<!--The deadline for the cancellation policy, i.e. the
number of hours before the check-in date after which
you will be charged with a certain penalty when
cancelling the booking. Empty deadline means that the
policy is effective at the time of the booking.
Example: empty deadline and percentage 100 = Non-Refundable. -->
<deadline></deadline>
<!--The percentage of the total booking price that will be charged when the
deadline of this policy is reached.-->
<percentage></percentage>
<!--An auto-generated summary of the details of the cancellation policy-->
<text></text>
</CancellationPolicy>
</CancellationPolicies>
<!--This element only appears when an error has occurred.-->
<Error>
<!--The type of error (the exception type).-->
<ErrorType></ErrorType>
<!--A description of the error.-->
<Message></Message>
</Error>
</PreBookResult>

FIT Ruums XML API version 1.2 21

Booking
This function is used to book a room/apartment/villa. Take in account that you can only use latin alphabet
characters in the guests names (adult and children), <yourRef>, <invoiceRef> and <specialrequest> tags.

Example URL with input:

http://book.fitruums.com/1/PostGet/Booking.asmx/Book?userName=[YourUsername]&password=[YourPassw
ord]&currency=EUR&language=en&email=noreply@fitruums.com&checkInDate=2017-11-
23&checkOutDate=2017-11-
25&roomId=33513&rooms=1&adults=1&children=1&infant=0&yourRef=Test%20booking&specialrequest=&m
ealId=1&adultGuest1FirstName=Test&adultGuest1LastName=Adult&adultGuest2FirstName=&adultGuest2Last
Name=&adultGuest3FirstName=&adultGuest3LastName=&adultGuest4FirstName=&adultGuest4LastName=&a
dultGuest5FirstName=&adultGuest5LastName=&adultGuest6FirstName=&adultGuest6LastName=&adultGuest
7FirstName=&adultGuest7LastName=&adultGuest8FirstName=&adultGuest8LastName=&adultGuest9FirstNam
e=&adultGuest9LastName=&childrenGuest1FirstName=Test&childrenGuest1LastName=Child&childrenGuestAg
e1=8&childrenGuest2FirstName=&childrenGuest2LastName=&childrenGuestAge2=&childrenGuest3FirstName
=&childrenGuest3LastName=&childrenGuestAge3=&childrenGuest4FirstName=&childrenGuest4LastName=&c
hildrenGuestAge4=&childrenGuest5FirstName=&childrenGuest5LastName=&childrenGuestAge5=&childrenGue
st6FirstName=&childrenGuest6LastName=&childrenGuestAge6=&childrenGuest7FirstName=&childrenGuest7L
astName=&childrenGuestAge7=&childrenGuest8FirstName=&childrenGuest8LastName=&childrenGuestAge8=
&childrenGuest9FirstName=&childrenGuest9LastName=&childrenGuestAge9=&paymentMethodId=1&creditCa
rdType=&creditCardNumber=&creditCardHolder=&creditCardCVV2=&creditCardExpYear=&creditCardExpMont
h=&customerEmail=&invoiceRef=&commissionAmountInHotelCurrency=&CustomerCountry=gb&b2c=0&preBo
okCode=18196cc8-1763-457a-aca7-06e210f73ccb

Function inputs
*: Mandatory input
** Required input for adults and children included in booking
*** paymentMethodId=1, this is the only method in use now. Do not require to send credit card details.

Parameter name Description Valid Input Values

*userName The user name of the agent that is calling Non-empty strings
the function.
*password The password of the agent that is calling the Non-empty strings
function.
*currency The currency used for the booking price. String
representing a
currency code, e.g.
“GBP”.
*language This string will determine the language that A valid ISO code
the booking result will be displayed in. from the
“GetLanguages”
function.
*email The e-mail address of the agent. This is String
where the booking confirmation e-mail is representing a
sent. valid e-mail
address.
*checkInDate The date for the check-in. A date in the
format ‘YYYY-MM-
Check-in date is set to DateTime format and DD”
time is set to 00:00:000 as it is referring to
day, not time. YYYY = Year
earliestNonFreeCancellationDate tag is set MM = Month
only in Book response, but can be number
calculated with the hotel time zone DD = Day number
(GetStaticHotelsAndRooms) and Check-in
time (local time 12:00 pm on Check-in Date)

FIT Ruums XML API version 1.2 22

 *checkOutDate The date for the check-out. A date in the
format ‘YYYY-MM-
DD”, where
YYYY = Year
MM = Month
number
DD = Day number
*roomId The ID of the room to be booked. Integer
representing a
room ID
*rooms The number of rooms to be booked. An integer value
between 1 and the
number of adult
guests.
*adults The number of adult guests. An integer value >
0
*children The number of child guests. An integer value
>= 0
*infant This value determines if infants (Children 0-1 An integer value, 0
year old) are included in booking. Note: MAX or 1
VALUE is 1 infant per searched/booked unit.
All values bigger than 1 is handled as 1.
yourRef A booking number or reference. A string
representing your
reference number.
specialrequest Any special requests for the booking. A string containing
the special
Note: This field is only to be used for special requests.
requests, and should be entered in English.
*mealId The ID of the meal that is to be booked. A valid meal ID
(can be fetched
using the
“GetMeals”
function)
**adultGuest1FirstName The first and last names of the adult Strings
**adultGuest1LastName guest(s). representing first
**adultGuest2FirstName and last names,
**adultGuest2LastName e.g. “John” and
… “Smith”
**adultGuest8FirstName
**adultGuest8LastName
**adultGuest9FirstName
**adultGuest9LastName
**childrenGuest1FirstName The first and last names of the first child Strings
**childrenGuest1LastName guest. representing first
and last names,
e.g. “John” and
“Smith”
**childrenGuestAge1 The age of the first child guest. Integer where x >=
2 and x <= 17
**childrenGuest2FirstName The first and last names of the second child Strings
**childrenGuest2LastName guest. representing first
and last names,
e.g. “John” and
“Smith”

FIT Ruums XML API version 1.2 23

 **childrenGuestAge2 The age of the second child guest. Integer where x >=
2 and x <= 17
…
**childrenGuest8FirstName The first and last names of the eighth child Strings
**childrenGuest8LastName guest. representing first
and last names,
e.g. “John” and
“Smith”
**childrenGuestAge8 The age of the eighth child guest. Integer where x >=
2 and x <= 17
**childrenGuest9FirstName The first and last names of the ninth child Strings
**childrenGuest9LastName guest. representing first
and last names,
e.g. “John” and
“Smith”
**childrenGuestAge9 The age of the ninth child guest. Integer where x >=
2 and x <= 17
paymentMethodId The id of the payment method to be used. An integer of
either 1 or 2,
where 1 =
“Regular” and 2 =
“Pay At Hotel”
***creditCardType The credit card type Either “VISA” or
“MasterCard”
***creditCardNumber The credit card number String
representing a
credit card
number
***creditCardHolder The name of the credit card holder String
representing a
name
***creditCardCVV2 The CCV2 code of the credit card String
representing a
CVV2 code
***creditCardExpYear The expiration year of the credit card Integer
representing a
year
***creditCardExpMonth The expiration month of the credit card Integer where x >=
1 and x <= 12
customerEmail Email address of the customer. String
Non-required field. representing an
email address.
invoiceRef An invoice reference A string
representing your
invoice reference
commissionAmountInHotelCurrency Commission added by client for “pay at String
hotel” bookings. representing a
Non-required field. percentage.
customerCountry A 2 letter country code representing the A valid country
nationality of the client. The same code from
parameter as used in search are required. “GetDestinations”
function or
“downloadexport”
xmltype = places.

FIT Ruums XML API version 1.2 24

 *b2c Whether or not the client derives from a “true”/“1” or
B2C/non-package point of sales. The same “false”/“0”.
parameter as used in search are required.
preBookCode Code retrieved in PreBook response String.
Mandatory if PreBook is used.

Function outputs
Specification of output of function can be found at:
http://book.fitruums.com/1/PostGet/Booking.asmx?op=Book

XML output
<?xml version="1.0" encoding="utf-8" ?>
<bookResult>
<!--Represents the created booking-->
<booking>
<!--The ID of the booking-->
<bookingnumber></bookingnumber>
<!--The ID of the booked hotel-->
<hotel.id></hotel.id>
<!--The name of the booked hotel-->
<hotel.name></hotel.name>
<!--The address of the booked hotel.-->
<hotel.address></hotel.address>
<!--The phone number to the booked hotel.-->
<hotel.phone></hotel.phone>
<!--The number of booked rooms.-->
<numberofrooms></numberofrooms>
<!--The type of room that was booked (translated to the specified language)-->
<room.type></room.type>
<!--The type of room that was booked (in English).-->
<room.englishType></room.englishType>
<!--The id of the meal that was booked-->
<mealId></mealId>
<!--The meal that was booked (translated to the specified language)-->
<meal></meal>
<!--The meal label for booked meal.-->
<mealLabel></mealLabel>
<!--The meal that was booked (in English).-->
<englishMeal></englishMeal>
<!--The meal label for booked meal (in English).-->
<englishMealLabel></englishMealLabel>
<!--The check-in date for the booking-->
<checkindate></checkindate>
<!--The check-out date for the booking-->
<checkoutdate></checkoutdate>
<!--The prices for the booking, which are
expressed in at least the booked currency
as well an in Euros
currency: The currency code that the price
applies to
paymentMethods: The payment methods the price
applies to (always the booked payment method)-->
<prices>

FIT Ruums XML API version 1.2 25

 <price currency="" paymentMethods=""></price>
<price currency="" paymentMethods=""></price>
</prices>
<!--The currency of the booked price-->
<currency></currency>
<!--The date when the booking was made.-->
<bookingdate></bookingdate>
<!--The time zone in which the booking was made.-->
<bookingdate.timezone></bookingdate.timezone>
<!--All cancellation policies that apply for this booking.-->
<cancellationpolicies>
<!--The deadline for the cancellation policy, i.e. the
number of hours before the check-in date after which
you will be charged with a certain penalty when
cancelling the booking. Empty deadline means that the
policy is effective at the time of the booking.
Example: empty deadline and percentage 100 = no refund. -->
<deadline></deadline>
<!--The percentage of the total booking price that will
be charged when the deadline of this policy is reached.-->
<percentage></percentage>
<!--An auto-generated summary of the details of
the cancellation policy-->
<text></text>
</cancellationpolicies>
<!--The earliest date when cancelling the booking will not be free
(in Central European Standard Time)-->
<earliestNonFreeCancellationDate.CET>
</earliestNonFreeCancellationDate.CET>
<!--The earliest date when cancelling the booking will not be free
(in the local time-zone of the destination where the hotel is located)-->
<earliestNonFreeCancellationDate.Local>
</earliestNonFreeCancellationDate.Local>
<!--The reference used when booking-->
<yourref></yourref>
<!--The URL to the voucher associated with the booking.-->
<voucher></voucher>
<!--Emergency contact details and additional important information associated with the booking required to
pass to the client-->
<bookedBy></bookedBy>
<!--An integer indicating whether a transfer has been booked
(1: yes, 0: no, 2: transfer has been cancelled)-->
<transferbooked></transferbooked>
<!--The booked payment method
id: The id of the payment method. 1: Invoice/Pay now, 2: Pay at hotel
name: The translated name of the payment method-->
<paymentMethod id="" name="">
<!--Depending on the payment method,
different properties may appear here.-->
<property key="" value=""/>
<property key="" value=""/>
</paymentMethod>
<!--Special notes regarding the booked hotel
(translated to the specified language).
NOTE: Important to inform client through booking process.-->
<hotelNotes>

FIT Ruums XML API version 1.2 26

 <!--start_date: The start date of the note,
end_date: The end date of the note-->
<hotelNote start_date="" end_date="">
<!--The text content of the note-->
<text></text>
</hotelNote>
</hotelNotes>
<!--Special notes regarding the booked hotel (in English)-->
<englishHotelNotes>
<!--start_date: The start date of the note,
end_date: The end date of the note-->
<englishHotelNote start_date="" end_date="">
<!--The text content of the note-->
<text></text>
</englishHotelNote>
</englishHotelNotes>
<!--Special notes regarding the booked room
(translated to the specified language)-->
<roomNotes>
<!--start_date: The start date of the note,
end_date: The end date of the note-->
<roomNote start_date="" end_date="">
<!--The text content of the note-->
<text></text>
</roomNote>
</roomNotes>
<!--Special notes regarding the booked room (in English)-->
<englishRoomNotes>
<!--start_date: The start date of the note,
end_date: The end date of the note-->
<englishRoomNote start_date="" end_date="">
<!--The text content of the note-->
<text></text>
</englishRoomNote>
</englishRoomNotes>
<!--The invoice reference used when booking-->
<invoiceref></invoiceref>
</booking>
<!--This element only appears when an error has occurred.-->
<Error>
<!--The type of error (the exception type).-->
<ErrorType></ErrorType>
<!--A description of the error.-->
<Message></Message>
</Error>
</bookResult>

Errors
Listed below are common errors that may appear under the “Error” element.
Should any errors occur that are not listed here, contact WebBeds.
Error Type Description Resolution
InvalidEmailAddressException The provided e-mail Provide a valid e-mail address
address was not valid. in the format “x@y.z”

FIT Ruums XML API version 1.2 27

 AgentMustUseCreditCardBookingException The agent performing Change the value of the
the booking has “useCreditCardPayment” to
indicated that he/she “true”.
does not want to use
credit card payment,
but is required to do
so.
AgentMayNotUseCreditCardBookingException The agent performing Change the value of the
the booking has “useCreditCardPayment” to
indicated that he/she “false”.
wants to use credit
card payment, but is
not allowed to.
RoomSuspendedException The room that the Enter the ID of a room that is
agent is trying to book not suspended.
is suspended.
InvalidMealForRoomException The provided meal is Enter the ID of a meal that is
not valid for the room available for the room to
that the agent is book.
trying to book.
CreditCardPaymentException The credit card used Make sure that the correct
to pay for the booking amount is available on the
was denied. credit card, and that it has not
expired.
EmptyLastNameForGuestNotAllowedException The last name for a Change the value of the
guest was empty, parameter mentioned in the
which is not allowed. error message to contain a
non-empty string.
InvalidChildAgeFormatException The age entered for a Modify the provided value so
child guest was either that it is a valid integer
not a valid integer OR between 2 and 17.
outside the allowed
range of 2 to 17 years.
NoRoomAvailabilityException The room that the Try to book another room.
agent is trying to book
is not available.
ChildAgeOutOfRangeException The age entered for a Enter an age between 2 and
child guest is out of 17.
range.
AgentPaymentMethodInvalidException The payment method Enter a valid payment method
specified is not valid id of either 1 or 2.
for this agent.
CreditCardNotValidException The provided credit Observe the error message for
card information is more information about the
not valid. erroneous parameter.
PriceMismatchException Final price did not Final price was changed and
match the price new price is returned
returned in the together with new
PreBook. PreBookCode. After
confirming new price with
client book again using new
PreBookCode.
InvalidPrebookCode Exceeded 30 min. Do not exceed more than
From Prebook to 30 minutes between
Book sections. Sections.

FIT Ruums XML API version 1.2 28

Retrieving room type list
This function is used to retrieve a list of all room types and codes in the specified language.

Example URL with input:

http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx/GetRoomTypes?userName=[YourUsername]&p
assword=[YourPassword]&language=en

Function inputs
*: Required input

Parameter name Description Valid Input Values

*userName The user name of the agent that is calling the function. Non-empty strings
*password The password of the agent that is calling the function. Non-empty strings
*language This string will determine the language that the room types A valid ISO code from
will be displayed in. the “GetLanguages”
function.

Function output
Specification of output of function can be found at:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx?op=GetRoomTypes

XML output
<?xml version="1.0" encoding="utf-8"?>
<getRoomTypesResult>
<!--All room types that were retrieved.-->
<roomTypes>
<roomType>
<!--The unique ID of the room type.-->
<id></id>
<!--The name of the room type in the specified language.-->
<name></name>
<!-- Whether rooms are shared for this room type, if true minimum age is 18 years. -->
<!--0 = Not shared, 1 = Shared -->
<sharedRoom></sharedRoom>
<!-- Whether facilities are shared for this room type, if true minimum age is 18 years. (1: yes, 0: no).-->
<sharedFacilities></sharedFacilities>
</roomType>
</roomTypes>
<!--This element only appears when an error has occurred.-->
<Error>
<!--The type of error (the exception type).-->
<ErrorType></ErrorType>
<!--A description of the error.-->
<Message></Message>
</Error>
</getRoomTypesResult>

FIT Ruums XML API version 1.2 29

Checking price difference for an amendment
This function is used to check if an amendment is possible, check the price difference that the amendment will
cause and indicate what type of amendment that renders the best price.
An amendment will either cancel the existing booking and create a new booking for the new stay (FullPeriod)
or keep the old booking active and book the extra nights in a separate booking (ExtraDays).
Example URL with input:
http://book.fitruums.com/1/PostGet/Booking.asmx/AmendmentPriceRequest?userName=[YourUsername]&pa
ssword=[YourPassword]&bookingID=1454020&checkInDate=2013-01-01&checkOutDate=2013-01-
05&language=en

Function inputs
*: Required input

Parameter name Description Valid Input Values

*username The name of the user that is performing the Non-empty strings
amendment operation.
*password The password of the user that is performing the Non-empty strings
amendment operation.
*bookingID The ID of the booking that is to be amended. String containing numerical
characters
*checkInDate The date for the check-in after amendment. A date in the format ‘YYYY-
MM-DD”
YYYY = Year
MM = Month number
DD = Day number
*checkOutDate The date for the check-out after amendment. A date in the format ‘YYYY-
MM-DD”, where
YYYY = Year
MM = Month number
DD = Day number
*language Determines the language that the response will be A valid ISO code from the
displayed in. “GetLanguages” function.

Function output
Specification of output of function can be found at:
http://book.fitruums.com/1/PostGet/booking.asmx?op=AmendmentPriceRequest

XML output
<?xml version="1.0" encoding="utf-8"?>
<amendmentPriceRequestResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://search.fitruums.com/1/">
<!--The price increase or reduction of the requested amendment.
Will always be in the currency in which the booking was created.-->
<Price currency="EUR"></Price>
<!--The room ID for the booking,
can be different from the original booking room ID.-->
<RoomId></RoomId>
<!--Special hotel notes regarding this hotel at a specific time.
NOTE: Important to inform client through booking process. -->
<hotelnotes>
<!--start_date: The start date of the note,
end_date: The end date of the note-->
<note start_date="" end_date="">
<!--The text content of the note-->
<text></text>
</note>

FIT Ruums XML API version 1.2 30

 </hotelnotes>
<!--Special room notes regarding this hotel at a specific time-->
<roomnotes>
<!--start_date: The start date of the note,
end_date: The end date of the note-->
<note start_date="" end_date="">
<!--The text content of the note-->
<text></text>
</note>
</roomnotes>
<!--The cancellation policies for the current room during the specified stay-->
<cancellation_policies>
<cancellation_policy>
<!--The deadline for the cancellation policy, i.e. the
number of hours before the check-in date after which
you will be charged with a certain penalty when
cancelling the booking. Empty deadline means that the
policy is effective at the time of the booking.
Example: empty deadline and percentage 100 = no refund.-->
<deadline></deadline>
<!--The percentage of the total booking
price that will be charged when the
deadline of this policy is reached.-->
<percentage></percentage>
</cancellation_policy>
</cancellation_policies>
<!--Enumeration of the type of amendment that can be done;
FullPeriod, ExtraDays or NoAmendmentAvailable.-->
<BookingType>FullPeriod</BookingType>
</amendmentPriceRequestResult>

Errors
Listed below are common errors that may appear under the “Error” element.
Should any errors occur that are not listed here, contact WebBeds.
Error Type Description Resolution
AmendmentNotPossibleException The amendment Check input parameters.
requested could not
be performed.

FIT Ruums XML API version 1.2 31

Booking an amendment
This function is used to book an amendment. It is only possible to amend nights to a booking by changing the
check-in and/or check-out dates. Use the AmendmentPriceRequest function to determine the availability and
price before booking the amendment.
An amendment will either cancel the existing booking and create a new booking for the new stay (FullPeriod)
OR keep the old booking active and book the extra nights in a separate booking (ExtraDays).
Example URL with input:
http://book.fitruums.com/1/PostGet/Booking.asmx/AmendmentRequest?userName=[YourUsername]&passw
ord=[YourPassword]&bookingID=1454020&roomId=2998&checkInDate=2013-01-01&checkOutDate=2013-01-
05&maxPrice=100&language=en&BookingType=FullPeriod

Function inputs
*: Required input

Parameter name Description Valid Input Values

*userName The name of the user that is performing the Non-empty strings
amendment operation.
*password The password of the user that is performing the Non-empty strings
amendment operation.
*bookingID The ID of the booking that is to be amended. String containing numerical
characters
*roomId The ID of the amendment booking Integer representing a room ID
*checkInDate The date for the check-in after amendment. A date in the format ‘YYYY-
MM-DD”
YYYY = Year
MM = Month number
DD = Day number
*checkOutDate The date for the check-out after amendment. A date in the format ‘YYYY-
MM-DD”, where
YYYY = Year
MM = Month number
DD = Day number
*maxPrice The maximum price increase allowed for the String containing numerical
amendment. characters
*language Determines the language that the response will be A valid ISO code from the
displayed in. “GetLanguages” function.
*bookingType The type of amendment. Non-empty string
Valid values are: “FullPeriod” and “ExtraDays”

Function output
Specification of output of function can be found at:
http://book.fitruums.com/1/PostGet/Booking.asmx?op=AmendmentRequest

XML output
<?xml version="1.0" encoding="utf-8"?>
<amendmentRequestResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://search.fitruums.com/1/">
<!--Information about the new amendment booking made.
XML structure is identical to that of a single booking when using GetBookingInformation.
The admendment booking will always be active.-->
<AmendmentBooking>
</AmendmentBooking>
<!--Information about the original booking that was amended.
XML structure is identical to that of a single booking when using GetBookingInformation.
The admendment booking will be active when performing an "ExtraDays" amendment
and not active (cancelled) when performing a "FullPeriod" amendment.-->

FIT Ruums XML API version 1.2 32

 <OriginalBooking>
</OriginalBooking>
</amendmentRequestResult>

Errors
Listed below are common errors that may appear under the “Error” element.
Should any errors occur that are not listed here, contact WebBeds.
Error Type Description Resolution
AmendmentNotPossibleException The amendment Check input parameters.
requested could not
be performed.
AmendmentAlreadyExistException An amendment Contact WebBeds to make
allready exists and a requested changes.
new amendment
cannot be performed.
AmendmentBookingTypeInvalidException The requested Use AmendmentPriceRequest
amendment type is to determine the amendment
invalid. type to use.
AmendmentTransfersNotAllowedException A transfer is booked Cancel transfer and rebook
on the original after amendment has been
booking. completed.
AmendmentBookingTypeChangedException The requested Use AmendmentPriceRequest
amendment type is to determine the amendment
not correct. type to use.
AmendmentPriceOverMaxException The price of the Use AmendmentPriceRequest
amendment is higher to determine the amendment
than the maximum price.
allowed price
specified.
NonExistentBookingException The booking selected Use a valid booking id.
does not exist.
NoRoomAvailabilityException The amendment Use AmendmentPriceRequest
could not be to determine if amendment is
completed due to possible.
lack of availability.

FIT Ruums XML API version 1.2 33

Cancelling a booking
This function is used to cancel an existing booking.
In case the booking also has a transfer booking attached, the transfer booking will also be cancelled.
Example URL with input:
http://book.fitruums.com/1/PostGet/Booking.asmx/CancelBooking?userName=[YourUsername]&password=[Y
ourPassword]&bookingID=SH1454020&language=en

Function inputs
*: Required input

Parameter name Description Valid Input Values

*userName The name of the user that is performing the Non-empty strings
cancellation operation.
*password The password of the user that is performing the Non-empty strings
cancellation operation.
*bookingID The ID of the booking that is to be cancelled. String containing numerical
characters, optionally
preceded by “SH”
*language Determines the language that the booking A valid ISO code from the
cancellation mail will be displayed in. “GetLanguages” function.

Function output
Specification of output of function can be found at:
http://book.fitruums.com/1/PostGet/Booking.asmx?op=CancelBooking

XML output
<?xml version="1.0" encoding="utf-8"?>
<result>
<!--The status code of the cancellation. 1 is successful, -1
is unsuccessful and -2 is booking can’t be cancelled/booking don’t exists.-->
<Code></Code>
<!-- The payment methods (one for each type).
id: The id of the payment method
name: The name of the payment method -->
<CancellationPaymentMethod id="Id" name="Name">
<!-- The cancellation fees that will be charged when cancelling.
currency: The currency the amount is expressed in. -->
<cancellationfee currency="Currency"></cancellationfee>
<cancellationfee currency="Currency"></cancellationfee>
<!-- The items that are cancelled (one for each type eg. Hotel, Transfer)
type: The type of what is cancelled, eg. Hotel, Transfer. -->
<cancellation type="Type">
<!-- This element only appears when a cancellation policy applies.
The active cancellation policy. -->
<activecancellationpolicy xsi:nil="true"></activecancellationpolicy>
</cancellation>
<cancellation type="Type"></cancellation>
</CancellationPaymentMethod>
<CancellationPaymentMethod id="Id" name="Name"></CancellationPaymentMethod>
<!--This element only appears when an error has occurred.-->
<Error>
<!--The type of error (exception).-->
<ErrorType></ErrorType>
<!--A description of the error.-->
<Message></Message>
</Error>
</result>

FIT Ruums XML API version 1.2 34

Errors
Listed below are common errors that may appear under the “Error” element.
Should any errors occur that are not listed here, contact WebBeds.
Error Type Description Resolution
BookingCancellationDeadlineExpiredException The booking could Not available
not be cancelled due
to the cancellation
deadline having
expired.
NonExistentBookingException The booking to be Use the
cancelled could not “GetBookingInformation” to
be found. find the booking to cancel.
BookingAlreadyCancelledException The booking to be Not available
cancelled has already
been cancelled.

FIT Ruums XML API version 1.2 35

Retrieving a list of transfer types
This function is used to retrieve a list of all transfer types and codes (or a single transfer type) in a specified
language.
Example URL with input:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx/GetTransferTypes?userName=[YourUsername]
&password=[YourPassword]&language=en&transferTypeCode=

Function inputs
*: Required input

Parameter name Description Valid Input Values

*userName The user name of the agent performing the search. Non-empty strings
*password The password of the agent performing the search. Non-empty strings
*language This string will determine the language that the transfer A valid ISO code from
types will be displayed in. the “GetLanguages”
function.
transferTypeCode If specified, only the specified transfer type code will be Integer representing a
shown in the results. transfer type code.

Function outputs
Specification of output of function can be found at:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx?op=GetTransferTypes

XML Output
<?xml version="1.0" encoding="utf-8"?>
<getTransferTypesResult>
<!--All transfer types that were retrieved.-->
<transferTypes>
<transferType>
<!--The ID of the transfer type.-->
<id></id>
<!--The name of the transfer type in the specified language.-->
<name></name>
</transferType>
</transferTypes>
<!--This element only appears when an error has occurred.-->
<Error>
<!--The type of error (the exception type).-->
<ErrorType></ErrorType>
<!--A description of the error.-->
<Message></Message>
</Error>
</getTransferTypesResult>

FIT Ruums XML API version 1.2 36

Retrieving a list of themes
This function is used to retrieve a list of all hotel themes.
Example URL with input:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx/GetThemes?userName=[YourUsername]&pass
word=[YourPassword]

Function inputs
*: Required input

Parameter name Description Valid Input Values

*userName The user name of the agent that is calling the function. Non-empty strings
*password The password of the agent that is calling the function. Non-empty strings

Function output
Specification of output of function can be found at:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx?op=GetThemes

XML Output
<?xml version="1.0" encoding="utf-8"?>
<getThemesResult>
<themes>
<!--id: The ID of the theme
name: The name of the theme,
image: The URL to the image associated with the theme-->
<theme id="1" name="luxury" image="http://www.sunhotels.net/images/luxury.png" />
</themes>
<!--This element only appears when an error has occurred.-->
<Error>
<!--The type of error (the exception type).-->
<ErrorType></ErrorType>
<!--A description of the error.-->
<Message></Message>
</Error>
</getThemesResult>

FIT Ruums XML API version 1.2 37

Retrieving a list of destinations
This function is used to retrieve a list of all destinations or destinations with a specific destination code.

Example URL with input:

http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx/GetDestinations?userName=[YourUsername]&
password=[YourPassword]&language=en&destinationCode=cun&sortBy=Destination&sortOrder=Ascending&e
xactDestinationMatch=0

Function inputs
*: Required input

Parameter name Description Valid Input Values

*userName The user name of the agent that is calling the Non-empty strings
function.
*password The password of the agent that is calling the Non-empty strings
function.
*language The language in which the results will be displayed. A valid ISO code from
the “GetLanguages”
function.
destinationCode The destination code that the returned destinations String representing a
should have. If not specified, all destinations will be destination code, e.g.
displayed. “CUN”.
sortBy Determines the field that the results should be “Country” or
sorted after. If not specified, the results will be “Destination”.
sorted by “Country”.
sortOrder Determines the sorting order of the results. If not “Ascending” or
specified, “Ascending” will be used. “Descending”.
exactDestinationMatch If this parameter is set to “true” or “1”, only “true”/“1” or
destinations where the searched destination code is “false”/“0”
the main destination code will be displayed.

FIT Ruums XML API version 1.2 38

Function output
Specification of output of function can be found at:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx?op=GetDestinations

XML Output
<?xml version="1.0" encoding="utf-8"?>
<DestinationList>
<!--The retrieved destinations-->
<Destinations>
<Destination>
<!--The ID of the destination-->
<destination_id></destination_id>
<!--The main destination code (IATA-code) of the destination-->
<DestinationCode></DestinationCode>
<!--The second IATA-code of the destination.-->
<DestinationCode.2></DestinationCode.2>
<!--The third IATA-code of the destination.-->
<DestinationCode.3></DestinationCode.3>
<!--The fourth IATA-code of the destination.-->
<DestinationCode.4></DestinationCode.4>
<!--The name of the destination.-->
<DestinationName></DestinationName>
<!--The ID of the country where the destination is located.-->
<CountryId></CountryId>
<!--The name of the country where the destination is located-->
<CountryName></CountryName>
<!--The country code for the country where the destination is located-->
<CountryCode></CountryCode>
<!--The time zone for the destination-->
<TimeZone></TimeZone>
</Destination>
</Destinations>
<!--This element only appears when an error has occurred.-->
<Error>
<!--The type of error (the exception type).-->
<ErrorType></ErrorType>
<!--A description of the error.-->
<Message></Message>
</Error>
</DestinationList>

FIT Ruums XML API version 1.2 39

Retrieving a list of resorts
This function is used to retrieve a list of all resorts or resorts with a specific destination code or ID.

Example URL with input:

http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx/GetResorts?userName=[YourUsername]&pass
word=[YourPassword]&language=en&destinationCode=BCN&destinationID=&sortBy=Resort&sortOrder=Ascen
ding&exactDestinationMatch=0

Function inputs
*: Required input

Parameter name Description Valid Input Values

*userName The user name of the agent that is calling the Non-empty strings
function.
*password The password of the agent that is calling the Non-empty strings
function.
*language The language in which the results will be displayed. A valid ISO code from
the “GetLanguages”
function.
destinationCode The destination code that the returned resorts String representing a
should have. If this, along with destinationID, is not destination code, e.g.
specified, all resorts will be displayed. “CUN”.
destinationID The destination ID that the returned resorts should Integer representing a
have. If this, along with destinationCode, is not destination ID
specified, all resorts will be displayed.
sortBy Determines the field that the results should be “Country”,
sorted after. If not specified, the results will be “Destination”,
sorted by “ResortID”. “ResortID”, “Resort”
sortOrder Determines the sorting order of the results. If not “Ascending” or
specified, “Ascending” will be used. “Descending”.
exactDestinationMatch If this parameter is set to “true” or “1”, only resorts “true”/“1” or
where the searched destination code is the main “false”/“0”
destination code will be displayed. If not specified,
all resorts where any of the destination codes are
equal to the searched destination code will be
shown.

FIT Ruums XML API version 1.2 40

Function output
Specification of output of function can be found at:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx?op=GetResorts

XML Output
<?xml version="1.0" encoding="utf-8"?>
<ResortList>
<!--All resorts that were retrieved.-->
<Resorts>
<Resort>
<!--The ID of the resort.-->
<ResortId></ResortId>
<!--The name of the resort, in the specified language.-->
<ResortName></ResortName>
<!--The ID of the destination associated with the resort.-->
<destination_id></destination_id>
<!--The name of the associated destination, in the specified
language.-->
<DestinationName></DestinationName>
<!--The name of the country where the resort is located, in the
specified language.-->
<CountryName></CountryName>
<!--The country code of the country where the resort is located-->
<CountryCode></CountryCode>
</Resort>
</Resorts>
<!--This element only appears when an error has occurred.-->
<Error>
<!--The type of error (the exception type).-->
<ErrorType></ErrorType>
<!--A description of the error.-->
<Message></Message>
</Error>
</ResortList>

FIT Ruums XML API version 1.2 41

Transfer searching
This function is used to retrieve a list of available transfer options for a specific room, hotel, booking or resort.
You may want to retrieve the transfers from the search result instead of using this function.
Example URL with input:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx/SearchTransfers?userName=[YourUsername]&
password=[YourPassword]&language=en&currencies=GBP,EUR&hotelID=2134&roomID=&bookingID=&resortI
D=&transferID=&arrivalDate=&arrivalTime=&returnDepartureDate=&returnDepartureTime=

Function inputs
*: Required input
**: Required alternative (one, and only one, of these parameters must be specified)

Parameter name Description Valid Input Values

*userName The user name of the agent that is calling the Non-empty strings
function.
*password The password of the agent that is calling the Non-empty strings
function.
*language The language in which the results will be displayed. A valid ISO code from
the “GetLanguages”
function.
*currencies The currencies that the rate prices in the search String representing one
results will be converted to. or more currency
codes, e.g. “GBP” or
“GBP, USD”

**hotelID The ID of the hotel. Integer representing a

hotel ID
**roomID The ID of the room. Integer representing a
room ID
**bookingID The ID of the booking. Integer representing a
booking ID
**resortID The ID of the resort. Integer representing a
resort ID
arrivalDate Date of arrival A date in the format
‘YYYY-MM-DD”
YYYY = Year
MM = Month number
DD = Day number
arrivalTime Time of arrival A timestamp in the
format “hh:mm”,
Note: If entered, the “arrivalDate” parameter must where hh = hours and
also be entered. mm = minutes
returnDepartureDate Date of departure A date in the format
‘YYYY-MM-DD”
Note: Must occur at a later date than the date YYYY = Year
specified in the “arrivalDate” parameter (if MM = Month number
“arrivalDate” is specified). DD = Day number
returnDepartureTime Time of departure A timestamp in the
format “hh:mm”,
Note: If entered, the “returnDepartureDate” where hh = hours and
parameter must also be entered. mm = minutes

Function output
Specification of output of function can be found at:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx?op=SearchTransfers

FIT Ruums XML API version 1.2 42

XML Output
<?xml version="1.0" encoding="utf-8"?>
<searchTransfersResult>
<!--All airports that are available for transfers for the given hotel, room or booking.-->
<airports>
<airport>
<!--The ID of the airport-->
<airportId></airportId>
<!--The ID of the resort associated with the airport.-->
<resortId></resortId>
<!--The name of the airport-->
<airportName></airportName>
<!--The IATA code of the airport.-->
<iataCode></iataCode>
<!--The time zone of the destination where the airport is located.-->
<timeZone></timeZone>
<!--All available transfers for the airport.-->
<transfers>
<transfer>
<!--The rates for the transfer-->
<rates>
<rate>
<!--Whether the rate applies to an arrival transfer
or a return transfer-->
<direction>Arrival or Return</direction>
<!--The hour of day when the rate becomes active-->
<startHour></startHour>
<!--The hour of day when the rate is no longer active-->
<endHour></endHour>
<!--The rate prices (in the specified currencies) -->
<prices>
<!--currency: The currency code that the rate price applies to-->
<price currency="">
<!--The amount is stored as content of the
"price" element-->
</price>
</prices>
</rate>
</rates>
<!--The ID of the transfer.-->
<transferId></transferId>
<!--The ID of the transfer type.-->
<transferTypeId></transferTypeId>
<!--The minimum amount of passengers allowed for the transfer.-->
<minimumPassengers></minimumPassengers>
<!--The maximum amount of passengers allowed for the transfer.-->
<maximumPassengers></maximumPassengers>
<!--The estimated time for the transfer, in hours.-->
<estimatedTimeInHours></estimatedTimeInHours>
<!--The estimated time for the transfer, in minutes.-->
<estimatedTimeInMinutes></estimatedTimeInMinutes>
<!--The name of the transfer type.-->
<transferTypeName></transferTypeName>
</transfer>
</transfers>
</airport>
</airports>
<!--This element only appears when an error has occurred.-->
<Error>

FIT Ruums XML API version 1.2 43

 <!--The type of error (the exception type).-->
<ErrorType></ErrorType>
<!--A description of the error.-->
<Message></Message>
</Error>
</searchTransfersResult>

FIT Ruums XML API version 1.2 44

Retrieving a list of static hotels and rooms
This function is used to retrieve detailed information about a specific hotel or all hotels on a specific
destination or resort.
Example URL with input:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx/GetStaticHotelsAndRooms?userName=[YourUs
ername]&password=[YourPassword]&language=en&destination=&hotelIDs=6928&resortIDs=&accommodation
Types=&sortBy=&sortOrder=&exactDestinationMatch=

Function inputs
*: Required input
**: Required alternative (one, and only one, of these parameters must be specified)

Parameter name Description Valid Input Values

*userName The user name of the agent that is calling the function. Non-empty strings
*password The password of the agent that is calling the function. Non-empty strings
*language The language in which the results will be displayed. A valid ISO code from
the “GetLanguages”
function.
**destination IATA-code for the airport that the hotels should be String value
associated with representing an IATA-
code
**hotelIDs The specific ID(s) of the hotel(s) A string containing
hotel IDs, separated by
commas, e.g.
“12,34,56”
**resortIDs The specific ID(s) of the resort(s) where the hotels A string containing
should be located. resort IDs, separated
by commas. Example:
“12,34,56”
accommodationTypes The types of accommodation that is to be searched. If “Hotel”, “Apartment”,
not specified, all types will be searched. “Villa”
sortBy The field that the results should be sorted after. If not “Hotel”, “Resort”,
specified, “Hotel” is used. “Classification”
sortOrder Determines the sorting order of the results. If not “Ascending” or
specified, “Ascending” will be used. “Descending”
exactDestinationMatch If set to “true” or “1” and “destination” is set, the “true”/”1” or
search results will only contain rooms where the “false”/”0”
destination code is the primary destination code.

Function output
Specification of output of function can be found at:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx?op=GetStaticHotelsAndRooms

XML Output
<?xml version="1.0" encoding="utf-8"?>
<getStaticHotelsAndRoomsResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://search.fitruums.com/1/">
<hotels>
<hotel>
<!--The unique ID of the hotel-->
<hotel.id></hotel.id>
<!--The ID of the destination where the hotel is located-->
<destination_id></destination_id>
<!--The ID of the resort where the hotel is located-->
<resort_id></resort_id>

FIT Ruums XML API version 1.2 45

 <!--Integer value indicating whether it is possible to add transfer
1 = adding transfer possible, 0 = adding transfer not possible-->
<transfer></transfer>
<!--All room types that are available for the accommodation.-->
<roomtypes>
<roomtype xsi:type="StaticRoomTypeWithRooms">
<!--The ID of the room type.-->
<roomtype.ID></roomtype.ID>
<!--All rooms for the room type that belong
to the accommodation and match the search criteria-->
<rooms>
<room xsi:type="StaticRoom">
<!--The ID of the room-->
<id></id>
<!--The number of adult that the room can accommodate-->
<beds></beds>
<!--The number of child that the room can accommodate, extra beds are not guaranteed-->
<extrabeds></extrabeds>
<!--Always empty for this function-->
<meals></meals>
<!--Always empty for this function-->
<cancellation_policies></cancellation_policies>
<!--Always empty for this function-->
<notes></notes>
<!--Determines whether the room is a "Super Deal" room-->
<isSuperDeal></isSuperDeal>
<!--Determines whether the room is a "Best Buy" room-->
<isBestBuy></isBestBuy>
<!--The available payment methods for the room-->
<paymentMethods>
<!--id: The ID of the payment method. 1: Invoice/Pay now, 2: Pay at hotel
name: The translated name of the payment method.-->
<paymentMethod xsi:type="StaticPaymentMethod" id="" name="">
<!--Depending on the payment method,
different properties may appear here.-->
<property key="" value=""/>
<property key="" value=""/>
</paymentMethod>
</paymentMethods>
<!--The features of the room-->
<features>
<!--id: The id of the feature, name: The name of the feature-->
<feature id="" name="" />
</features>
<!--The themes of the room-->
<themes>
<!--
id: The id of the theme, name: The name of the theme, image: The image associated with the theme-->
<theme id="" name="" image="" />
</themes>
</room>
</rooms>
<!--The name of the room type (translated to the language
specified for the current search)-->
<room.type></room.type>
<room.type></room.type>

FIT Ruums XML API version 1.2 46

 <!-- Whether rooms are shared for this room type, if true minimum age is 18 years. -->
<sharedRoom></sharedRoom>
<!-- Whether facilities are shared for this room type, if true minimum age is 18 years. -->
<sharedFacilities></sharedFacilities>
</roomtype>
</roomtypes>
<!--Contains review information for this accommodation-->
<review>
<!--Average rating-->
<rating></rating>
<!--Average price value-->
<pricevalue></pricevalue>
<!--Number of reviews-->
<count></count>
<!--Number of recommendations for the accommodation-->
<recommendCount></recommendCount>
</review>
<!--Always empty for this function-->
<notes />
<!--Always empty for this function-->
<isPrioritized xsi:nil="true" />
<!--Type of accommodation, e.g. "Hotel", "Apartment" or "Villa"-->
<type></type>
<!--The name of the accommodation-->
<name></name>
<!--First address line of the accommodation-->
<hotel.addr.1></hotel.addr.1>
<!--Second address line of the accommodation-->
<hotel.addr.2></hotel.addr.2>
<!--Zip code of the accommodation-->
<hotel.addr.zip></hotel.addr.zip>
<!--The city where the accommodation is located-->
<hotel.addr.city></hotel.addr.city>
<!--The state where the accommodation is located-->
<hotel.addr.state></hotel.addr.state>
<!--The country where the accommodation is located-->
<hotel.addr.country></hotel.addr.country>
<!--The country code of the country where the accommodation is located-->
<hotel.addr.countrycode></hotel.addr.countrycode>
<!--The complete address of the accommodation-->
<hotel.address></hotel.address>
<!--The URL to a map view of the accommodation-->
<hotel.mapurl></hotel.mapurl>
<!--The accomodation headline-->
<headline></headline>
<!--The description of the accommodation-->
<description></description>
<!--The name of the resort where the accommodation is located-->
<resort></resort>
<!--The name of the destination where the accommodation is located.-->
<destination></destination>
<!--The themes of the accommodation-->
<themes>
<!--id: The id of the theme, name: The name of the theme, image: The image associated with the theme-->
<theme id="" name="" image="" />
</themes>

FIT Ruums XML API version 1.2 47

 <!--All images for the accommodation-->
<images>
<!--The id of the image-->
<image id="">
<!--The full-size version of the image
url: The url to the image
(needs to be prepended with "https://hotelimages.sunhotels.net/HotelInfo/hotelImage.aspx?id=10473272&full=1")
height: The height of the image (in pixels)
width: The width of the image (in pixels)-->
<fullSizeImage url="" height="" width="" />
<!--The small version of the image
url: The url to the image
(needs to be prepended with "https://hotelimages.sunhotels.net/HotelInfo/hotelImage.aspx?id=10473272")
height: The height of the image (in pixels)
width: The width of the image (in pixels)-->
<smallImage url="" height="" width="" />
</image>
</images>
<!--The features of the accomodation-->
<features>
<!--id: The id of the feature, name: The name of the feature-->
<feature id="" name="" />
</features>
<!--The accommodation classification,
e.g. a digit between 1 and 5 plus an optional character, e.g. "+"-->
<classification></classification>
<!--The coordinates for the accommodation
(if the agent is allowed to view coordinates).-->
<coordinates>
<!--The latitude coordinate for the accommodation.-->
<latitude></latitude>
<!--The longitude coordinate for the accommodation.-->
<longitude></longitude>
</coordinates>
<!--A list of distance types linked to the accommodation,
i.e. distances to various beaches, airports, etc.-->
<distanceTypes>
<distanceType>
<!--The ID of the distance type-->
<hotelDistanceTypeId></hotelDistanceTypeId>
<!--The description of the type of place the child distances refer to-->
<description></description>
<distances>
<distance>
<!--The distance (in meters)-->
<distanceInMeters></distanceInMeters>
<!--The name of a place-->
<placeName></placeName>
<!--Coordinates for the described place-->
<coordinates>
<!--The latitude coordinate-->
<latitude></latitude>
<!--The longitude coordinate-->
<longitude></longitude>

FIT Ruums XML API version 1.2 48

 </coordinates>
</distance>
</distances>
</distanceType>
</distanceTypes>
<!--The time zone where the accommodation is located-->
<timeZone></timeZone>
<!--Whether accommodation is "Best Buy" or not.-->
<isBestBuy></isBestBuy>
<codes>
<!-- Codes.-->
<code type="" value=""></code>
</codes>
</hotel>
</hotels>
<!--This element only appears when an error has occurred.-->
<Error>
<!--The type of error (exception).-->
<ErrorType></ErrorType>
<!--A description of the error.-->
<Message></Message>
</Error>
</getStaticHotelsAndRoomsResult>

FIT Ruums XML API version 1.2 49

Retrieving booking information
This function is used to get information about an existing booking or all bookings created within a specific date
range or all bookings with an arrival date within a specific date range.
Example URL with input:
http://book.fitruums.com/1/PostGet/Booking.asmx/GetBookingInformation?userName=[YourUsername]&pass
word=[YourPassword]&language=en&bookingID=1454020&reference=&createdDateFrom=&createdDateTo=&
arrivalDateFrom=&arrivalDateTo=

Function inputs
*: Required input
**: Required alternative (one of these parameters must be specified)

Parameter name Description Valid Input Values

*userName The user name of the agent that is calling the function. Non-empty strings
*password The password of the agent that is calling the function. Non-empty strings
*language The language in which the results will be displayed. A valid ISO code from
the “GetLanguages”
function.
**bookingID The ID of an existing booking. Integers > 0
**reference A reference associated with an existing booking String representing a
booking reference.
**createdDateFrom Specifies the start date of the time period when the A date in the format
searched bookings are to have been created. ‘YYYY-MM-DD”
YYYY = Year
Note: If specified, createdDateTo must also be specified. MM = Month number
DD = Day number
**createdDateTo Specifies the start date of the time period when the A date in the format
searched bookings are to have been created. ‘YYYY-MM-DD”
YYYY = Year
Note: If specified, createdDateFrom must also be MM = Month number
specified. DD = Day number
**arrivalDateFrom Specifies the start of the date range when the arrival A date in the format
date has occurred. ‘YYYY-MM-DD”
YYYY = Year
Note: If specified, arrivalDateTo must also be specified. MM = Month number
DD = Day number
**arrivalDateTo Specifies the end of the date range when the arrival date A date in the format
has occurred. ‘YYYY-MM-DD”
YYYY = Year
Note: If specified, arrivalDateFrom must also be MM = Month number
specified. DD = Day number

Function output
Specification of output of function can be found at:
http://book.fitruums.com/1/PostGet/Booking.asmx?op=GetBookingInformation

XML Output
<?xml version="1.0" encoding="utf-8" ?>
<getBookingInformationResult>
<!--All retrieved bookings-->
<bookings>
<booking>
</booking>
</bookings>
<!--This element only appears when an error has occurred.-->

FIT Ruums XML API version 1.2 50

 <Error>
<!--The type of error (the exception type).-->
<ErrorType></ErrorType>
<!--A description of the error.-->
<Message></Message>
</Error>
</getBookingInformationResult>

FIT Ruums XML API version 1.2 51

Retrieving transfer booking information
This function is used to get information about a transfer add-on booking.
Example URL with input:
http://book.fitruums.com/1/PostGet/Booking.asmx/GetTransferBookingInformation?userName=[YourUserna
me]&password=[YourPassword]&language=en&bookingID=2435578&createdDateFrom=&createdDateTo=&arr
ivalDateFrom=&arrivalDateTo=

Function inputs
*: Required input
**: Required alternative (one of these parameters must be specified)

Parameter name Description Valid Input Values

*userName The user name of the agent that is calling the function. Non-empty strings
*password The password of the agent that is calling the function. Non-empty strings
*language The language in which the results will be displayed. A valid ISO code from
the “GetLanguages”
function.
*bookingID The ID of an existing booking. Integers > 0
**createdDateFrom Specifies the start date of the time period when the A date in the format
searched bookings are to have been created. ‘YYYY-MM-DD”
YYYY = Year
Note: If specified, createdDateTo must also be specified. MM = Month number
DD = Day number
**createdDateTo Specifies the start date of the time period when the A date in the format
searched bookings are to have been created. ‘YYYY-MM-DD”
YYYY = Year
Note: If specified, createdDateFrom must also be MM = Month number
specified. DD = Day number
**arrivalDateFrom Specifies the start of the date range when the arrival A date in the format
date has occurred. ‘YYYY-MM-DD”
YYYY = Year
Note: If specified, arrivalDateTo must also be specified. MM = Month number
DD = Day number
**arrivalDateTo Specifies the end of the date range when the arrival date A date in the format
has occurred. ‘YYYY-MM-DD”
YYYY = Year
Note: If specified, arrivalDateFrom must also be MM = Month number
specified. DD = Day number

FIT Ruums XML API version 1.2 52

Function output
Specification of output of function can be found at:
http://book.fitruums.com/1/PostGet/Booking.asmx?op=GetTransferBookingInformation

XML Output
<?xml version="1.0" encoding="utf-8"?>
<getTransferBookingInformationResult>
<!--All transfer add-on bookings that were retrieved for the provided booking.-->
<transferBookings>
<transferBooking>
<!--The ID of the booking.-->
<transferbookingnumber></transferbookingnumber>
<!--The ID of the hotel where the transfer is booked-->
<hotel.id></hotel.id>
<!--The name of the hotel where the transfer is booked.-->
<hotel.name></hotel.name>
<!--The name of the contact person for the transfer booking.-->
<contactPerson></contactPerson>
<!--The contact cellphone number for the transfer booking.-->
<contactCellphone></contactCellphone>
<!--The airline used.-->
<airline></airline>
<!--The flight number used.-->
<flightNumber></flightNumber>
<!--The airport used for departure.-->
<departureAirport></departureAirport>
<!--The airport used for arrival..-->
<arrivalAirport></arrivalAirport>
<!--The time of departure (in the format hh:mm, where hh = hours,
ranging from 00 to 23, mm = minutes, ranging from 00 to 59).-->
<departureTime></departureTime>
<!--The date of arrival (in the format YYYY-MM-DD,
where YYYY = year, MM = month number and DD = day number).-->
<arrivalDate></arrivalDate>
<!--The time of arrival (in the format hh:mm, where hh = hours,
ranging from 00 to 23, mm = minutes, ranging from 00 to 59).-->
<arrivalTime></arrivalTime>
<!--The number of passengers.-->
<passengers></passengers>
<!--The ID of the associated transfer.-->
<transferID></transferID>
<!--The ID of the transfer type.-->
<transferTypeID></transferTypeID>
<!--The name of the transfer type.-->
<transferType></transferType>
<!--Text that is shown on the arrival voucher.-->
<arrivalVoucherText></arrivalVoucherText>
<!--Text that is shown on the return voucher.-->
<returnVoucherText></returnVoucherText>
<!--The URL for the voucher.-->
<voucherURL></voucherURL>
<!--The provider from the transfer voucher.-->
<provider></provider>
<!--The phone numbers from the transfer voucher.-->
<providerPhone></providerPhone>
<!--The emergency phone numbers from the transfer voucher.-->
<providerEmergencyPhone></providerEmergencyPhone>
<!--Integer indicating whether a return transfer is included.
1 = return transfer included, 0 = return transfer not included.-->

FIT Ruums XML API version 1.2 53

 <returntransfer></returntransfer>
<!--The airline used for the return transfer.-->
<returnairline></returnairline>
<!--The flight number used for the return transfer.-->
<returnflightNumber></returnflightNumber>
<!--The date of departure for the return transfer.-->
<returndepartureDate></returndepartureDate>
<!--The time of departure for the return transfer.-->
<returndepartureTime></returndepartureTime>
<!--The price for the transfer in the used currency,.-->
<price></price>
<!--The used currency.-->
<currency></currency>
<!--The price for the transfer in Euros.-->
<price.EUR></price.EUR>
<!-- The status of the booking. “Status: Active” means the booking is confirmed in our
system although is flagged as failed (timeout)-->
<bookingstatus>NotActive or Active</bookingstatus>
<!--The invoice reference used when booking-->
<invoiceref></ invoiceref >
<!--The reference used when booking-->
<yourref></yourref>
</transferBooking>
</transferBookings>
<!--This element only appears when an error has occurred.-->
<Error>
<!--The type of error (the exception type).-->
<ErrorType></ErrorType>
<!--A description of the error.-->
<Message></Message>
</Error>
</getTransferBookingInformationResult>

FIT Ruums XML API version 1.2 54

Booking a transfer
This function is used to book a transfer, either to an existing booking or stand-alone.
Adding a transfer to an existing hotel booking is allowed up to 48 hours before hotel arrive date
(12 noon - hotel local time).
Transfer bookings are non-refundable upon cancellation within 48 hours before the hotel check-in date (12
noon – hotel/resort local time).
Example URL with input:
http://book.fitruums.com/1/PostGet/Booking.asmx/AddTransfer?userName=[YourUsername]&password=[You
rPassword]&language=en&currency=EUR&email=noreply@fitruums.com&bookingID=8000321&hotelName=&
contactPerson=testcontactperson&contactCellphone=testcellphone&airline=testairline&flightNumber=testflig
htnumber&departureAirport=testdepartureairport&departureTime=12:23&arrivalTime=23:48&arrivalDate=20
07-05-
02&passengers=3&transferID=518&returnTransfer=1&returnAirline=testreturnairline&returnFlightNumber=tes
treturnflightnumber&returnDepartureDate=2007-07-07&returnDepartureTime=13:45&invoiceref=&yourRef=

Function inputs
*: Required input
**: Required alternative (one of these parameters must be specified)
NOTE:
”When using SOAP the arrival date and arrival time is sent using one parameter ”arrivalTime” containing both
date and time.”
”When using SOAP the return date and return time is sent using one parameter ”returnDepartureTime”
containing both date and time.

Parameter name Description Valid Input Values

*userName The user name of the agent that is calling the function. Non-empty strings
*password The password of the agent that is calling the function. Non-empty strings
*language The language in which the results will be displayed. A valid ISO code from
the “GetLanguages”
function.
*currency The currency that all prices will be converted to in the String representing a
search results. currency code, e.g.
“GBP”.
*email The e-mail address of the agent. This is where the String representing a
booking confirmation e-mail is sent. valid e-mail address.
**bookingID The ID of an existing booking. Integers > 0
**hotelName The name of an existing hotel String representing
the name of a hotel
*contactPerson The surname and last name of the contact person String representing a
surname and last
name
*contactCellphone The contact cellphone number String representing a
cell phone number
*airline The name of the airline used for the arrival transfer. String representing
the name of an airline
*flightNumber The flight number used for the arrival transfer String representing a
flight number
*departureAirport The name or IATA-code of the airport used for departing String representing
to the booked hotel the name or IATA-
code of an airport
*departureTime Time of departure A timestamp in the
format “hh:mm”,
where hh = hours and
mm = minutes

FIT Ruums XML API version 1.2 55

 *arrivalTime Time of arrival A timestamp in the
format “hh:mm”,
where hh = hours and
mm = minutes
*arrivalDate Date of arrival A date in the format
‘YYYY-MM-DD”
YYYY = Year
MM = Month number
DD = Day number
*passengers The number of passengers to transfer Integers > 0
*transferID The ID of the associated transfer Integer representing
the ID of a transfer
*returnTransfer Indicates whether a return transfer should be booked 0 = only arrival
transfer
or
1 = both arrival and
return transfer
or
2 = only return
transfer
*returnAirline The name of the airline used for the return transfer String representing
Note: This is only required if “returnTransfer” is set to 1 the name of an airline
*returnFlightNumber The flight number used for the return transfer String representing a
Note: This is only required if “returnTransfer” is set to 1 flight number
*returnDepartureDate Date of departure A date in the format
Note: This is only required if “returnTransfer” is set to 1 ‘YYYY-MM-DD”
YYYY = Year
MM = Month number
DD = Day number
*returnDepartureTime Time of departure A timestamp in the
Note: This is only required if “returnTransfer” is set to 1 format “hh:mm”,
where hh = hours and
mm = minutes
invoiceRef An invoice reference. A string representing
your invoice reference
number.
yourRef A booking number or reference. A string representing
your reference.

Function output
Specification of output of function can be found at:
http://book.fitruums.com/1/PostGet/Booking.asmx?op=AddTransfer

XML Output
<?xml version="1.0" encoding="utf-8"?>
<TransferBookingList>
<!--This list will only contain information about the transfer that has been booked.-->
<transferbookings>
<transferbooking>
<!--The ID of the booking where the transfer was added.-->
<transferbookingnumber></transferbookingnumber>
<!--The ID of the hotel where the transfer is booked-->
<hotel.id></hotel.id>
<!--The name of the hotel where the transfer is booked.-->
<hotel.name></hotel.name>
<!--The name of the contact person for the transfer booking.-->
<contactPerson></contactPerson>

FIT Ruums XML API version 1.2 56

 <!--The contact cellphone number for the transfer booking.-->
<contactCellphone></contactCellphone>
<!--The airline used.-->
<airline></airline>
<!--The flight number used.-->
<flightNumber></flightNumber>
<!--The airport used for departure.-->
<departureAirport></departureAirport>
<!--The airport used for arrival..-->
<arrivalAirport></arrivalAirport>
<!--The time of departure (in the format hh:mm, where hh = hours,
ranging from 00 to 23, mm = minutes, ranging from 00 to 59).-->
<departureTime></departureTime>
<!--The date of arrival (in the format YYYY-MM-DD,
where YYYY = year, MM = month number and DD = day number).-->
<arrivalDate></arrivalDate>
<!--The time of arrival (in the format hh:mm, where hh = hours,
ranging from 00 to 23, mm = minutes, ranging from 00 to 59).-->
<arrivalTime></arrivalTime>
<!--The number of passengers.-->
<passengers></passengers>
<!--The ID of the associated transfer.-->
<transferID></transferID>
<!--The ID of the transfer type.-->
<transferTypeID></transferTypeID>
<!--The name of the transfer type.-->
<transferType></transferType>
<!--Text that is shown on the arrival voucher.-->
<arrivalVoucherText></arrivalVoucherText>
<!--Text that is shown on the return voucher.-->
<returnVoucherText></returnVoucherText>
<!--The URL for the voucher.-->
<voucherURL></voucherURL>
<!--The provider from the transfer voucher.-->
<provider></provider>
<!--The phone numbers from the transfer voucher.-->
<providerPhone></providerPhone>
<!--The emergency phone numbers from the transfer voucher.-->
<providerEmergencyPhone></providerEmergencyPhone>
<!--Integer indicating whether a return transfer is included.
1 = return transfer included, 0 = return transfer not included.-->
<returntransfer></returntransfer>
<!--The airline used for the return transfer.-->
<returnairline></returnairline>
<!--The flight number used for the return transfer.-->
<returnflightNumber></returnflightNumber>
<!--The date of departure for the return transfer.-->
<returndepartureDate></returndepartureDate>
<!--The time of departure for the return transfer.-->
<returndepartureTime></returndepartureTime>
<!--The price for the transfer in the used currency,.-->
<price></price>
<!--The used currency.-->
<currency></currency>
<!--The price for the transfer in Euros.-->
<price.EUR></price.EUR>
<!--The status of the booking.-->
<bookingstatus>NotActive or Active</bookingstatus>
<!--The invoice reference used when booking.-->

FIT Ruums XML API version 1.2 57

 <invoiceref></invoiceref>
<!-- The reference used when booking.-->
<yourref></yourref>
</transferbooking>
</transferbookings>
<!--This element only appears when an error has occurred.-->
<Error>
<!--The type of error (the exception type).-->
<ErrorType></ErrorType>
<!--A description of the error.-->
<Message></Message>
</Error>
</TransferBookingList>

Errors
Listed below are common errors that may appear under the “Error” element.
Should any errors occur that are not listed here, contact WebBeds.
Error Type Description Resolution
InvalidParametersForTransferException You are trying to Remove the values for the
book an arrival-only return-specific parameters.
transfer but have
provided return-
specific parameters
to the function.
NoTransfersAvailableForCCAgentsException You are trying to N/A
book a transfer while
the
“force_creditcard”
setting for your
account is set to “1”,
which is not possible.
NonExistentTransferException You are trying to Use the “SearchTransfers”
book a transfer that function to find available
does not exist. transfers to book.
BookingNotActiveException You are trying to add Add the transfer to a
a transfer to a hotel different booking or as a
booking that is not stand-alone transfer
active for some booking.
reason (e.g. have
been cancelled, etc.)
PassengersLessThanTransferMinimumException The provided number Increase the number of
of passengers is less passengers to meet the
than the minimum minimum criterion or try
allowed number of to book a different
passengers for the transfer.
transfer.
PassengersMoreThanTransferMaximumException The provided number Decrease the number of
of passengers is more passengers to meet the
than the maximum minimum criterion or try
allowed number of to book a different
passengers for the transfer.
transfer.
TransferAlreadyBookedException You are trying to add Add the transfer to a
a transfer to a different booking or cancel
booking that already the existing transfer
has a transfer added booking.
to it.

FIT Ruums XML API version 1.2 58

Cancelling a transfer booking
This function is used to cancel an existing transfer booking.
Example URL with input:
http://book.fitruums.com/1/PostGet/Booking.asmx/CancelTransferBooking?userName=[YourUsername]&pass
word=[YourPassword]&language=en&email=noreply@fitruums.com&transferBookingID=ST8000506

Function inputs
*: Required input

Parameter name Description Valid Input Values

*userName The name of the user that is performing the Non-empty strings
cancellation operation.
*password The password of the user that is performing the Non-empty strings
cancellation operation.
*language Determines the language that the booking A valid ISO code from the
cancellation mail will be displayed in. “GetLanguages” function.
*email The e-mail address of the agent. This is where the String representing a valid e-
cancellation e-mail is sent. mail address.
*transferBookingID The ID of the booking whose transfer is to be String containing numerical
cancelled. characters, optionally
preceded by “ST”

FIT Ruums XML API version 1.2 59

Function output
Specification of output of function can be found at:
http://book.fitruums.com/1/PostGet/Booking.asmx?op=CancelTransferBooking

XML output
<?xml version="1.0" encoding="utf-8"?>
<cancelTransferBookingResult>
<!--The generated cancellation fee (if the cancellation yielded a fee,
otherwise 0), in Euros.-->
<cancellationFeeInEuros></cancellationFeeInEuros>
<!--The generated cancellation fee (if the cancellation yielded a fee,
otherwise 0), in currency specified in the booking.-->
<cancellationFeeInLocalCurrency></cancellationFeeInLocalCurrency>
<!--The currency specified in the cancelled transfer booking.-->
<currency></currency>
<!--The status code of the cancellation.
1 is successful and -1 is unsuccessful.-->
<code></code>
<!--This element only appears when an error has occurred.-->
<Error>
<!--The type of error (exception).-->
<ErrorType></ErrorType>
<!--A description of the error.-->
<Message></Message>
</Error>
</cancelTransferBookingResult>

Errors
Listed below are common errors that may appear under the “Error” element.
Should any errors occur that are not listed here, contact WebBeds.
Error Type Description Resolution
NonExistentTransferBookingException You are trying to cancel Check that the provided
a transfer booking for a booking ID is correct.
booking that have not
had any transfers
added to it.
NonExistentTransferBookingException You are trying to cancel Not available
a transfer booking that
has already been
cancelled.
TransferCancellationDeadlineExpiredException The cancellation Not available.
deadline of the transfer
booking has expired.

FIT Ruums XML API version 1.2 60

Downloading static data
This function is used to download exported XML files containing static information about hotels, destinations,
etc. in the system.
Example URL with input:
http://book.fitruums.com/1/DownloadExport.aspx?username=[YourUsername]&password=[YourPassword]&la
nguage=en&xmlType=Place&version=150&Format=zip

Function inputs
*: Required input
**: Required alternative (one of these parameters must be specified)

Parameter name Description Valid Input Values

*userName The user name of the agent that is calling the function. Non-empty strings
*password The password of the agent that is calling the function. Non-empty strings
*xmlType The type of contents of interest. “Place” or “Cache”
“Place” indicates information about destinations,
countries, cities, airports, etc.
“Cache” indicates information about things such as
hotels, rooms, etc.
*language The language in which the results will be displayed. A valid ISO code from
Note: Contact WebBeds to know what languages are the “GetLanguages”
available on your account. function.
version The version of the XML content. 150 have to be 150
specified to get the most current resort mapping. The
value 150 stands for the schema 1.5.0. Newer versions
will be released in the future.
Format Format to compress the download of the file. “zip” is the
compression format
used

FIT Ruums XML API version 1.2 61

Content of places document:
The file consist of nested places elements. The first level of places elements should be interpreted as countries.
The next level of places should be interpreted as destinations. The third and most inner level is resorts.

Example of a places document:

<?xml version="1.0" encoding="utf-8"?>
<sunhotels_cache_file xmlns="http://xml.sunhotels.net/schemas/Places_1.5.0.xsd">
<provider_definition>
<name>InternalExport</name>
<currency>EUR</currency>
</provider_definition>
<code_types>
<code_type>IATA</code_type>
<code_type>ISO-COUNTRY</code_type>
</code_types>
<places>
<!--First level: Countries-->
<place>
<id>1</id>
<description>Spain</description>
<codes>
<code type="ISO-COUNTRY" value="ES" />
</codes>
<places>
<!--Second level: Destinations-->
<place>
<id>4</id>
<description>Mallorca</description>
<codes>
<code type="IATA" value="PMI" />
</codes>
<places>
<!--Third level: Resorts-->
<place>
<id>9</id>
<description>Cala d Or</description>
</place>
<place>
<id>22</id>
<description>Alcudia Bay</description>
</place>
<place>
<id>30</id>
<description>Cala Vinas</description>
</place>
</places>
</place>
</places>
</place>
</places>
</sunhotels_cache_file>

FIT Ruums XML API version 1.2 62

Content of cache document
The cache document contains all static data about a hotel, like the name, address and description.
The cache file consists of two main elements, hotels and room types. All hotels also have one or more rooms. A
room must have a room type that can be found under the room types definitions.

Example of cache document:

<?xml version="1.0" encoding="utf-8"?>
<sunhotels_cache_file xmlns="http://xml.sunhotels.net/schemas/AvailabilityCache_1.5.0.xsd">
<provider_definition>
<name>InternalExport</name>
<currency>EUR</currency>
</provider_definition>
<passenger_definitions>
<child max_age="11" />
</passenger_definitions>
<features>
<feature>airconditioning</feature>
<feature>elevator</feature>
<feature>bar</feature>
<feature>telephone</feature>
<feature>childrens_pool</feature>
<feature>pool</feature>
<feature>safe</feature>
<feature>sea_view</feature>
<feature>balcony</feature>
<feature>restaurant</feature>
<feature>tv</feature>
<feature>wireless internet</feature>
</features>
<themes>
<theme>luxury</theme>
<theme>budget</theme>
<theme>spa</theme>
<theme>family</theme>
<theme>skiing</theme>
<theme>environment</theme>
</themes>
<distance_types>
<distance_type>center</distance_type>
<distance_type>airport</distance_type>
<distance_type>beach</distance_type>
</distance_types>
<!--Room types will be used inside the room on each hotel.-->
<room_types>
<type>
<description>Apartment 1 bedroom - Sea View</description>
<id>51.4.0</id>
<beds>4</beds>
<extrabeds>0</extrabeds>
<shared_room>false</shared_room>
<shared_facilities>false</shared_facilities>
</type>
<type>
<description>Apartment 1 bedroom - Pool View</description>
<id>52.4.0</id>
<beds>4</beds>
<extrabeds>0</extrabeds>
<shared_room>false</shared_room>
<shared_facilities>false</shared_facilities>

FIT Ruums XML API version 1.2 63

 </type>
</room_types>
<cancellation_policies />
<hotels>
<hotel>
<id>535</id>
<name>Niu Daus</name>
<accomodation_type>apartment</accomodation_type>
<headline>Apartments close to Porto Petro (700 m).</headline>
<description>
Niu D'Aus is a small apartment complex situated on the road to Porto Petro, just 1,5 km outside the centre of
Cala Egos, where you will find the nearest beach and shops, bars and restaurants.
The apartments consist of a twin bedroom, living room with sofa beds, kitchenette, bathroom and balcony.
There is a swimming pool with a children’s section, small playground, sun terrace.
There is a tennis court 5 min from the hotel and just 4 km away there are 8 different beaches.

Cleaning services and change of towels: 3 times weekly and change of sheets: once a week.

Reception with limited opening hours. Important - While making the booking you are requested to indicate the
arrival time.
</description>
<place>9</place>
<address>
<street1>S´Estel d´Derjen 18</street1>
<street2>(carretera Porto Petro Cala d´or)</street2>
<zipcode>07691</zipcode>
<city>Porto Petro</city>
<state>Mallorca</state>
<country>Spain</country>
</address>
<position>
<latitude>39.3638830313957</latitude>
<longitude>3.21358680725098</longitude>
</position>
<phone>0034 971 658 114</phone>
<fax>0034 971 659 767</fax>
<email>
</email>
<classification>3</classification>
<best_buy>true</best_buy>
<!-- If set to 1 minimum age to stay at hotel is 18 years -->
<adult_only>1</adult_only>
<features>
<feature>airconditioning</feature>
<feature>childrens_pool</feature>
<feature>pool</feature>
<feature>safe</feature>
<feature>balcony</feature>
<feature>tv</feature>
<feature>wireless internet</feature>
</features>
<distances>
<distance name="center" value="0.7" />
<distance name="airport" value="60" />
<distance name="beach" value="1.5" />
</distances>
<reviews>
<review provider="CHR" type="ReviewAvgRating" value="3.67" />
<review provider="CHR" type="ReviewAvgPriceValue" value="4.00" />

FIT Ruums XML API version 1.2 64

 <review provider="CHR" type="ReviewCount" value="12" />
<review provider="CHR" type="ReviewRecommendCount" value="0" />
</reviews>
<images>
<image id="10473272">
<image_variant width="200"
height="150">https://hotelimages.sunhotels.net/HotelInfo/hotelImage.aspx?id=10473272</image_variant>
<image_variant width="800"
height="600">https://hotelimages.sunhotels.net/HotelInfo/hotelImage.aspx?full=1&amp;id=10473272</image_
variant>
</image>
<image id="10473273">
<image_variant width="200"
height="150">https://hotelimages.sunhotels.net/HotelInfo/hotelImage.aspx?id=10473273</image_variant>
<image_variant width="800"
height="600">https://hotelimages.sunhotels.net/HotelInfo/hotelImage.aspx?full=1&amp;id=10473273</image_
variant>
</image>
<image id="10473274">
<image_variant width="200"
height="150">https://hotelimages.sunhotels.net/HotelInfo/hotelImage.aspx?id=10473274</image_variant>
<image_variant width="800"
height="600">https://hotelimages.sunhotels.net/HotelInfo/hotelImage.aspx?full=1&amp;id=10473274</image_
variant>
</image>
</images>
<rooms>
<!--The definition of the type_id attribute is in room types-->
<room type_id="51.4.0">
<room_id>715</room_id>
<best_buy>true</best_buy>
</room>
<room type_id="52.4.0">
<room_id>15972</room_id>
<best_buy>false</best_buy>
</room>
</rooms>
</hotel>
</hotels>
</sunhotels_cache_file>

FIT Ruums XML API version 1.2 65

Country, Destination and Resort notes
City tax information and other important notes related to some countries, destinations or resorts, like
nationality restrictions, are only returned in PreBook and booking response in our API. If you wish to also show
this information in search you can retrieve the information of which notes exist and what days they apply on by
downloading following files.

*Make sure to update below URLs to use your username, password and language.

Example URL with input:

Country Notes
http://search.fitruums.com/1/DownloadExport.aspx?username=[YourUsername]&password=[YourPassword]&
language=XX&xmlType=country_notes&version=150

Destinations Notes
http://search.fitruums.com/1/DownloadExport.aspx?username=[YourUsername]&password=[YourPassword]&
language=XX&xmlType=destination_notes&version=150

Resort Notes
http://search.fitruums.com/1/DownloadExport.aspx?username=[YourUsername]&password=[YourPassword]&
language=XX&xmlType=resort_notes&version=150

FIT Ruums XML API version 1.2 66

Retrieving all supported languages
This function is used to retrieve a list of all supported languages, including shortened versions of their ISO
codes that are to be used in all other function with a “language” parameter. Note that before getting access to
the language it need to be enabled on your account. Speak to your sales representative at WebBeds for more
information.

Example URL with input:

http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx/GetLanguages?userName=[YourUsername]&pa
ssword=[YourPassword]

Function inputs
*: Required input

Parameter name Description Valid Input Values

*userName The user name of the agent that is calling the function. Non-empty strings
*password The password of the agent that is calling the function. Non-empty strings

Function output
Specification of output of function can be found at:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx?op=GetLanguages

XML output
<?xml version="1.0" encoding="utf-8"?>
<getLanguagesResult>
<!-- All retrieved languages-->
<languages>
<!--isoCode: The code to use in the "language" parameter in all functions
that have the parameter, i.e. "en", "fr", etc.
name: The english name of the language, i.e. "English", "French", etc. -->
<language isoCode="" name="" />
</languages>
</getLanguagesResult>

FIT Ruums XML API version 1.2 67

Retrieving all meals
This function is used to retrieve all meals in the system, along with their various labels, translated to a specified
language.
Example URL with input:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx/GetMeals?userName=[YourUsername]&passwo
rd=[YourPassword]&language=en

Function inputs
*: Required input

Parameter name Description Valid Input Values

*userName The user name of the agent that is calling the function. Non-empty strings
*password The password of the agent that is calling the function. Non-empty strings
*language This string will determine the language that the meals A valid ISO code from
and labels will be displayed in. the “GetLanguages”
function.

Function output
Specification of output of function can be found at:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx?op=GetMeals

XML output
<?xml version="1.0" encoding="utf-8"?>
<getMealsResult>
<!--All available meals-->
<meals>
<meal>
<!--The ID of the meal.-->
<id></id>
<!--The translated name of the meal.-->
<name></name>
<!--All labels for the meal-->
<labels>
<label>
<!--The ID of the meal label.-->
<id></id>
<!--The text of the meal label.-->
<text></text>
</label>
</labels>
</meal>
</meals>
<!--This element only appears when an error has occurred.-->
<Error>
<!--The type of error (the exception type).-->
<ErrorType></ErrorType>
<!--A description of the error.-->
<Message></Message>
</Error>
</getMealsResult>

FIT Ruums XML API version 1.2 68

Retrieving all features
This function is used to retrieve all features in the system, along with their various labels, translated to a
specified language.
Example URL with input:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx/GetFeatures?userName=[YourUsername]&pass
word=[YourPassword]&language=en

Function inputs
*: Required input

Parameter name Description Valid Input Values

*username The user name of the agent that is calling the function. Non-empty strings
*password The password of the agent that is calling the function. Non-empty strings
*language This string will determine the language that the features A valid ISO code from
will be displayed in. the “GetLanguages”
function.

Function output
Specification of output of function can be found at:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx?op=GetFeatures

XML output
<?xml version="1.0" encoding="utf-8"?>
<getFeaturesResult>
<features>
<!--id: The ID of the feature, name: The translated name of the feature-->
<feature id="" name="" />
</features>
</getFeaturesResult>

FIT Ruums XML API version 1.2 69

Retrieving all hotel note descriptions
This function is used to retrieve all hotel note descriptions in the system, translated to a specified language.
Example URL with input:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx/GetHotelNoteTypes?userName=[YourUsernam
e]&password=[YourPassword]&language=en

Function inputs
*: Required input

Parameter name Description Valid Input Values

*username The user name of the agent that is calling the function. Non-empty strings
*password The password of the agent that is calling the function. Non-empty strings
*language This string will determine the language that the notes A valid ISO code from
will be displayed in. the “GetLanguages”
function.

Function output
Specification of output of function can be found at:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx?op=GetHotelNoteTypes

XML output
<?xml version="1.0" encoding="utf-8"?>
<getHotelNoteTypesResult>
<noteTypes>
<!--id: The ID of the note type, text: The translated text of the note type-->
<noteType id="" text="" />
</noteTypes>
</getHotelNoteTypesResult>

FIT Ruums XML API version 1.2 70

Retrieving all room note descriptions
This function is used to retrieve all room note descriptions in the system, translated to a specified language.
Example URL with input:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx/GetRoomNoteTypes?userName=[YourUsernam
e]&password=[YourPassword]&language=en

Function inputs
*: Required input

Parameter name Description Valid Input Values

*username The user name of the agent that is calling the function. Non-empty strings
*password The password of the agent that is calling the function. Non-empty strings
*language This string will determine the language that the notes A valid ISO code from
will be displayed in. the “GetLanguages”
function.

Function output
Specification of output of function can be found at:
http://search.fitruums.com/1/PostGet/NonStaticXMLAPI.asmx?op=GetRoomNoteTypes

XML output
<?xml version="1.0" encoding="utf-8"?>
<getRoomNoteTypesResult>
<noteTypes>
<!--id: The ID of the note type, text: The translated text of the note type-->
<noteType id="" text="" />
</noteTypes>
</getRoomNoteTypesResult>

FIT Ruums XML API version 1.2 71

Retrieving booking special request
This function is used to retrieve a booking special request from the system.
Example URL with input:
http://book.fitruums.com/1/PostGet/Booking.asmx/GetSpecialRequest?userName=[YourUsername]&passwor
d=[YourPassword]&bookingId=2435578

Function inputs
*: Required input

Parameter name Description Valid Input Values

*userName The user name of the agent that is calling the function. Non-empty strings
*password The password of the agent that is calling the function. Non-empty strings
*bookingId This booking ID of the booking to get the special request Integers > 0
for.

Function output
Specification of output of function can be found at:
http://book.fitruums.com/1/PostGet/Booking.asmx?op=GetSpecialRequest

XML output
<?xml version="1.0" encoding="utf-8"?>
<getSpecialRequestResult>
<!--text: The text describing the special request, empty if no special
request is available-->
<text />
</getSpecialRequestResult>

FIT Ruums XML API version 1.2 72

Updating booking special request
This function is used to update a booking special request.
Example URL with input:
http://book.fitruums.com/1/PostGet/Booking.asmx/UpdateSpecialRequest?userName=[YourUsername]&pass
word=[YourPassword]&bookingId=2435578&text=This%20is%20a%20special%20request

Function inputs
*: Required input

Parameter name Description Valid Input Values

*userName The user name of the agent that is calling the function. Non-empty strings
*password The password of the agent that is calling the function. Non-empty strings
*bookingId This booking ID of the booking to get the special request Integers > 0
for.
text The special request text. strings

Function output
Specification of output of function can be found at:
http://book.fitruums.com/1/PostGet/Booking.asmx?op=UpdateSpecialRequest

XML output
<?xml version="1.0" encoding="utf-8"?>
<updateSpecialRequestResult>
<!--Declares whether the update was successful.
0: Booking does not exist, 1: Updated, 2: No changes were done.-->
<resultCode />
<!--A message describing the result code.-->
<resultMessage />
</updateSpecialRequestResult>

FIT Ruums XML API version 1.2 73