CyberesaWS Hotel 10.0.0

Solutions e-tourisme
CYBERESA Web Services

Technical Specifications - Hotel Pack
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
04/03/2020 – page 1/49
Document Control
Company Cyberesa Sarl

Department API Consulting & Services
Author Dev Team
Version 10.0.0 beta 1
Date 04/03/2020
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
3.Add node Options to SaticData API
4. Add node Options to HotelDetail API

08/06/2016 Chaima Mekni Add node Summary to HotelDetailRS
04/03/2020 – page 2/49
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> node to
the response envelope
• HotelBookingCreation: add<source>
node to the request envelope
• HotelDetail: add <source> node to the
request envelope
04/03/2020 – page 3/49
• 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: hotels_ids or
exclude_hotels_ids
04/07/2019 Imed Gharsalli • update API HotelSearchREQ: return
mandatory supplements in <room>
when applicable
09/10/2019 Mohamed Ali • update BookingList() and
Mejri HotelBookingCreation() APIs
parameters descriptions
25/12/2019 Akrem Rouis • Add new node <NonRefundable> to
HotelSearch() and
HotelCancellationPolicy() APIs
13/01/2020 Achraf Bouanani • Updated StaticDataRQ() API added
new nodes in <hotel>
04/01/2020 Sofiene Ouelhazi • Updated HotelBookingCreationREQ()

add new nodes in <PaymentDetails>
• Updated HotelBookingCreationRES()
add new nodes in <PaymentDetails>
04/03/2020 – page 4/49
Introduction ......................................................................................................................................................... 6
Authentication & Security ............................................................................................................................... 6
Method POST ...................................................................................................................................................... 6
WORKFLOW ........................................................................................................................................................ 7
API HotelSearch()............................................................................................................................................... 8
API HotelBookingCreation()..........................................................................................................................14
API HotelBookingCancellation() ..................................................................................................................22
API HotelCancellationPolicy() ......................................................................................................................23
API StaticDataRQ() ..........................................................................................................................................26
API HotelDetailRQ() .........................................................................................................................................31
API TripBookingList() .....................................................................................................................................38
API CreditCheck() ............................................................................................................................................41
API HotelBookingAcknowledge() ................................................................................................................43
API BookingList() .............................................................................................................................................44
API HotelRoomSelection() .............................................................................................................................47
04/03/2020 – page 5/49
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
04/03/2020 – page 6/49
WORKFLOW
04/03/2020 – page 7/49
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>2</Adult>
<Child age=””>0</Child>
</Pax>
<Boarding>?</Boarding>
</Room>
<Room>
<Pax>
<Adult>1</Adult>
<Child age=”8-10”>2</Child>
</Pax>
</Room>
<Room>
<Pax>
<Adult>2</Adult>
<Child age=”9”>1</Child>
</Pax>
</Room>
</Rooms>
</BookingDetails>
<Filters>
<Budget minimum=”?” Maximum=”?”>?</Boarding>
<Keywords>?</Keywords>
<Categories>
<Category>?</Category>
</Categories>
<Sort>
<By>?</By>
</Sort>
<OnlyAvailable>True/False</OnlyAvailable>
<ItemsPerPage>?</ItemsPerPage>
04/03/2020 – page 8/49
<PageNumber>?</PageNumber>
<hotels_ids>?</hotels_ids>
<exclude_hotels_ids>?</exclude_hotels_ids>
</Filters>
</SearchDetails>
</HotelSearchREQ>
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 to return Text Mandatory

suitable texts
BookingDetails :FromDate Search start Date dd/mm/yyyy Mandatory
BookingDetails :ToDate Search end date dd/mm/yyyy Mandatory
BookingDetails :IdCity Search IdCity Numeric Mandatory
BookingDetails :Rooms :Room :Pax Describe configuration of requested pax within Mandatory
the search
BookingDetails :Rooms :Room:Pax : Number Of adults for the current room Numeric Mandatory
Adult configuration
BookingDetails :Rooms :Room:Pax : Number of children for the current room Numeric Mandatory
Child : configuration
BookingDetails :Rooms :Room:Pax : Children ages separated by “-” Text Mandatory for child
Child @Age ex: “5” or “5-6”
BookingDetails :Rooms :Room:Boardi Search by specific boarding id Numeric Optional

