CyberesaWS Hotel 8.0.5

Solutions e-tourisme
CYBERESA Web Services

Technical Specifications - Hotel Pack – v8.x
CYBERESA SARL au capital de 560 000 TND (R.C : B2437152011 – M.F : 1189611/V)
Siège social : Immeuble 3S, Lotissement Ennassim, 1073 Montplaisir - Tunis - TUNISIE
Tél : +216 71 947 401 - Fax : +216 70 201 010 - Site web : www.cyberesa.net - Email : info@cyberesa.net
05/07/2019 – page 1/56
Document Control
Company Cyberesa Sarl

Department API Consulting & Service
Author Dev Team
Version 8.0.4
Date 05/07/2019
Revision History Control
Date Author Actions

03/04/2015 Ismail Diari Document creation
26/08/2015 Chaima Mekni Add APIs StaticDataRQ and
HotelDetatilRQ
03/09/2015 Chaima Mekni Edit HotelSearchRES
04/12/2015 Ismail Diari Add Details for Available node in
HotelSearchRES
25/03/2016 Ghada Saihi Add nodes in
HotelBookingCreationRES
14/04/2016 Ismail Diari Add node Category in
HotelBookingCreationRES
02/06/2016 Ismail Diari Update HotelBookingCreationRES :
- Add Multi CancellationPolicies
- Add Fee node under
CancellationPolicy node
- Delete currency attribute
- Add NoShowPolicy Node
- Delete ConfirmationDetails node
- Move CancellationPolicies under
OrderDetails node
- Add password attribute to
OrderDetails node
- Delete CancellationRules node
02/06/2016 Ismail Diari Add New API HotelCancellationPolicy
02/06/2016 Chaima Mekni Add node Customer in
HotelBookingCreationREQ
03/06/2016 Chaima Mekni 1.Add node Kit in
HotelBookingCreationREQ only for
B2C and Available booking
2.Delete node
SelectedRooms:Options:Option:@id
from HotelBookingCreationREQ
05/07/2019 – page 2/56
3.Add node Options to SaticData API
4. Add node Options to HotelDetail API

08/06/2016 Chaima Mekni Add node Summary to HotelDetailRS
10/06/2016 Chaima Mekni Add new node Kit:PaymentGateway to
Delete nodes PaymentMode, Kit:Status,

Kit:ErrorType, Kit:ErrorNumber and
Kit:ErrorText from
15/07/2016 Chaima Mekni Add new nodes Passenger:Age and
Passenger:Reduction to
05/04/2017 Abdelhedi Neffati Add Api TripBookingList API
16/05/2017 Abdelhedi Neffati Add CreditCheck() API
07/06/2017 Chaima Mekni Edit HotelSearchRES API:
Change attribute ‘agemax’ to ‘maxage’
Change attribute ‘agemin’ to ‘minage’
06/12/2017 Chaima Mekni Add attribute ‘age’ to Child node in

HotelSearchREQ
Add attribute ‘age’ to Child node in

HotelSearchRES
21/12/2017 Chaima Mekni Add new API

HotelBookingAcknowledge
08/03/2018 Chaima Mekni Add information about age node to
09/03/2018 Chaima Mekni Add new node ‘ExpectedPrice’ to
06/04/2018 Chaima Mekni Add attribute ‘age’ to Child node in
HotelCancellationPolicyREQ
22/10/2018 Malek Bessrour Add attribute ‘IdToken’ to child node In

HotelBookingCreationRQ
22/10/2018 Malek Bessrour Add attribute ‘IdToken’ to child node In
BookingListRQ
22/10/2018 Malek Bessrour Add attribute ‘IdMember’ to child node
in TripBookingListRQ
28/10/2018 Abderraouf Hatmi • HotelSearch: add <source>
05/07/2019 – page 3/56
node to the response envelope

• HotelBookingCreation:
add<source> node to the
request envelope
• HotelDetail: add <source> node
to the request envelope
• HotelCancellationPolicy: add
<source> node to the request
envelope
• HotelBookingCancellation:
add<source> node to the request
envelope
21/03/2019 Sofien Ouelhazi • update API StaticDataRQ()
Add new node rooms.
20/05/2019 Sofien Ouelhazi • update API BookingListRS ()
Add new node PaidAmount.
03/07/2019 Imed Gharsalli • add attribute tolerance to
ExpectedPrice in
HotelBookingCreation API
• update state node with id
attribute in BookingList API
04/07/2019 Abderraouf Hatmi • add API HotelRoomSelection
04/07/2019 Abderraouf Hatmi • update API HotelSearchREQ :
add new nodes to filter results
based on hotels ids :
onlyhotelsids or
excludehotelsids
04/07/2019 Imed Gharsalli • update API HotelSearchREQ :
return mandatory supplements
in <room> when applicable
05/07/2019 – page 4/56
Contents
Contents................................................................................................................................................................ 5
Introduction ....................................................................................................................................................... 6
Authentication & Security .............................................................................................................................. 6
Method POST .................................................................................................................................................... 6
API HotelSearch() ............................................................................................................................................. 8
API StaticDataRQ() .......................................................................................................................................... 28
API TripBookingList()...................................................................................................................................... 43
API CreditCheck() ............................................................................................................................................ 47
API HotelBookingAcknowledge()............................................................................................................... 49
API BookingList () .......................................................................................................................................... 50
API HotelRoomSelection () .......................................................................................................................... 54
05/07/2019 – page 5/56
Introduction
This document describes how to use APIs when accessing CYBERESA Web Services.
It explains the level of security implemented in order to use the APIs.
This document describes also each API, its structure for request and response, which parameters are mandatory and
optional and error management.
Authentication & Security

1- Check Credentials : Login and password sent by user through HTTPS requests
2- Check if host IP is allowed to access to API
Method POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with
actual values.
Request
POST /cr.ws/flight.asmx/WebServiceRQ HTTP/1.1

Host: labs.cyberesa.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length
strRQ=string
Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0"?>
xml
05/07/2019 – page 6/56
WORKFLOW
05/07/2019 – page 7/56
API HotelSearch()
This function is dedicated for hotels search
Request
<HotelSearchREQ>
<Credential>
<Login>?</Login>
<Password>?</Password>
</Credential>
<SearchDetails>
<BookingDetails>
<User>?</User>
<Language>?</Language>
<FromDate>?</FromDate>
<ToDate>?</ToDate>
<IdCity>?</IdCity>
<Rooms>
<Room>
<Pax>
<Adult>?</Adult>
<Child age=”?”>?</Child>
</Pax>
<Boarding>?</Boarding>
</Room>
</Rooms>
</BookingDetails>
<Filters>
<PriceBreakDown>True/False</PriceBreakDown>
<Budget minimum=”?” Maximum=”?”>?</Boarding>
<Keywords>?</Keywords>
<Categories>
<Category>?</Category>
</Categories>
<Sort>
<By>?</By>
</Sort>
<OnlyAvailable>True/False</OnlyAvailable>
<ItemsPerPage>?</ItemsPerPage>
<PageNumber>?</PageNumber>
<Onlyhotelsids>?</Onlyhotelsids>
<Excludehotelsids>?</Excludehotelsids>
</Filters>
</SearchDetails>
</HotelSearchREQ>
05/07/2019 – page 8/56
Root Sub Root Description Values & Tag