ng
Filters
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 (City or Category or Title or Text Optional

Review or Priority or Nearby), if not indicated,
04/03/2020 – page 9/49
default order by Priority ascendant will be

applied
onlyAvailable Show only available hotels Boolean Optional
ItemsPerPage Value indicating items to be returned per page Numeric Mandatory
PageNumber Value indicates the number of the page to be Numeric Mandatory

returned
hotels_ids Return only those hotels ids if exists or available Text Optional
exclude_hotels_ids Exclude those hotels ids from results if exists or Text Optional
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>
</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>
04/03/2020 – page 10/49
<Available code=’?’ status=’?’ value=’?’>?</Available>

<Rate currency=?>?</Rate>
<NonRefundable>?</NonRefundable>
</Boarding>
</Boardings>
<Supplement>
<Title>?</Title>
<Rate currency=?>?</Rate>
</Supplement>
</Room>
<GlobalSupplements>
<GlobalSupplement id=’?’>?</GlobalSupplement>
</GlobalSupplements>
</Rooms>
<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/yyyy
ToDate Search end date dd/mm/yyyy
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 :@Cur Current result page Numeric

rentPage
PagiationData : Total result pages Numeric

@TotalPages
Hotels
Hotels :@count Total count of hotels Numeric
04/03/2020 – page 11/49
Hotels :Hotel :@Id Current hotel id Numeric
Hotels :Hotel :Source Id of the third-party supplier (if exists) Numeric Optional
Hotels :Hotel :Title Hotel Name Text
Hotels :Hotel :PromortionTitle Hotel Promotion Title Text
Hotels :Hotel : Hotel category Text

Category
Hotels :Hotel : Hotel Category ID(stars number) Numeric

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

ThumbImage :@url
Hotels:Hotel: Caption for hotel’s thumb image Text

ThumbImage
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 current hotel Numeric

GlobalSupplement
Rooms
Room:@Id Id of the current available room Numeric
Room:@Count Count of Total returned rooms with the Numeric

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
04/03/2020 – page 12/49
Room:Boardings:Boarding:@id Boarding id Boolean
Room:Boardings:Boarding:Title Boarding title Numeric
Room:Boardings:Boarding:Avai Indicates whether the current boarding is Text

lable available or not
Room:Boardings:Boarding:Avai The Availability code Numeric Possible values :

lable:@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:Boarding:Avai The Availability status Text Possible values :

lable:@status
‘ms’ if @code = 210 or 2044
‘ss’ if @code = 489
‘dr’ if @code = 203
Room:Boardings:Boarding:Avai The Availability value Text Possible values :

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

e:@currency
Room:Boardings:Boarding:Rat Boarding price for the current room Text

e:
Room: Boardings:Boarding: Indicate if offer is non refundable Bool

NonRefundable
Room:Supplement:Title Supplement title Text
Room:Supplement:Rate:@curr Currency of the supplement price value Numeric

ency
04/03/2020 – page 13/49
Room:Supplement:Rate: Supplement price for the current room Text
Room:GlobalSupplements:Glo Id of the global supplement Numeric

balSupplement:@id
Room:GlobalSupplements:Glo Value of the global supplement Numeric

balSupplement
CancellationPolicy
FromDate This fromDate is the deadline for free can- Date