Format
Credential Mandatory
Login Login Text
Password Password Text
SearchDetails BookingDetails
BookingDetails :User Current user id Text Mandatory
BookingDetails :Language Cyberesa’s language ID to be used Text Mandatory

to return suitable texts
BookingDetails :FromDate Search start Date dd/mm/yy Mandatory

yy
BookingDetails :ToDate Search end date dd/mm/yy Mandatory

yy
BookingDetails :IdCity Search IdCity Numeric Mandatory
BookingDetails :Rooms :Roo Describe configuration of Mandatory

m :Pax requested pax within the search
BookingDetails :Rooms :Roo Number Of adults for the current Numeric Mandatory
m:Pax :Adult room configuration
BookingDetails :Rooms :Roo Number of children for the current Numeric Mandatory
m:Pax :Child : room configuration
BookingDetails :Rooms :Roo Children ages separated by “-” Text Mandatory for
m:Pax :Child @Age ex: “5” or “5-6” child
BookingDetails :Rooms :Roo Search by specific boarding id Numeric Optional

m:Boarding
Filters
PriceBreakDown Includes pricebreakdown Boolean

information within result
Budget:@minimum Indicate a minimum budget Numeric Optional
05/07/2019 – page 9/56
Budget:@maximum Indicate a maximum budget Numeric Optional
keywords Search by keywords Text Optional
category Search by category Numeric Optional
Sort:by Specify an order by criteria, if not Text Optional

indicated,default orderby price desc
will be applied
onlyAvailable Show only available hotels Boolean Optional
ItemsPerPage Value indicating items to be Numeric Mandatory

returned per page
PageNumber Value indicates the number of the Numeric Mandatory

page to be returned
Onlyhotelsids Return only those hotels ids if Text Optional

exists or available
Excludehotelsids Exclude those hotels ids from Text Optional

results if exists or available
Response
<HotelSearchRES>
<ErrorResult id=’?’>
<message>?</message>
</ErrorResult>
<ToDate>?</ToDate>
<Currency>?</Currency>
<City id=’?’>?</City>
<Destination id=’?’>?</Destination>
<PaginationData currentPage=’?’ TotalPages=’?’ />
<Hotels count=’?’>
<Hotel id=’?’>
<Source>?</Source>
<Title>?</Title>
<PromotionTitle>?</PromotionTitle>
<Category id=>?</Category>
<ThumbImage url=’?’>?</ThumbImage>
<Review id=’?’>
<Note>?</Note>
<Number>?</Number>
05/07/2019 – page 10/56
</Review>
<Localization>
<Longitude>?</Longitude>
<Latitude>?</Latitude>
</Localization>
<Address>?</Address>
<GlobalSupplement>?</ GlobalSupplement >
<Rooms>
<Room id=’?’ Count=’?’>
<Adult>?</Adult>
<Child maxage=’?’ minage=’?’ age=’?’>?</Child>
<Title>?</Title>
<Boardings>
<Boarding id=’?’>
<Title>?</Title>
<Available code=’?’ status=’?’ value=’?’>?</Available>
<Rate currency=?>?</Rate>
</Boarding>
</Boardings>
<Supplement>
<Title>?</Title>
<Rate currency=?>?</Rate>
</Supplement>
<PriceBreakDown>
…
</PriceBreakDown>
</Room>
<GlobalSupplements>
<GlobalSupplement id=’?’>?</GlobalSupplement>
</GlobalSupplements>
</Rooms>
<GlobalSupplement>?</GlobalSupplement>
<CancellationPolicy>
</CancellationPolicy>
</Hotel>
</Hotels>
</HotelSearchRES>
Root Sub Root Description Valeurs Tag

& Format
ErrorResult
ErrorResult:@id Error id Numeric
ErrorResult:message Appropriate message Text
FromDate Search start date dd/mm/yy

yy
05/07/2019 – page 11/56
ToDate Search end date dd/mm/yy

yy
Language Language code Text
Currency Currency code Numeric
City City Name Text
City :@Id City Id Numeric
Destination Destination Name Text
Destination :@Id Destination ID Numeric
PaginationData : Current result page Numeric

@CurrentPage
PagiationData : Total result pages Numeric

@TotalPages
Hotels
Hotels :@count Total count of hotels Numeric
Hotels :Hotel :@Id Current hotel id Numeric
Hotels :Hotel :Source Id of the third-party supplier Numeric Optional

(if exists)
Hotels :Hotel :Title Hotel Name Text
Hotels :Hotel :Promortion Hotel Promotion Title Text

Title
Hotels :Hotel : Hotel category Text

Category
Hotels :Hotel : Hotel Category ID(stars Numeric

Category :@id number)
Hotels :Hotel : Url of hotel’s thumb image Text

ThumbImage :@url
05/07/2019 – page 12/56
Hotels:Hotel: Caption for hotel’s thumb Text

ThumbImage image
Hotels:Hotel: Hotel review note Numeric

Review:Note
Hotels :Hotel : Hotel review number Numeric

Review :Number
Hotels :Hotel : Hotel longitude Numeric

Localization : Longitude
Hotels :Hotel : Hotel Latitude Numeric

Localization : Latitude
Hotels : Hotel :Address Hotel address Text
Hotels :Hotel : Global Supplement for the Numeric

GlobalSupplement current hotel
Rooms
Room:@Id Id of the current available Numeric

room
Room:@Count Count of Total returned rooms Numeric

with the same pax
Room:Adult Adults count for the current

room
Room:Child Child count for the current

room
Room:Child:@minage Child minimaum accepted age Numeric
Room:Child:@maxage Child maximaum accepted age Numeric
Room:Child:@age Children ages separated by “-” Text
Room:Title Room Title Text
Room:PriceBreakDown Price break down information

for the current room
05/07/2019 – page 13/56
Room:Boardings:Boardin Boarding id Boolean

g:@id
Room:Boardings:Boardin Boarding title Numeric

g:Title
Room:Boardings:Boardin Indicates whether the current Text

g:Available boarding is available or not
Room:Boardings:Boardin The Availability code Numeric Possible values :

g:Available:@code
200 or 0 : hotel
available :
210 or 2044 :
minimal stay
overnight is not
respect, 210 by
hotel, 2044 by
boarding
489 : stop sale period
203 : authorized
delay to book an
hotel is not
respected
(retrocession delay)
Other code to
indicate hotel on
request
Room:Boardings:Boardin The Availability status Text Possible values :

g:Available:@status
‘ms’ if @code = 210 or
2044
‘ss’ if @code = 489
05/07/2019 – page 14/56
‘dr’ if @code = 203
Room:Boardings:Boardin The Availability value Text Possible values :

g:Available:@value
minimalStay : if
@code=210 or 2044
authorized FromDate
to start booking : if
@code=203
Room:Boardings:Boardin Currency of the current price Numeric

g:Rate:@currency value
Room:Boardings:Boardin Boarding price for the current Text

g:Rate: room
Room:Supplement:Title Supplement title Text
Room:Supplement:Rate: Currency of the supplement Numeric

@currency price value
Room:Supplement:Rate: Supplement price for the Text

current room
Room:GlobalSupplement Id of the global supplement Numeric

s:GlobalSupplement:@id
Room:GlobalSupplement Value of the global Numeric

s:GlobalSupplement supplement
CancellationPolicy
FromDate This fromDate is the deadline Date

for free cancellation delay,
beyond this, there is a 100%
penalty.
API HotelBookingCreation()
This function is dedicated to create the booking.
05/07/2019 – page 15/56
Request
<HotelBookingCreationREQ>
<Credential>
<Login>?</Login>
</Credential>
<Destination id=’?’>?</Destination>
<User>?</User>
<ToDate>?</ToDate>
<HotelID>?</HotelID>
<IdToken>?</IdToken>
<Source>?</Source>
<Recommandation>?</Recommandation>
<CodePromo>?</CodePromo>
<expectedprice tolerance=’?’>?</expectedprice>
<SelectedRooms>
<SelectedRoom id=’?’>
<Adult>?</Adult>
<Child>?</Child>
<Boarding id=’?’ />
<Customers>
<Customer>
<Civility>?</Civility>
<FirstName>?</FirstName>
<LastName>?</FirstName>
<Age>?</Age>
</Customer>
</Customers>
</SelectedRoom>
…
</SelectedRooms>
<IdAssignedUserPayment></IdAssignedUserPayment>
<Kit>
<PaymentGateway>?</PaymentGateway>
<SecurityCode>?</SecurityCode>
<IdAutorisation>?</IdAutorisation>
<CardType>?</CardType>
<CardBank>?</CardBank>
<BankCountry>?</BankCountry>
<CardNumber>?</CardNumber>
<ClientLastName>?</ClientLastName>
<ClientFirstName>?</ClientFirstName>
<ClientEmail>?</ClientEmail>
</Kit>
<Customer>
<Id>?</Id>
<Email>?</Email>
</Customer>
</HotelBookingCreationREQ>
Root Sub Root Description Valeurs & Tag
05/07/2019 – page 16/56
Format
Login Login Text
City City Title Text Mandatory
City :@id Id City Numeric
Destination Destination Title Text Mandatory
Destination :@id Id Destination Numeric
User Current user ID Numeric Mandatory
Language Cyberesa language code Numeric Mandatory

1 :Frensh
2 :English
Currency Cyberesa’s currency ID to be used to Numeric Mandatory

calculate prices
HotelID The selected hotel id Numeric Mandatory
IdToken A unique Token number, you can Numeric Optional

pass in request in order to verify later
if the booking goes through or not
via calling the BookingList API
CodePromo Code promo to be used when Text Optional

calculating final price
ExpectedPrice Expected price of the booking. If not Numeric Optional

respected than booking creation will
fail
ExpectedPrice How much %pc is tolerated if

: @tolerance ExpectedPrice is different from real
price
Recommandati Client recommandations Text Optional

on
FromDate Search start date dd/mm/yyyy Mandatory
05/07/2019 – page 17/56
ToDate Search end date dd/mm/yyyy Mandatory
SelectedRoom SelectedRooms:Sel Id of the selected room Numeric Mandatory

s ectedRoom:@id
SelectedRooms:Sel Adult count for the current room Numeric Mandatory

ectedRoom:Adult configuration
SelectedRooms:Sel Child count for the current room Numeric Mandatory

ectedRoom:Child configuration
SelectedRooms:Sel Id of the selected boarding Numeric Mandatory

ectedRoom:
Boarding:@id
SelectedRooms:Sel Details of room’s passengers Text Mandatory

ectedRoom:Custo
mers
SelectedRooms: Current passenger civility Text Mandatory

SelectedRoom:Pas
sengers:
Customer:Civility
SelectedRooms: Current passenger first name Text Mandatory

SelectedRoom:Pas
sengers:
Customer:FirstNam
e
SelectedRooms: Current passenger last name Text Mandatory

SelectedRoom:Pas
sengers:
Customer:LastNam
e
SelectedRooms: Current passenger age Numeric Mandatory for child

SelectedRoom:Pas Don’t pass for adult
sengers: Age
IdAssignedUse Current agent : Available only for Numeric Optional

rPayment B2C
Kit Optional
Kit: Payment mode : Available only for Numeric 4 : offline

PaymentGateway B2C 6 : sps
8 : mtc
05/07/2019 – page 18/56
Note : booking status

will be reserved when
you send 4 other case
will be confirmed
Kit:SecutityCode 3DS Boolean 1

0
Kit:IdAutorisation Id of autorisation Text
Kit:CardType Type of card Text
Kit:CardBank Bank of card Text
Kit:BankCountry Country of bank Text
Kit:CardNumber Number of card Text
Kit:ClientLastName Last name of client Text
Kit:ClientFirstName First name of client Text
Kit:ClientEmail Email of client Text
Customer Available only in B2C Optional
Customer:Id Id of customer Numeric
Customer:Email Email of customer Text
Source Id of the third-party supplier (if Numeric Optional

exists)
Response
<HotelBookingCreationRES>
<ErrorResult id=?>
</ErrorResult>
<User>?</User>
<ToDate>?</ToDate>
05/07/2019 – page 19/56
<HotelTitle>?</HotelTitle>
<Category>?</Category>
<OrderDetails id=’?’ idtoken=’?’ password=’?’>
<CancellationPolicies>
<Fee>?</Fee>
</CancellationPolicies>
<NoShowPolicy>
<Fee>?</Fee>
</NoShowPolicy>
<Rooms>
<Room id=’?’>
<Adult>?</Adult>
<Child>?</Child>
<Title>?</Title>
<Boarding id=?>
<Rate>?</Rate>
<Title>?</Title>
</Boarding>
<Passengers>
<Passenger>
<Civility>?</Civility>
<FirstName>?</FirstName>
<LastName>?</LastName>
<Age>?</Age>
<Reduction id=’?’>?</Reduction>
</Passenger>
</Passengers>
</Room>
</Rooms>
<State id=’?’>?</State>
<TotalRate>?</TotalRate>
<GlobalSupplement>?</GlobalSupplement>
</OrderDetails>
</HotelBookingCreationRES>
Racine Sous racine Description Valeurs & Format Tag
ErrorResult Operation State
ErrorResult: Id of current error Numeric