cellation delay, beyond this, there is a
100% penalty.
API HotelBookingCreation()
This function is dedicated to create the booking.
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>
<SelectedRoom id=’1’>
<Adult>2</Adult>
<Child>0</Child>
<Boarding id=’?’ />
<Customers>
<Customer>
<Civility>?</Civility>
<FirstName>?</FirstName>
<LastName>?</FirstName>
<Age></Age>
</Customer>
<Customer>
<Age></Age>
</Customer>
</Customers>
04/03/2020 – page 14/49
</SelectedRoom>
<Adult>1</Adult>
<Child>0</Child>
<Customers>
<Customer>
<Age></Age>
</Customer>
</Customers>
</SelectedRoom>
<Adult>1</Adult>
<Child>2</Child>
<Customers>
<Customer>
<Age></Age>
</Customer>
<Customer>
<Age>3</Age>
</Customer>
<Customer>
<Age>6</Age>
</Customer>
</Customers>
</SelectedRoom>
<Adult>2</Adult>
<Child>2</Child>
<Customers>
<Customer>
<Age></Age>
</Customer>
<Customer>
<Age></Age>
</Customer>
<Customer>
<Age>4</Age>
04/03/2020 – page 15/49
</Customer>
<Customer>
<Age>7</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>
<PaymentDetails>
<Name></Name>
<CardNumber></CardNumber>
<CVC></CVC>
<ExpiryDate></ ExpiryDate >
</PaymentDetails>
<Customer>
<Id>?</Id>
<Email>?</Email>
</Customer>
</HotelBookingCreationREQ>
Root Sub Root Description Valeurs & Format Tag
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: French
2: English
04/03/2020 – page 16/49
Currency Cyberesa’s currency ID to be used to calculate Numeric Mandatory

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

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 calculating final Text Optional

price
ExpectedPrice Expected price of the booking. If not respected Numeric Optional

than booking creation will fail
ExpectedPrice : How much %pc is tolerated if ExpectedPrice is Numeric Optional

@tolerance different from real price "0" or "1" or …
Recommandation Client recommandations Text Optional
FromDate Search start date dd/mm/yyyy Mandatory
ToDate Search end date dd/mm/yyyy Mandatory
SelectedRooms SelectedRooms:Selecte Id of the selected room Numeric Mandatory

dRoom:@id
SelectedRooms:Selecte Adult count for the current room configuration Numeric Mandatory
dRoom:Adult
SelectedRooms:Selecte Child count for the current room configuration Numeric Mandatory
dRoom:Child
SelectedRooms:Selecte Id of the selected boarding Numeric Mandatory

dRoom: Boarding:@id
SelectedRooms:Selecte Details of room’s passengers Text Mandatory

dRoom:Customers
SelectedRooms: Current passenger civility Text Mandatory

SelectedRoom:Passeng Possible values : Mr or Mrs or Ms
ers: Customer:Civility
SelectedRooms: Current passenger first name Text Mandatory

SelectedRoom:Passeng
ers:
Customer:FirstName
SelectedRooms: Current passenger last name Text Mandatory

SelectedRoom:Passeng
ers:
Customer:LastName
SelectedRooms: Child age (only for children, DO NOT PASS for Numeric Mandatory for children
SelectedRoom:Passeng adults !!!) DO NOT PASS
ers: Age for adults !!!
04/03/2020 – page 17/49
IdAssignedUserPa Current agent: Available only for B2C Numeric Optional

yment
Kit Optional
Kit: PaymentGateway Payment mode : Available only for B2C Numeric 4 : offline
6 : sps
8 : mtc
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
PaymentDetails
PaymentDetails: Name Name of payment card owner Text Mandatory if

PaymentDetails node exist
PaymentDetails: Card Number of the bank card Text Mandatory if

CardNumber PaymentDetails node exist
PaymentDetails: CVC CVC code Text Optional if PaymentDetails

node exist
PaymentDetails: Card expiration date in AAAAMM format. Text: AAAAMM Mandatory if

ExpirationDate Example: PaymentDetails node exist
202012
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 exists) Numeric Optional
04/03/2020 – page 18/49
Response
<HotelBookingCreationRES>
<ErrorResult id=?>
</ErrorResult>
<User>?</User>
<ToDate>?</ToDate>
<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>
<LastName>?</LastName>
<Age>?</Age>
<Reduction id=’?’>?</Reduction>
</Passenger>
</Passengers>
</Room>
</Rooms>
<State id=’?’>?</State>
<TotalRate>?</TotalRate>
</OrderDetails>
<PaymentDetails>
<TransactionId>?</TransactionId>
<AuthorizationId>?</AuthorizationId>
</PaymentDetails>
</HotelBookingCreationRES>
04/03/2020 – page 19/49
Racine Sous racine Description Valeurs & Format Tag
ErrorResult Operation State
ErrorResult:@id Id of current error Numeric
message Appropriate message Text
User Current user ID Numeric
FromDate Search start date dd/mm/yyyy
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 :@i Id of the order

d
OderDetails :@i Id Token of the order Numeric