@id
message Appropriate message Text
User Current user ID Numeric
FromDate Search start date dd/mm/yyyy
05/07/2019 – page 20/56
ToDate Search end date dd/mm/yyyy
Language Language code Text
City City Name Text
HotelID :@Id Id of the selected Hotel Numeric
HotelTitle Hotel Name Text
Category Hotel Category Numeric
OderDetails : Id of the order

@id
OderDetails : Id Token of the order Numeric

@idToken
OderDetails : Order password

@password
CancellationPo CancellationPolicies
licies
CancellationPo CancellationPolicy start date dd/mm/yyyy

licies :Cancella
tionPolicy :Fro
mDate
CancellationPo Cancellation Policy fee rate Decimal

licies :Cancella
tionPolicy :Fee
NoShowPolicy NoShow Policy
NoShowPolicy NoShow policy fee rate Decimal

:Fee
Rooms :Room Id of the current selected Numeric

:@id room
Rooms :Room Adult’s count of the current Numeric

:Adult selected room
Rooms :Room Children count of the current Numeric

:Child selected room
05/07/2019 – page 21/56
Rooms :Room Selected Room Title Text

:Title
Rooms :Room Id of the selected boarding Numeric

:Boarding :@id
Rooms :Room Rate of the current selected Numeric

:Boarding :Rat boarding
e
Rooms :Room Selected Boarding Title Text

:Boarding :Title
Rooms :Room One Passenger details for the

:Passengers :P current selected room
assenger
Rooms :Room Civility of the current Text

:Passengers :P passenger
assenger :Civili
ty
Rooms :Room FirstName of the current Text

assenger :First
Name
Rooms :Room LastName of the current Text

assenger :Last
Name
Rooms :Room Age of child passenger Number Optional

:Passengers :P
assenger :Age
Rooms :Room Id of reduction Numeric Optional

:Passengers :P
assenger :
Reduction:@id
Rooms :Room Title of reduction Text Optional

:Passengers :P
assenger :
Reduction
TotalRate Total order rate Numeric
State Order state Text
05/07/2019 – page 22/56
State:@id Id state Numeric 4 : The hotel is available

and your booking is
confirmed, a voucher is
issued
1 : The hotel is available
and your booking is
confirmed as reserved,
no voucher is issued
0 : the hotel is not
available is your booking
is saved as onrequest
GlobalSupplem Global Supplement Numeric

ent
HotelArrivalHo CheckIn Hour Text Optional

ur
HotelDeparture CheckOut Hour Text Optional

Hour
API HotelBookingCancellation()
This function is dedicated to cancel an order already confirmed
Request
<HotelBookingCancellationREQ>
<Credential>
<Login>?</Login>
</Credential>
<User>?</User>
<OrderId>?</OrderId>
<Source>?</Source>
</HotelBookingCancellationREQ>

Format
Login Login Text
05/07/2019 – page 23/56
Language Cyberesa’s language ID to be used Text Mandatory

to return suitable texts
OrderID Id of the order to be deleted Numeric Mandatory
Source Id of the third-party supplier (if exists) Numeric Optional
Response
<HotelBookingCancellationRES>
</ErrorResult>
<ReturnedValue>
<OrderCancelled>?</OrderCancelled>
<IdOrder>?</IdOrder>
<Rate>?</Rate>
</ReturnedValue>
</HotelBookingCancellationRES>
Root Sub Root Description Valeurs & Format Tag
ErrorResult:@id Id of current error Numeric
ReturnedValue Contains information Numeric

about cancellation process
ReturnedValue : Indicates whether Boolean Mandatory if Cancellation

CancellationOrd cancellation is cannot be done because orde
er successfully done or not is not cancellable
ReturnedValue : IdOrder Text

IdOrder
ReturnedValue : Rate returned in a case of Decimal

Rate order cannot be cancelled
05/07/2019 – page 24/56
ReturnedValue : Currency returned in a Numeric

Currency case of order cannot be
cancelled
API HotelCancellationPolicy()
This function is dedicated to return the hotel cancellation policy
<HotelCancellationPolicyREQ>
<Credential>
<Login>?</Login>
</Credential>
<User>?</User>
<ToDate>?</ToDate>
<SelectedRooms>
<SelectedRoom id=’?’>
<Adult>?</Adult>
<Child age=’?’>?</Child>
<Boarding id=’?’ />
</SelectedRoom>
</SelectedRooms>
<Source>?</Source>
</ HotelCancellationPolicyREQ >

Format
Login Login Text
Currency Cyberesa’s currency ID to be used to Numeric Mandatory

calculate prices
Language Cyberesa’s language ID to be Text Mandatory

used to return suitable texts
HotelID The selected hotel id Numeric Mandatory
05/07/2019 – page 25/56
FromDate Search start date dd/mm/yyyy Mandatory
ToDate Search end date dd/mm/yyyy Mandatory
SelectedRoo SelectedRooms:Sele Id of the selected room Numeric Mandatory

ms ctedRoom:@id
SelectedRooms:Sele Adults number for the current room Numeric Mandatory

ctedRoom:Adult configuration
SelectedRooms:Sele Number of children for the current Numeric Mandatory

ctedRoom:child room configuration
SelectedRooms:Sele Children ages separated by “-” Text Mandatory for

ctedRoom:child ex: “5” or “5-6” children
@age
SelectedRooms:Sele Id of the selected boarding Numeric Mandatory

ctedRoom:
Boarding:@id
Source Id of the third-party supplier (if Numeric Optional

exists)
Response
<HotelCancellationPolicyRES>
</ErrorResult>
<CancellationPolicies>
<Fee>?</Fee>
</CancellationPolicies>
<NoShowPolicy>
<Fee>?</Fee>
</NoShowPolicy>
<User>?</User>
</HotelCancellationPolicyRES>
Racine Sous racine Description Valeurs & Format Tag
05/07/2019 – page 26/56
ErrorResult: Id of current error Numeric

@id
User Current user ID Numeric
Cancellation CancellationPolicies
Policies
CancellationPo CancellationPolicy start date dd/mm/yyyy

licy :FromDate
CancellationPo Cancellation Policy fee rate Numeric

licy :Fee
NoShowPolic NoShow Policy

y
Fee NoShow policy fee rate Numeric
05/07/2019 – page 27/56
API StaticDataRQ()
This function is dedicated to get list of currencies, languages, destinations , hotels , categories and
boardings.
Request
<StaticDataRQ gethotelslist=’?’>
<Credential>
<Login>?</Login>
</Credential>
<Ilng>?</Ilng>
<User>?</User>
</StaticDataRQ >

Format
StaticDataRQ Return hotels or no Boolean
:@gethotelslist
Login Login Text
Ilng Id of language Numeric Madatory
Response
<Root>
<Currencies>
<Currency>
<Id>?</Id>
<Title>?</Title>
</Currency>
05/07/2019 – page 28/56
</Currencies>
<Languages>
<Language>
<Id>?</Id>
<Title>?</Title>
</Language>
</Languages>
<Destinations>
<Destination id=’?’>
<Title>?</Title>
<Cities>
<City>
<Id>?</Id>
<Title>?</Title>
</City>
</Cities>
</Destination>
</Destinations>
<Hotels>
<Hotel>
<Id>?</Id>
<Title>?</Title>
<IdCity>?</IdCity>
</Hotel>
</Hotels>
<Categories>
<Category>
<Id>?</Id>
<Title>?</Title>
</Category>
</Categories>
<HotelBoardings>
<HotelBoarding>
<Id>?</Id>
<Priority>?</Priority>
</HotelBoarding>
</HotelBoardings>
<HotelBoardingsL>
<HotelBoardingL>
<IdHotelsBoarding>?</IdHotelsBoarding>
<Title>?</Title>
<SMSTitle>?</SMSTitle>
</HotelBoardingL>
</HotelBoardingsL>
<Boardings>
<Boarding>
<IdHotelBoarding>?</IdHotelBoarding>
<IdHotel>?</IdHotel>
<Title>?</Title>
</Boarding>
</Boardings>
<Rooms>
05/07/2019 – page 29/56
<Room>
<Id>?</Id>
<Title>?</Title>
<Generic>?</Generic>
<MinPax>?</MinPax>
<MaxPax>?</MaxPax>
<MinAdult>?</MinAdult>
<MaxAdult>?</MaxAdult>
<MinChild>?</MinChild>
<MaxChild>?</MaxChild>
<MinInfant>?</MinInfant>
<MaxInfant>?</MaxInfant>
<PricePerPax>?</PricePerPax>
</Room>
</Rooms>
<Options>
<Option id=”?”>?</Option>
</Options>
</Root>
Root Sub Root Description Valeurs & Format Tag
Currencies
Currency : Id Id of Currency Numeric
Currency : Title Title of Currency Text
Languages
Language : Id Id of language Numeric
Language : Title Title of language Text
Destinations
Destination : Id of destination Numeric
@Id
Destination : Title Title of destination Text
Destination : Destination 's cities
05/07/2019 – page 30/56
Cities
Cities : City Selected city
City : Id Id of city Numeric
City : Title Title of City Text
Categories
Category : Id Id of Category Numeric
Category : Title Title of category Text
Hotels Returned only if you

specified gethotelslist =
true in request
Hotel : Id Id of Hotel Numeric
Hotel : Title Title of Hotel Text
Hotel : IdCity Id of city Numeric
HotelBoardings
HotelBoarding : Id of boarding Numeric
ID
HotelBoarding: Priority of boarding Numeric
Priority
HotelBoardingsL Return titles of all

boardings
05/07/2019 – page 31/56
HotelBoardingL: Id of boarding Numeric
IdHotelsBoarding
HotelBoardingL: Id of language Numeric
IdLanguage
HotelBoardingL: Title of boarding Text
Title
HotelBoardingL: SMS Title of boarding Text
SMSTitle
Boardings Return supported

boardings by hotel
Boarding: Id of boarding Numeric
IdHotelBoarding
Boarding : Id of hotel Numeric
IdHotel
Boarding : Title of boarding Text
Title
Rooms Return supported

rooms by hotel
Room : Id Id of room Numeric
Room :Title Title of room Text
Room :Generic Generic (by default) or Boolean (True/False)

Custom
05/07/2019 – page 32/56
Room :MinPax Minimum of Pax Numeric
Room :MaxPax Maximum of Pax Numeric
Room :MinAdult Minimum of adult Numeric
Room :MaxAdult Maximum of adult Numeric
Room :MinChild Minimum of child Numeric
Room :MaxChild Maximum of child Numeric
Room :MinInfant Minimum of Infant Numeric
Room :MaxInfant Maximum of Infant Numeric
Room : Price per pax or per Boolean (True/False)

room
PricePerPax
Options
Options : Options Title of option Text
Option : @id Id of Option Numeric
API HotelDetailRQ()
This function is dedicated to get hotel 's details.
Request
<HotelDetailRQ>
<Credential>
<Login>?</Login>
</Credential>
05/07/2019 – page 33/56
<User>?</User>
<Ilng>?</Ilng>
<WithHotelMap>?</WithHotelMap>
<WithHotelAdvancedDetail>?</WithHotelAdvancedDetail>
<WithHotelSections>?</WithHotelSections>
<WithHotelReviews>?</WithHotelReviews>
<WithHotelImages>?</WithHotelImages>
<WithTravellersReviews>?</WithTravellersReviews>
<Source>?</Source>
</HotelDetailRQ>

Format
Login Login Text
Ilng Id of language Numeric Mandatory
HotelID Id of hotel Numeric Mandatory
WithHotelMap Return hotel map or no Boolean
WithHotelAdvancedDetail Return hotel advanced detail Boolean

or no
WithHotelSections Return hotel sections or no Boolean
WithHotelReviews Return hotel reviews or no Boolean
WithHotelImages Return hotel images or no Boolean
05/07/2019 – page 34/56
WithTravellersReviews Return travellers reviews or Boolean

no
Source Id of the third-party supplier Numeric Optional

(if exists)
Response
<HotelDetailRS>
<Id>?</Id>
<Title>?</Title>
<ShowMap>?</ShowMap>
<ShowRewiew>?</ShowRewiew>
<Destination>?</Destination>
<Category id=’?’>?</Category>
<Summary>?</Summary>
<Description>?</Description>
<ImageUrl>?</ImageUrl>
<PromotionTitle>?</PromotionTitle>
<ShowSection>?</ShowSection>
<ShowImage>?</ShowImage>
<Review count=?>?</Review>
<Address>?</Address>
<Email>?</Email>
<WebSite>?</WebSite>
<Fax>?</Fax>
<Phone>?</Phone>
<SectionList>
<Section id=’?’>?</Section>
</SectionList>
<HotelMap>
<Latitude>?</Latitude>
<Longitude>?</Longitude>
<Zoom>?</Zoom>
</HotelMap>
<HotelAdvancedDetail>
<Reductions>
<Reduction>?</Reduction>
</Reductions>
<Facilities>
<Facility>?</Facility>
</Facilities>
<Rooms>
<Room>?</Room>
</Rooms>
<Options>
<Option id=”?”>?</Option>
</Options>
<Supplements>
05/07/2019 – page 35/56
<Supplement>?</Supplement>
</Supplements>
<Boards>
<Board>?</Board>
</Boards>
<Locations>
<Location>?</Location>
</Locations>
<Themes>
<Theme id=’?’>?</Theme>
</Themes>
</HotelAdvancedDetail>
<HotelReview>
<ReviewSatisfactionCriterias>
<SatisfactionCriterias>
<IdSatisfactionCriteria>?</IdSatisfactionCriteria>
<SatisfactionCriteria>?</SatisfactionCriteria>
<AverageMark>?</AverageMark>
</SatisfactionCriterias>
</ReviewSatisfactionCriterias>
<ReviewTravellerCategories>
<Traveller>
<IdTravellerCategory>?</IdTravellerCategory>
<TravellerCategory>?</TravellerCategory>
<ReviewsNumber>?</ReviewsNumber>
</Traveller>
</ReviewTravellerCategories>
</HotelReview>
<HotelImages>
<Image title=?>?</Image>
</HotelImages>
<TravellersReviews>
<TravellersReview>
<Name>?</Name>
<TravelerCategory id=’?’>?</TravelerCategory >
<ToDate>?</ToDate>
<SubmissionDate>?</SubmissionDate>
<Title>?</Title>
<Comment>?</Comment>
<Criterias>
<Criteria id=’?’ Title=’?’ Value=’?’ />
</Criterias>
</TravellersReview>
</TravellersReviews >
</HotelDetailRS>
Root Sub Root Description Valeurs Tag