dToken
OderDetails :@p Order password

assword
CancellationPolicie CancellationPolicies
s
CancellationPolicie CancellationPolicy start date dd/mm/yyyy

s :CancellationPoli
cy :FromDate
CancellationPolicie Cancellation Policy fee rate Decimal

s :CancellationPoli
cy :Fee
NoShowPolicy NoShow Policy
NoShowPolicy :Fe NoShow policy fee rate Decimal

e
Rooms :Room :@i Id of the current selected room Numeric

d
Rooms :Room :Ad Adult’s count of the current selected Numeric

ult room
Rooms :Room :Chi Children count of the current Numeric

ld selected room
04/03/2020 – page 20/49
Rooms :Room :Titl Selected Room Title Text

e
Rooms :Room :Bo Id of the selected boarding Numeric

arding :@id
Rooms :Room :Bo Rate of the current selected Numeric

arding :Rate boarding
Rooms :Room :Bo Selected Boarding Title Text

arding :Title
Rooms :Room :Pa One Passenger details for the

ssengers :Passeng current selected room
er
Rooms :Room :Pa Civility of the current passenger Text

ssengers :Passeng
er :Civility
Rooms :Room :Pa FirstName of the current passenger Text

ssengers :Passeng
er :FirstName
Rooms :Room :Pa LastName of the current passenger Text

ssengers :Passeng
er :LastName
Rooms :Room :Pa Age of child passenger Number Optional

ssengers :Passeng
er :Age
Rooms :Room :Pa Id of reduction Numeric Optional

ssengers :Passeng
er : Reduction:@id
Rooms :Room :Pa Title of reduction Text Optional

ssengers :Passeng
er : Reduction
TotalRate Total order rate Numeric
State Order state Text
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
PaymentDetails
PaymentDetails: Payment Transaction Id number Numeric Payment Transaction number (if

TransactionId paid by bank card)
04/03/2020 – page 21/49
PaymentDetails: Payment Authorization code Numeric Payment Authorization code (if paid
AuthorizationId by bank card)
GlobalSupplement Global Supplement Numeric
HotelArrivalHour CheckIn Hour Text Optional
HotelDepartureHou CheckOut Hour Text Optional

r
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>
Login Login Text
Language Cyberesa’s language ID to be used to return Text Mandatory

suitable texts
OrderID Id of the order to be deleted Numeric Mandatory
Response
<HotelBookingCancellationRES>
</ErrorResult>
<ReturnedValue>
<OrderCancelled>?</OrderCancelled>
04/03/2020 – page 22/49
<IdOrder>?</IdOrder>
<Rate>?</Rate>
</ReturnedValue>
</HotelBookingCancellationRES>
ReturnedValue Contains information about Numeric

cancellation process
ReturnedValue :Can Indicates whether cancellation is Boolean Mandatory if Cancellation cannot

cellationOrder successfully done or not be done because orde is not
cancellable
ReturnedValue :IdOr IdOrder Text

der
ReturnedValue :Rat Rate returned in a case of order Decimal

e cannot be cancelled
ReturnedValue :Curr Currency returned in a case of Numeric

ency 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>
<Adult>1</Adult>
<Child age=’9’>1</Child>
</SelectedRoom>
<Adult>1</Adult>
<Child>0</Child>
04/03/2020 – page 23/49

</SelectedRoom>
<Adult>1</Adult>
<Child age=’10-12’>2</Child>
</SelectedRoom>
</SelectedRooms>
<Source>?</Source>
</ HotelCancellationPolicyREQ >
Login Login Text
Currency Cyberesa’s currency ID to be used to calculate Numeric Mandatory

prices
Language Cyberesa’s language ID to be used to return Text Mandatory

suitable texts
HotelID The selected hotel id Numeric Mandatory
FromDate Search start date dd/mm/yyyy Mandatory
ToDate Search end date dd/mm/yyyy Mandatory
SelectedRooms SelectedRooms:Selected Id of the selected room Numeric Mandatory

Room:@id
SelectedRooms:Selected Adults number for the current room Numeric Mandatory

Room:Adult configuration
SelectedRooms:Selected Number of children for the current room Numeric Mandatory