&
Format
05/07/2019 – page 36/56
Id Id of hotel Numeric
Title Title of hotel Text
ShowMap Return true if Boolean

latitude and
longitude are
not empty
ShowRewiew Return true if Boolean

number of
reviews > 0
Destination Title of Text

destination
City Title of city Text
City:@id Id of city Numeric
Category Title of Text

category
Category:@id Id of category Numeric
Summary Summary of Text

hotel
Description Description of Text

hotel
ImageUrl Url of main Text

image
PromotionTitle Title of Text

promotion
05/07/2019 – page 37/56
ShowSection Return true if Boolean

hotel has
sections
ShowImage Return true if Boolean

hotel has
images
Review
Review:@Count Count of Numeric

reviews
Adress Adress of hotel Text
Email Email of hotel Text
WebSite WebSite of Text

hotel
Fax Fax of hotel Numeric
Phone Phone of hotel Numeric
SectionList
Section Title of section Text
Section:@id Id of section Numeric
HotelMap Returned only if you

specified WithHotelMap
= true in request
Latitude Latidude Decimal
05/07/2019 – page 38/56
Longitude Longitude Decimal
Zoom Zoom Numeric
HotelAdvancedDetail Reductions Returned only if you

specified
WithHotelAdvancedDetail
= true in request
Reductions : Reduction Description of Text

reduction
Reduction : @id Id of reduction Numeric
Facilities
Facilities: Facility Title of facility Text
Facilitiy: @id Id of facility Numeric
Rooms
Rooms : Room Title of room Text
Room : @id Id of room Numeric
Options
Options : Option Title of option Text
Option :@id Id of option Numeric
Supplements
Supplements : Supplement Title of Text
05/07/2019 – page 39/56
supplement
Supplement : @id Id of Numeric

supplement
Boards
Boards : Board Title of board Text
Board : @id Id of board Numeric
Locations
Locations : Location Title of Text

location
Location : @id Id of location Text
Themes
Themes : Theme Title of theme Text
Theme : @id Id of theme Numeric
HotelReview ReviewSatisfactionCriterias Returned only if you

specified
WithHotelReviews = true
in request
ReviewSatisfactionCriterias :
SatisfactionCriterias
SatisfactionCriterias : Id of Numeric
IdSatisfactionCriteria satisfaction
criteria
05/07/2019 – page 40/56
SatisfactionCriterias : Title of Text

satisfaction
SatisfactionCriteria
criteria
SatisfactionCriterias : AverageMark Average mark Numeric
ReviewTravellerCategories
ReviewTravellerCategories :
Traveller
Traveller : IdTravellerCategory Id of traveller Numeric

category
Traveller : TravellerCategory Title of Text

traveller
category
Traveller : ReviewsNumber Count of Numeric

review
traveller
category
HotelImages Returned only if you

specified
WithHotelImages = true
in request
Image Url of image Text
Image : @Title Title of image Text
TravellersReviews TravellersReview Returned only if you

specified
WithTravellersReviews =
true in request
05/07/2019 – page 41/56
TravellersReview : Name Name of

traveller
TravellersReview : TravelerCategory Title of Text

traveller
category
TravelerCategory : @id Id of traveller Numeric

category
TravellersReview : FromDate Arrival date Date
TravellersReview : ToDate Departure date Date
TravellersReview : SubmissionDate Submission Date

Date
TravellersReview : Title Title of review Text
TravellersReview : Comment Comment Text
TravellersReview : Criterias
Criterias :Criteria
Criteria :@id Id of criteria Numeric
Criteria :@title Title of criteria Text
Criteria :@value Value of Numeric

criteria
05/07/2019 – page 42/56
API TripBookingList()
This function is dedicated to mTrip.com mobile application to get hotels and flight bookings made since
specific date time and filters on the id Member if needed.
Request:
XML Format
<TripBookingListRQ>
<Credential>
<Login>?</Login>
</Credential>
<User>?</User>
<IdMember>?</IdMember>
<Ilng>?<Ilng>
</TripBookingListRQ>
JSON Format
{"TripBookingListRQ":{"Credential":{"Login":"?","Password":"?"},"User":"?",
"Ilng":"?","FromDate":"?"}}
Root Sub root Description Values & Format Tag
Credential
Login String Mandatory

Password String Mandatory
User IdUser on Integer Mandatory
CYBERESA
SYSTEM
IdMember Id Member Integer Optional
Ilng Id of language Numeric Optional
FromDate Retrieve bookings yyyy/mm/dd hh:mm:ss.000 Mandatory

based on creation
datetime
Response:
05/07/2019 – page 43/56
JSON Format
{"TripBookingListRS":{"Bookings":{"Booking":[{"@kind":"accommodation","booking_number":"?","name":
"?","from_date":"?","to_date":"?","adress":"?","picture_url":"?","tyoe_of_room":"?","city":"?","ph
one":"?","email":"?","location":{"latitude":"?","longitude":"?"},"travelers":{"?":[{"name":"?","ty
pe_of_room":"?"},{"name":"?","type_of_room":"?"},{"name":"?","type_of_room":"?"},{"name":"?","type
_of_room":"?"}]}},{"@kind":"transport","reservation_reference":"?","transport_number":"?","class":
?,"departure_date":"?","departure_city":"?","arrival_city":"?","airline_company":"?","departure_ai
rport":"?","departure_airport_iata":"?","arrival_airport":"?","arrival_airport_iata":"?","departur
e_terminal":"?","arrival_terminal":"?","arrival_date":"?","duration":"?","departure_location":{"la
titude":"?","longitude":"?"},"Arrival_location":{"latitude":"?","longitude":"?"},"travelers":{"tra
veler":{"name":" ?","ticket_number":"?"}}}]}}}
05/07/2019 – page 44/56
booking [kind] Details of booking string, possible values
[kind="transport"]
[kind="accommodatio
n"]
[kind="transport"] Details of transport object
reservation_reference Id Airticket on CYBERESA SYSTEM string Mandatory
transport_number The number identifying the transport, e.g. string Mandatory

the flight number for a flight(PNR)
class The transportation mode type string, possible values Mandatory
C,M, Economy With

Restrictions…
departure_date Departure date datetime Mandatory
departure_city The city from where the transport leaves string Mandatory
arrival_city The city to where the transport goes string Optional
airline_company The company operating the transport string Optional
departure_airport The departure airport of a flight or the string Optional

departure station for other transport mode
departure_airport_iata IATA code of the airport String Optional
arrival_airport The arrival airport or the arrival station string Optional

for other transport mode
arrival_airport_iata IATA code of the airport string Optional
departure_terminal The departure terminal string Optional
arrival_terminal The arrival terminal string Optional
arrival_date Arrival date datetime Optional
duration Duration of the trip time Optional
Format: 1h :30m
05/07/2019 – page 45/56
departure_location Departure geo-location location Optional
departure_location > Latitude location Optional

latitude
departure_location > Longitude location Optional

longitude
arrival_location Arrival geo-location location Optional
arrival_location > Latitude location Optional

latitude
arrival_location > Longitude location Optional

longitude
travelers An array of Traveler Details Mandatory
travelers>traveler Details of each traveler Mandatory
travelers>traveler> Traveler’s name string Mandatory

name
travelers>traveler> Traveler’s e-ticket string Mandatory

ticket_number
[kind="accommodation Details of accomodation object

"]
booking_number The booking number for the string Mandatory

accommodation
name Hotel title string Mandatory
from_date Check-in date date Mandatory
to_date Check-out date date Mandatory
location Geo-location of the accommodation location Optional
location > latitude Latitude location Optional
location > longitude Longitude location Optional
address Address of the hotel string Optional
picture_url URL to an image string Optional
05/07/2019 – page 46/56
type_of_room The type of room booked string Optional
city Name of the destination to which the string Mandatory

accommodation should be attached to.
phone Phone number (recommended format: string Optional

+[country code] [phone number])
email Email address string Optional
travelers An array of Traveler Details Mandatory
travelers>traveler Details of each traveler Mandatory
travelers>traveler> traveler’s name string Mandatory

name
travelers>traveler> The type of room booked string Optional

type_of_room
API CreditCheck()
This function is dedicated to get current used and remaining credit (if exists)
Request:
< CreditCheck >

<Credential>
<Login>?</Login>
</Credential>
<User>?</User>
</ CreditCheck >
Credential
Login String Mandatory

Password String Mandatory
User IdUser on CYBERESA Integer Mandatory
SYSTEM
05/07/2019 – page 47/56
Response
<CreditCheck>
<Deposit>?</Deposit>
<ConsumedDeposit>?</ConsumedDeposit>
<RemainingDeposit>?</RemainingDeposit>
<RemainingPercentage>?</RemainingPercentage>
<ConsumedPercentage>?</ConsumedPercentage>
<DateDeposit>?</DateDeposit>
<DaysLeft>?</DaysLeft>
</CreditCheck>
Example
<CreditCheck>
<Deposit>285000 DZD</Deposit>
<ConsumedDeposit>282939 DZD</ConsumedDeposit>
<RemainingDeposit>2061 DZD</RemainingDeposit>
<RemainingPercentage>0.723157894736843</RemainingPercentage>
<ConsumedPercentage>0.992768421052632</ConsumedPercentage>
<DateDeposit>05/04/2016</DateDeposit>
<DaysLeft>2.85542820183856</DaysLeft>
</CreditCheck>
Deposit Total deposit String Mandatory
ConsumedDeposit Deposit consumed String Mandatory

RemainingDeposit Deposit remaining String Mandatory
RemainingPercentage Percentage of remaining Float Mandatory
deposit
ConsumedPercentage Percentage of consumed Float Mandatory

deposit
DateDeposit Date of deposit insertion dd/mm/yyyy Mandatory

DaysLeft Estimate on the expiry Float Mandatory
date of the deposit
05/07/2019 – page 48/56
API HotelBookingAcknowledge()
This function is dedicated to retrieve the response about previous sent booking to a PMS.
Request
<HotelBookingAcknowledgeRQ>
<Credential>
<Login>?</Login>
</Credential>
<User>?</User>
<Ilng>?</Ilng>
<Orders>
<Order>
<Id>?</Id>
<Operation>?</Operation>
<Comments>?</Comments>
</Order>
…
</Orders>
</HotelBookingAcknowledgeRQ>
Login Text
Password Text

Ilng Cyberesa language code Numeric Mandatory
1 :Frensh
2 :English
Orders
Order : Id Id of order Numeric Mandatory
Order : Operation Accepted : 2 Numeric Mandatory
Rejected : 3
Order : Comments Comments of order Text Optional
Response
<HotelBookingAcknowledgeRS>
05/07/2019 – page 49/56
<ErrorResult id='?'>
</ErrorResult>
<Orders>
<Order>
<Id>?</Id>
<Status>?</Status>
<Comments>?</Comments>
</Order>
</Orders>
</HotelBookingAcknowledgeRS>
Orders
Order : Id Id of Order Numeric
Order : Status Status of order Text

(Ok/NOK)
Order : Comments Comment of order in Text

case of NOK
API BookingList ()
This function is dedicated to retrieve the bookings in priority for the given hotel.
Uses idtoken if exist, or idorder if exist or return all bookings starting from lastupdate date.
Request
<BookingListRQ>
<Credential>
<Login>?</Login>
</Credential>
<User>?</User>
<hotel>?</hotel>
<idtoken>?</idtoken>
<idorder>?</idorder>
<lastupdate>?</lastupdate>
05/07/2019 – page 50/56
</BookingListRQ>
Login Text
Password Text
User Current user ID Numeric Optional

hotel Hotel Id Numeric Optional
idtoken Token Id Optional
idorder Id of order Numeric Optional
lastupdate From date date Optional
Response
<BookingListRS>
</ErrorResult>
<bookings>
<booking>
<id>?</id>
<totalnetRate>?</totalnetRate>
<totalPaidAmount>?</totalPaidAmount>
<idaffiliate>?</idaffiliate>
<city>?</city>
<hoteltitle> ?</hoteltitle>
<fromdate> ?</fromdate>
<todate> ?</todate>
<remarks> ?</remarks>
<lastupdate> ?</lastupdate>
<state id="?"> ?</state>
<rooms>
<room>
<type> ?</type>
<boarding> ?</boarding>
<netRate> ?</netRate>
<Supplements/>
<customers>
<customer>
<name> ?</name>
<reductions> ?</reductions>
<kind> ?</kind>
</customer>
</room>
05/07/2019 – page 51/56
</rooms>
</booking>
</bookings>
<Started>
</Started>
<ResponseTime>
</ResponseTime>
<BookingListRS>
bookings
totalnetRate
totalPaidAmount paid amount (added Numeric

when state is reserved
and booking is paid
online)
idaffiliate Id Affiliate Numeric
city Hotel city location text
hoteltitle Title text
fromdate Date reservation from Date
todate Date reservation to Date
remarks Remarks Text
lastupdate Last update date Date
state State of the reservation Text
State : @id Id of the state of the Numeric 4 : The

reservation hotel is
available
and your
booking is
confirmed,
05/07/2019 – page 52/56
a voucher is
issued
1 : The
hotel is
available
and your
booking is
confirmed
as
reserved,
no voucher
is issued
0 : the
hotel is not
available is
your
booking is
saved as
onrequest
2 : the
booking is
cancelled
rooms
type Type room Numeric
boarding Boarding room Numeric
netRate Net rate per room Numeric
customers
name Customer Name Text
reductions Reduction Numeric
kind kind text
05/07/2019 – page 53/56
API HotelRoomSelection ()
This function is dedicated for hotel Room Selection and return all applicable rooms definitions,
boardings, supplements, globalsupplements…
Request
<HotelRoomSelectionRQ>
<Credential>
<Login>?</Login>
</Credential>
<User>?</User>
<Curr>?</Curr>
<HotelId>?</HotelId>
<ToDate>?</ToDate>
</HotelRoomSelectionRQ>
Login Text
Password Text
User ID User Numeric Mandatory

Curr ID Currency Numeric Mandatory
Language ID Language Numeric Mandatory
HotelId ID Hotel Numeric Mandatory

FromDate From Date date Mandatory
ToDate To date date Mandatory
Response
<HotelRoomSelectionRS>
</ErrorResult>
<rooms>
<room minAd='?' maxAd='?' minChild='?' maxChild='?'>
<id >?</id>
05/07/2019 – page 54/56
<title>?</title>
<price>?</price>
<boardings>
<boarding id='?' title='?' price='?' ></boarding>
</boardings>
<Supplements>
<Supplement id='?' title='?' price='?' Mandatory='?'
PerNight='?'PerPax='?'></Supplement>
</Supplements>
<GlobalSupplements>
<GlobalSupplement id='?' title='?' price='?' Mandatory='?'
PerNight='?'PerPax='?'></GlobalSupplement>
</GlobalSupplements>
</room>
</rooms>
<HotelRoomSelectionRS>
Root Sub root Description Values & Tag

Format
message Appropriate Text

message
rooms
room:Id Id of room Numeric
room:@minAd Min Adult Numeric
room:@maxAd Max Adult Numeric
room:@minChild Min Child Numeric
room:@maxChild Max Child Numeric
room:title Title of Room Text
room:price Price Of Room Numeric
room:boardings:boarding Id of Bording Numeric

@Id
room:boardings:boarding title of Bording Text

@Title
05/07/2019 – page 55/56
room:boardings:boarding price of Bording Numeric

@Price
room: Supplements: Id of Supplement Numeric

Supplement@Id
room: Supplements: title of Text

Supplement@Title Supplement
room: Supplements: price of Numeric

Supplement@Price Supplement
room: Supplements: Is Mandatory Boolean

Supplement@Mandatory Supplement
room: Supplements: Is Per Night Boolean

Supplement@PerNight Supplement
room: Supplements: Is Per Pax Boolean

Supplement@PerPax Supplement
room: GlobalSupplements: Id of Global Numeric

GlobalSupplement@Id Supplement
room: Supplements: title of Global Text

Supplement@Title Supplement
room: GlobalSupplements: price of Global Numeric

GlobalSupplement @Price Supplement
room: GlobalSupplements: Is Mandatory Boolean

GlobalSupplement Global
@Mandatory Supplement
room: GlobalSupplements: Is Per Night Boolean

GlobalSupplement Global
@PerNight Supplement
room: Is Per Pax Global Boolean

GlobalSupplements: Supplement
GlobalSupplement@PerPax
05/07/2019 – page 56/56

CyberesaWS Hotel 8.0.5

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

CyberesaWS Hotel 8.0.5

Uploaded by

Copyright:

Available Formats

Solutions e-tourisme

CYBERESA Web Services

Company Cyberesa Sarl

Revision History Control

Date Author Actions

3.Add node Options to SaticData API

4. Add node Options to HotelDetail API

Delete nodes PaymentMode, Kit:Status,

06/12/2017 Chaima Mekni Add attribute ‘age’ to Child node in

Add attribute ‘age’ to Child node in

21/12/2017 Chaima Mekni Add new API

22/10/2018 Malek Bessrour Add attribute ‘IdToken’ to child node In

node to the response envelope

It explains the level of security implemented in order to use the APIs.

Authentication & Security

POST /cr.ws/flight.asmx/WebServiceRQ HTTP/1.1

Root Sub Root Description Values & Tag

Login Login Text

Password Password Text

BookingDetails :User Current user id Text Mandatory

BookingDetails :Language Cyberesa’s language ID to be used Text Mandatory

BookingDetails :FromDate Search start Date dd/mm/yy Mandatory

BookingDetails :ToDate Search end date dd/mm/yy Mandatory

BookingDetails :IdCity Search IdCity Numeric Mandatory

BookingDetails :Rooms :Roo Describe configuration of Mandatory

BookingDetails :Rooms :Roo Search by specific boarding id Numeric Optional

PriceBreakDown Includes pricebreakdown Boolean

Budget:@minimum Indicate a minimum budget Numeric Optional

Budget:@maximum Indicate a maximum budget Numeric Optional

keywords Search by keywords Text Optional

category Search by category Numeric Optional

Sort:by Specify an order by criteria, if not Text Optional

onlyAvailable Show only available hotels Boolean Optional

ItemsPerPage Value indicating items to be Numeric Mandatory

PageNumber Value indicates the number of the Numeric Mandatory

Onlyhotelsids Return only those hotels ids if Text Optional

Excludehotelsids Exclude those hotels ids from Text Optional

Root Sub Root Description Valeurs Tag

ErrorResult:@id Error id Numeric

ErrorResult:message Appropriate message Text

FromDate Search start date dd/mm/yy

ToDate Search end date dd/mm/yy

Language Language code Text

Currency Currency code Numeric

City City Name Text

City :@Id City Id Numeric

Destination Destination Name Text

Destination :@Id Destination ID Numeric

PaginationData : Current result page Numeric

PagiationData : Total result pages Numeric

Hotels :@count Total count of hotels Numeric

Hotels :Hotel :@Id Current hotel id Numeric

Hotels :Hotel :Source Id of the third-party supplier Numeric Optional

Hotels :Hotel :Title Hotel Name Text

Hotels :Hotel :Promortion Hotel Promotion Title Text

Hotels :Hotel : Hotel category Text

Hotels :Hotel : Hotel Category ID(stars Numeric

Hotels :Hotel : Url of hotel’s thumb image Text

Hotels:Hotel: Caption for hotel’s thumb Text

Hotels:Hotel: Hotel review note Numeric

Hotels :Hotel : Hotel review number Numeric

Hotels :Hotel : Hotel longitude Numeric