Room:child configuration
SelectedRooms:Selected Children ages separated by “-” Text Mandatory for children

Room:child ex: “5” or “5-6”
@age
SelectedRooms:Selected Id of the selected boarding Numeric Mandatory

Room: Boarding:@id
Response
<HotelCancellationPolicyRES>
04/03/2020 – page 24/49
</ErrorResult>
<User>?</User>
<NonRefundable>?</NonRefundable>
<CancellationPolicies>
<Fee>?</Fee>
</CancellationPolicies>
<NoShowPolicy>
<Fee>?</Fee>
</NoShowPolicy>
</HotelCancellationPolicyRES>
Racine Sous racine Description Valeurs & Format Tag
User Current user ID Numeric
NonRefundable Indicate if offer is non Bool

refundable
CancellationPolicies CancellationPolicies
CancellationPolicy :Fro CancellationPolicy dd/mm/yyyy

mDate start date
CancellationPolicy :Fee Cancellation Policy Numeric

fee rate
NoShowPolicy NoShow Policy
Fee NoShow policy fee Numeric

rate
04/03/2020 – page 25/49
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 >
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>
</Currencies>
<Languages>
<Language>
<Id>?</Id>
<Title>?</Title>
</Language>
</Languages>
<Destinations>
04/03/2020 – page 26/49
<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>
<Room>
<Id>?</Id>
<Title>?</Title>
<Generic>?</Generic>
<MinPax>?</MinPax>
<MaxPax>?</MaxPax>
04/03/2020 – page 27/49
<MinAdult>?</MinAdult>
<MaxAdult>?</MaxAdult>
<MinChild>?</MinChild>
<MaxChild>?</MaxChild>
<MinInfant>?</MinInfant>
<MaxInfant>?</MaxInfant>
<PricePerPax>?</PricePerPax>
</Room>
</Rooms>
<Options>
<Option id=”?”>?</Option>
</Options>
</Root>
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

Cities
Cities : City Selected city
City : Id Id of city Numeric
City : Title Title of City Text
Categories
04/03/2020 – page 28/49
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
Hotel : Address Address of the hotel Text
Hotel : Longitude Longitude of the hotel Numeric
Hotel : Latitude Latitude of the hotel Numeric
HotelBoardings
HotelBoarding : Id of boarding Numeric
ID
HotelBoarding: Priority of boarding Numeric
Priority
HotelBoardingsL Return titles of all boardings
HotelBoardingL: Id of boarding Numeric
IdHotelsBoarding
HotelBoardingL: Id of language Numeric
IdLanguage
HotelBoardingL: Title of boarding Text
Title
04/03/2020 – page 29/49
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 Custom Boolean (True/False)
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
04/03/2020 – page 30/49
Room : Price per pax or per room Boolean (True/False)
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>
<User>?</User>
<Ilng>?</Ilng>
<WithHotelMap>?</WithHotelMap>
<WithHotelAdvancedDetail>?</WithHotelAdvancedDetail>
<WithHotelSections>?</WithHotelSections>
<WithHotelReviews>?</WithHotelReviews>
<WithHotelImages>?</WithHotelImages>
<WithTravellersReviews>?</WithTravellersReviews>
<Source>?</Source>
</HotelDetailRQ>
Login Login Text
Ilng Id of language Numeric Mandatory
04/03/2020 – page 31/49
HotelID Id of hotel Numeric Mandatory
WithHotelMap Return hotel map or no Boolean
WithHotelAdvancedDetail Return hotel advanced detail or no Boolean
WithHotelSections Return hotel sections or no Boolean
WithHotelReviews Return hotel reviews or no Boolean
WithHotelImages Return hotel images or no Boolean
WithTravellersReviews Return travellers reviews or no Boolean
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>
<Email>?</Email>
<WebSite>?</WebSite>
<Fax>?</Fax>
<Phone>?</Phone>
<SectionList>
<Section id=’?’>?</Section>
</SectionList>
<HotelMap>
<Zoom>?</Zoom>
</HotelMap>
04/03/2020 – page 32/49
<HotelAdvancedDetail>
<Reductions>
<Reduction>?</Reduction>
</Reductions>
<Facilities>
<Facility>?</Facility>
</Facilities>
<Rooms>
<Room>?</Room>
</Rooms>
<Options>
<Option id=”?”>?</Option>
</Options>
<Supplements>
<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>
04/03/2020 – page 33/49
<Comment>?</Comment>
<Criterias>
<Criteria id=’?’ Title=’?’ Value=’?’ />
</Criterias>
</TravellersReview>
</TravellersReviews >
</HotelDetailRS>
Root Sub Root Description Valeurs & Tag

Format
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 destination Text
City Title of city Text
City:@id Id of city Numeric
Category Title of category Text
Category:@id Id of category Numeric
Summary Summary of hotel Text
Description Description of Text

hotel
ImageUrl Url of main image Text
PromotionTitle Title of promotion Text
ShowSection Return true if hotel Boolean

has sections
04/03/2020 – page 34/49
ShowImage Return true if hotel Boolean

has images
Review
Review:@Count Count of reviews Numeric
Adress Adress of hotel Text
Email Email of hotel Text
WebSite WebSite of hotel Text
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
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
04/03/2020 – page 35/49
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 supplement Text
Supplement : @id Id of supplement Numeric
Boards
Boards : Board Title of board Text
Board : @id Id of board Numeric
Locations
Locations : Location Title of location Text
Location : @id Id of location Text
Themes
Themes : Theme Title of theme Text
04/03/2020 – page 36/49
Theme : @id Id of theme Numeric
HotelReview ReviewSatisfactionCriterias Returned only if you specified

WithHotelReviews = true in
request
ReviewSatisfactionCriterias :
SatisfactionCriterias
SatisfactionCriterias : IdSatisfactionCriteria Id of satisfaction Numeric

criteria
SatisfactionCriterias : Title of satisfaction Text

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

category
Traveller : TravellerCategory Title of traveller Text

category
Traveller : ReviewsNumber Count of review Numeric

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
04/03/2020 – page 37/49
TravellersReview : Name Name of traveller
TravellersReview : TravelerCategory Title of traveller Text

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 criteria Numeric
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>
04/03/2020 – page 38/49
<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 CYBERESA Integer Mandatory

SYSTEM
IdMember Id Member Integer Optional
Ilng Id of language Numeric Optional
FromDate Retrieve bookings based yyyy/mm/dd hh:mm:ss.000 Mandatory

on creation datetime
Response:
JSON Format
{"TripBookingListRS":{"Bookings":{"Booking":[{"@kind":"accommodation","booking_number":"?","name":"?","from_date":"?"
,"to_date":"?","adress":"?","picture_url":"?","tyoe_of_room":"?","city":"?","phone":"?","email":"?","location":{"latitude":"?","lon
gitude":"?"},"travelers":{"?":[{"name":"?","type_of_room":"?"},{"name":"?","type_of_room":"?"},{"name":"?","type_of_room":"?
"},{"name":"?","type_of_room":"?"}]}},{"@kind":"transport","reservation_reference":"?","transport_number":"?","class":?,"dep
arture_date":"?","departure_city":"?","arrival_city":"?","airline_company":"?","departure_airport":"?","departure_airport_iata"
:"?","arrival_airport":"?","arrival_airport_iata":"?","departure_terminal":"?","arrival_terminal":"?","arrival_date":"?","duration":"
?","departure_location":{"latitude":"?","longitude":"?"},"Arrival_location":{"latitude":"?","longitude":"?"},"travelers":{"traveler":{
"name":" ?","ticket_number":"?"}}}]}}}
04/03/2020 – page 39/49
booking [kind] Details of booking string, possible values
[kind="transport"]
[kind="accommodation"]
[kind="transport"] Details of transport object
reservation_reference Id Airticket on CYBERESA SYSTEM string Mandatory
transport_number The number identifying the transport, e.g. the flight string Mandatory
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 departure string Optional

station for other transport mode
departure_airport_iata IATA code of the airport String Optional
arrival_airport The arrival airport or the arrival station for other string Optional
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
departure_location Departure geo-location location Optional
departure_location > latitude Latitude location Optional
departure_location > Longitude location Optional

longitude
arrival_location Arrival geo-location location Optional
arrival_location > latitude Latitude location Optional
04/03/2020 – page 40/49
arrival_location > longitude Longitude location Optional
travelers An array of Traveler Details Mandatory
travelers>traveler Details of each traveler Mandatory
travelers>traveler> name Traveler’s name string Mandatory
travelers>traveler> Traveler’s e-ticket string Mandatory

ticket_number
[kind="accommodation"] Details of accomodation object
booking_number The booking number for the accommodation string Mandatory
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
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: +[country string Optional

code] [phone number])
email Email address string Optional
travelers An array of Traveler Details Mandatory
travelers>traveler Details of each traveler Mandatory
travelers>traveler> name traveler’s name string Mandatory
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:
04/03/2020 – page 41/49
< CreditCheck >

<Credential>
<Login>?</Login>
</Credential>
<User>?</User>
</ CreditCheck >
Credential
Login String Mandatory
Password String Mandatory
User IdUser on CYBERESA Integer Mandatory

SYSTEM
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
04/03/2020 – page 42/49
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 date of Float Mandatory

the deposit
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
04/03/2020 – page 43/49
Order : Operation Accepted : 2 Numeric Mandatory

Rejected : 3
Order : Comments Comments of order Text Optional
Response
<HotelBookingAcknowledgeRS>
<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 (Ok/NOK) Text
Order : Comments Comment of order in case Text

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>
04/03/2020 – page 44/49
<Ilng>?</Ilng>
<hotel>?</hotel>
<idtoken>?</idtoken>
<idorder>?</idorder>
<lastupdate>?</lastupdate>
</BookingListRQ>
Login Text
Password Text
User Current user Id Numeric Mandatory

Ilng Language Id Numeric Optional
hotel Hotel Id Numeric Optional
idtoken Token Id Numeric 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>
04/03/2020 – page 45/49
</customer>
</room>
</rooms>
</booking>
</bookings>
<Started>
</Started>
<ResponseTime>
</ResponseTime>
<BookingListRS>
bookings
totalnetRate
totalPaidAmount paid amount (added when Numeric

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 hotel is

reservation 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
04/03/2020 – page 46/49
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
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
04/03/2020 – page 47/49
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>
<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>
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 Id of Bording Numeric
04/03/2020 – page 48/49
room:boardings:boarding @Title title of Bording Text
room:boardings:boarding @Price price of Bording Numeric
room: Supplements: Id of Supplement Numeric

Supplement@Id
room: Supplements: title of Supplement Text

Supplement@Title
room: Supplements: price of Supplement Numeric

Supplement@Price
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 Global Boolean

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

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

GlobalSupplement@PerPax Supplement
04/03/2020 – page 49/49

CyberesaWS Hotel 10.0.0

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 10.0.0

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

10/06/2016 Chaima Mekni Add new node Kit:PaymentGateway to

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 HotelBookingAcknowledge

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

04/01/2020 Sofiene Ouelhazi • Updated HotelBookingCreationREQ()

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 to return Text Mandatory

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

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

BookingDetails :IdCity Search IdCity Numeric Mandatory

BookingDetails :Rooms :Room:Boardi Search by specific boarding id Numeric Optional

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 (City or Category or Title or Text Optional

default order by Priority ascendant will be

onlyAvailable Show only available hotels Boolean Optional

ItemsPerPage Value indicating items to be returned per page Numeric Mandatory

PageNumber Value indicates the number of the page to be Numeric Mandatory

<Available code=’?’ status=’?’ value=’?’>?</Available>

Root Sub Root Description Valeurs & Tag

ErrorResult:@id Error id Numeric

ErrorResult:message Appropriate message Text

FromDate Search start date dd/mm/yyyy

ToDate Search end date dd/mm/yyyy

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 :@Cur 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 :Title Hotel Name Text

Hotels :Hotel :PromortionTitle Hotel Promotion Title Text

Hotels :Hotel : Hotel category Text

Hotels :Hotel : Hotel Category ID(stars number) Numeric

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

Hotels:Hotel: Caption for hotel’s thumb image Text

Hotels:Hotel: Hotel review note Numeric

Hotels :Hotel : Hotel review number Numeric

Hotels :Hotel : Hotel longitude Numeric

Hotels :Hotel : Hotel Latitude Numeric

Hotels : Hotel :Address Hotel address Text