Rayna Online B2B

Introduction

The purpose of this document is to provide technical details about the API's. This document outlines the business processes supported by the API and details about specifications of API’s. It assumes that reader has a technical background and is familiar with JSON, API's.

Connection properties

The communication with the system is performed through https connections. The following table enlists the properties of the request that must be employed:

Request	value	Description
Request Method	POST	The requested method.
Content-Type	application/json	The content type.

Request/Response

It is recommended that at least all booking and cancellation transactions sent through the Test / Live environment should be logged and maintained by the travel agent for at least 6 months.

Go-Test/Live Process

In order to start testing, please notify our support team via e-mail at [email protected]Please note that all transactions through the test system are simply test transactions.

Please be advised few activities are available in Test Environment, Do not compare the products with Live Environment The system functionality between the Test and Live system is exactly the same except for the fact that Bookings processed in the Test environment are not sent to the Suppliers. When you have completed your development, contact your Account Manager for the activation of the access IP address of Test/Live Server is essential for whitelisting

Client Requirements

Client requests must be issued from a public, static IP address registered with System.
Client requests must be made via an HTTPS POST request.
SSL.
All data sent and received via the interface will be encoded in UTF-8.

Development Phase

Once you receive your Access token, you can start the development of your application/framework. The whole process of communication consists of simple JSON messages exchange (request /response) between your application/framework and system. Each request needs to be posted (through POST method) using https protocols. For details regarding requests and answers formats please consult the dedicated area of each request. For further assistance in development process do not hesitate to contact our support team.

Implementation Approach

Client review of the API specifications

Review of API specifications

Test Environment Integration

API Integration
Test Execution by your Tech Team

Integration Testing

Determining the necessary test cases based on the API's by Our Tech Team
Test Execution.
Certification by Our Tech Team

Production Environment

API Integration
Schedule Go Live Date
Transaction Monitoring and Issue Resolution

Documentation and Downloads

Status & Error Code

No	Status Code	Description
1	200	OK
2	400	Download API Collection
3	401	Unauthorized
4	403	Forbidden
5	404	Not Found
6	500	Internal Server Error
7	503	Service Unavailable

Custom Error Code

No	Error Code	Description
1	100	AdultRate or ChildRate is lower than system price.
2	101	You do not have a sufficient credit limit. Please contact administrator.
3	102	Travel date should not be less than current date.
4	103	Adult should be more than zero.
5	104	Pickup Details is compulsory in Private and Sharing Transfer.
6	105	Start Time is compulsory.
7	106	You must pass Pax Type. /Invalid Pax Type.
8	107	This Tour is not Available.
9	108	Your Event Id and Start Date and Time should be correct.
10	109	You have put wrong City Id.
11	110	Tour is not available for this City.
12	111	Travel date should be Compulsory
13	112	Travel date should be MM-DD-YYYY
14	113	Invalid Transfer Type

Transfer Type

Every product has a default transfer type and the Below id is passed along with the specific product ids.

No.	Transfer Name	Transfer ID
1	Without Transfer	41865
2	Sharing Transfer	41843
3	Private Transfer	41844
4	Private Boat Without Transfers	43129
5	Pvt Yach Without Transfer	43110

Without Transfer: Skip the transfer and travel to the selected attraction or destination on your own.
Shared Transfer: When you request for this transfer, you’ll share the ride with other guests who travel on the same route.
Private Transfer: This non-shared, personalized transfer is reserved exclusively for you and your travel companions.
Private Boat Without Transfers: Privatly organized tour withour transfer.
Pvt Yach Without Transfer: Privatly organized tour withour transfer.

Booking Status

No	Booking Status	Description
1	Success	If your booking status is success, you will get referenceNo which is guaranteed proof of your reservation.
2	Rejected	Rejected The booking can be rejected due to Following reasons : Price change, allocation not available, stop sale at last minute, inventory sold out and session timed out. On rejection the amount will be credited to your wallet instantly, you can use the amount for making new booking.
3	Cancelled	Cancelled The booking can be cancelled due to Following reasons : If it is not confirmed at supplier side. It is cancelled by the user.
4	InQueue	InQueue For Tours like Burj Khalifa, Supplier allows confirmation 30 days prior to travel date. If Booking Status is In Queue, the booking will be Confirmed or Vouchered after 30 days.

Image Path

Root URL : https://d2g4iwshf24scx.cloudfront.net
You will get this in static json data .
Complete URL : https://d2g4iwshf24scx.cloudfront.net/Tour-Images/false-4850/fly-fish.jpg

Image Size

Image	Image Size
Front Image	270px * 180px
Gallary	900px * 500px
Background	1902px * 572px

Date Format

Date format send to Payload
1) MM/dd/yyyy
2) MM-dd-yyyy
3) yyyy-MM-dd
4) yyyy/MM/dd
5) MM.dd.yyyy

Access Information

API NAME	Access Type Mandatory Optional
Static Data API
Price Request/Get Tour Price API
Tour Option API
Get Tour Time Slot API
Tour Availability Request API
Booking Request API
Booking Cancellation Request API

Frequently Asked Questions

Q: Do you offer any REST/SOAP API in order to provide a communication channel to the Rayna Tours platform?

A:We provide the REST API, request and response is in the JSON format ( JavaScript Object Notation).

Q: In case there is an API, what kinds of services are available through this API?

A:API Services having vast pool of UAE / Singapore / Malaysia /Thailand / Hong kong Tours to help you to distribute the product globally which contains attraction / activities.

Q: Is there a way to discover available ticket options through you service? For example adult ticket day pass, child day pass, weekly pass, etc.

A:We provide tours time slots & tickets availability in the apis so you can select the timeslot, transfer option & tickets for adult , child , infant.

Q: Is there a sandbox environment available where we can perform some tests?

A:Yes , we provide Sandbox environment with test booking details.

Contact Us

Sales:

Email:[email protected]

Tel:+97142087555 Ext 253|+912066838800 Ext 253

Mobile:+919823111231

Support:

Email:[email protected]

Ticketing tours

NonTicketing tours

Country / City

Country

The following sections describes the Country request and response format

Request URL

{{BaseURL}}/api/Tour/countries

This URL is for fetching Country data

JSON Response Format:

{ "statuscode": Status code, "error": Error description, "url": url, "count": Country Count, "result": [ { "countryId": Country Id, "countryName": Country Name } ] }

Parent Tag	Tag	Type	Description
statuscode		int	Response status & custom error code.
error		string	Fields with error description, shown if error occurs.
url		string	CDN path. (Note: If required)
count		int	Count REST API to obtain the number of Informatica resources based on a search expression.
result		array	Result for available country searches.
	countryId	int	Tour's country id.
	countryName	string	Tour's country name.

City

The following sections describes the City request and response format

Request URL

{{BaseURL}}/api/Tour/cities

This URL is for fetching City data

JSON Request Format:

{ "CountryId":CountryId }

Tag	Description	Optionality
CountryId	Tour's country id, You will get countryId from {{BaseURL}}/api/Tour/countries API.	Mandatory

JSON Response Format:

{ "statuscode": Status code, "error": Error description, "url": Url, "count": City Count, "result": [ { "cityId": City Id, "cityName": City Name } ] }

Parent Tag	Tag	Type	Description
statuscode		int	Response status & custom error code.
error		string	Fields with error description, shown if error occurs.
url		string	CDN path. (Note: If required)
count		int	Count REST API to obtain the number of Informatica resources based on a search expression.
result		array	Result for available city searches.
	cityId	int	Tour's city id.
	cityName	string	Tour's city name.

Static Data

Tour Static Data

The following sections describes the Tour static data request and response format

Request URL

{{BaseURL}}/api/Tour/tourstaticdata

This URL is for fetching Tour Static Data

JSON Request Format:

{ "countryId": Country Id, "cityId": City Id }

Tag	Type	Description	Optionality
CountryId	int	Tour's country id, You will get countryId from {{BaseURL}}/api/Tour/countries API.	Mandatory
CityId	int	Tour's city id, You will get cityId from {{BaseURL}}/api/Tour/cities API.	Mandatory

JSON Response Format:

{ "statuscode": Status code, "error": Error description, "url": Url, "count": Tour Data Count, "result": [ { "tourId": Tour Id, "countryId": Country Id, "countryName": Country Name, "cityId": City Id, "cityName": City Name, "tourName": Tour Name, "reviewCount": Review Count, "rating": Rating, "duration": Duration, "imagePath": Tour Image Path, "imageCaptionName": Tour Image Caption, "cityTourTypeId": Tour Type Id, "cityTourType": Tour Type Name, "tourShortDescription": Tour Short Description, "cancellationPolicyName": Cancellation Policy Name, "isSlot":is Slot, "onlyChild": Only Child, "contractId": Contract Id } ] }

Parent Tag	Tag	Type	Description	Note:
statuscode		int	Response status & custom error code.
error		string	Fields with error description, shown if error occurs.
url		string	CDN path. (Note: If required)	If required.
count		int	Count REST API to obtain the number of Informatica resources based on a search expression.
result		array	Result for available tour static searches.
	tourId	int	Unique identifier of the tour.
	countryId	int	Tour's country id.
	countryName	string	Tour's country name.
	cityId	int	Tour's city id.
	cityName	string	Tour's city name.
	tourName	string	Tour name.
	reviewCount	int	Average review of tours.
	rating	double	Retrieving the reviews of all available travel group & customer.
	duration	string	Time duration between tour available.
	imagePath	string	Image url of tour's.
	imageCaptionName	string	Image caption name.
	cityTourTypeId	int	Unique identifier of the tour types.
	cityTourType	string	Name of city tour types.
	tourShortDescription	string	Short information about the tour.
	cancellationPolicyName	string	Cancellation policy name of the tours.
	isSlot	bool	If "isSlot" true, you will get multiple time slote list.	Required tour timeslot should pass.
	onlyChild	bool	If "true", Only child inventory can book.	Tour can book for child without adult.
	contractId	int	ContractId we use internally to identify to tour is supplier tour or not in API you get this contractid in "tourStaticData" API.

Tour Static Data by Id

The following sections describes the Tour Static Data by Id request and response format

Request URL

{{BaseURL}}/api/Tour/tourStaticDataById

This URL is for fetching Tour Static Data by Id

JSON Request Format:

{ "countryId": Country Id, "cityId": City Id, "tourId": Tour Id, "contractId": Contract Id, "travelDate": Travel Date }

Tag	Type	Description	Optionality
countryId	int	Tour's country id, You will get countryId from {{BaseURL}}/api/Tour/countries API.	Mandatory
cityId	int	Tour's city id, You will get cityId from {{BaseURL}}/api/Tour/cities API.	Mandatory
tourId	int	Unique identifier of the tour, You will get tourId from {{BaseURL}}/api/Tour/tourlist API.	Mandatory
contractId	int	ContractId we use internally to identify to tour is supplier tour or not in API you get this contractid in "tourStaticData" API.
travelDate	string	Tour travel date with Formats.	Mandatory

JSON Response Format:

{ "statuscode": Status code, "error": Error description, "url": Url, "count": Tour Data Count, "result": [ { "tourId": tourId, "countryId": countryId, "countryName": countryName, "cityId": cityId, "cityName": cityName, "tourName": tourName, "reviewCount": reviewCount, "rating": rating, "duration": duration, "departurePoint": departurePoint, "reportingTime": reportingTime, "tourLanguage": tourLanguage, "imagePath": imagePath, "imageCaptionName": imageCaptionName, "cityTourTypeId": cityTourTypeId, "cityTourType": cityTourType, "tourDescription": tourDescription, "tourInclusion": tourInclusion, "tourShortDescription": tourShortDescription, "raynaToursAdvantage": raynaToursAdvantage, "whatsInThisTour": whatsInThisTour, "importantInformation": importantInformation, "itenararyDescription": itenararyDescription, "usefulInformation": usefulInformation, "faqDetails": faqDetails, "termsAndConditions": termsAndConditions, "cancellationPolicyName": cancellationPolicyName, "cancellationPolicyDescription": cancellationPolicyDescription, "childCancellationPolicyName": childCancellationPolicyName, "childCancellationPolicyDescription": childCancellationPolicyDescription, "childAge": childAge, "infantAge": infantAge, "infantCount": infantCount, "isSlot": isSlot, "onlyChild": onlyChild, "contractId": contractId, "tourImages": [ { "tourId": tourId, "imagePath": imagePath, "imageCaptionName": imageCaptionName, "isFrontImage": isFrontImage, "isBannerImage": isBannerImage, "isBannerRotateImage": isBannerRotateImage } ], "tourReview": [ { "id": id, "tourId": tourId, "reviewId": reviewId, "reviewTitle": reviewTitle, "reviewContent": reviewContent, "visitMonth": visitMonth, "rating": rating, "imagePath": imagePath, "guestName": guestName } ] } ] }

Parent Tag	Tag	Child Tag	Type	Description	Note:
statuscode			int	Response status & custom error code.
error			string	Fields with error description, shown if error occurs.
url			string	CDN path.	If required.
count			int	Count REST API to obtain the number of Informatica resources based on a search expression.
result			array	Result for available tour static searches.
	tourId		int	Unique identifier of the tour.
	countryId		int	Tour's country id.
	countryName		string	Tour's country name.
	cityId		int	Tour's city id.
	cityName		string	Tour's city name.
	tourName		string	Tour name.
	reviewCount		int	Total number of tours review.
	rating		double	Retrieving the reviews of all available travel group & customer.
	duration		string	Time duration of tours.
	departurePoint		string	Location of tours.
	reportingTime		string	Tours reporting time.
	tourLanguage		string	Available language for tour.
	imagePath		string	Image url of tour's.
	imageCaptionName		string	Image caption name.
	cityTourTypeId		int	Unique identifier of the tour types.
	cityTourType		string	Name of city tour types.
	tourDescription		string	Information about the tour.
	tourInclusion		string	Tour inclusion.
	tourShortDescription		string	Short description about the tours.
	raynaToursAdvantage		string	Advantages of the tours.
	whatsInThisTour		string
	importantInformation		string	Important information about the tours.
	itenararyDescription		string	Itenarary description about the tours.
	usefulInformation		string	Usefull information about the tours.
	faqDetails		string	FAQ details of the tours.
	termsAndConditions		string	Terms and conditions of tours.
	cancellationPolicyName		string	Cancellation policy name of the tours.
	cancellationPolicyDescription		string	Cancellation policy description of the tours.
	childCancellationPolicyName		string	Child cancellation policy name of the tours.
	childCancellationPolicyDescription		string	Child cancellation policy description of the tours.
	childAge		string	As per child policy.
	infantAge		string	As per child policy.
	infantCount		int	Total number of infant.
	isSlot		bool	If "isSlot" true, you will get multiple time slote list.	Required tour timeslot should pass.
	onlyChild		bool	If "true", Only child inventory can book.	Tour can book for child without adult.
	contractId		int	ContractId we use internally to identify to tour is supplier tour or not in API you get this contractid in "tourStaticData" API.
	tourImages		array	Information about tours image.
		tourId	int	Unique identifier of the tour.
		imagePath	string	Image url of tour's.
		imageCaptionName	string	Image caption name.
		isFrontImage	int	This image will use for front.
		isBannerImage	int	This image will use as banner.
		isBannerRotateImage	int	This image will use as rotate image.
	tourReview		array	About tour review.
		id	int
		tourId	int	Unique identifier of the tour.
		reviewId	int	Tour review id.
		reviewTitle	string	Review title.
		reviewContent	string	Review content of tours.
		visitMonth	string	Visited month.
		rating	int	Review rationg.
		imagePath	string	Image url of tour's.
		guestName	string	Tour visited guest name.

Option Static Data

The following sections describes the Option Static Data request and response format

Request URL

{{BaseURL}}/api/Tour/touroptionstaticdata

This URL is for fetching Option Static Data

JSON Request Format:

{ "tourId":tourId, "contractId":contractId }

Tag	Type	Description	Optionality
tourId	int	Unique identifier of the tour, You will get tourId from {{BaseURL}}/api/Tour/tourlist API.	Mandatory
contractId	int	ContractId we use internally to identify to tour is supplier tour or not in API you get this contractid in "tourStaticData" API.	Mandatory

JSON Response Format:

{ "statuscode": Status code, "error": Error description, "url": Url, "count": Tour option Data Count, "result": [ "touroption": [ { "tourId": tourId, "tourOptionId": tourOptionId, "optionName": optionName, "childAge": childAge, "infantAge": infantAge, "optionDescription": optionDescription, "cancellationPolicy": cancellationPolicy, "cancellationPolicyDescription": cancellationPolicyDescription, "childPolicyDescription": childPolicyDescription, "xmlcode": xmlcode, "xmloptioncode": xmloptioncode, "countryId": countryId, "cityId": cityId, "minPax": minPax, "maxPax": maxPax, "duration": duration, "timeZone": timeZone } ], "operationdays": [ { "tourId": tourId, "tourOptionId": tourOptionId, "monday": monday, "tuesday": tuesday, "wednesday": wednesday, "thursday": thursday, "friday": friday, "saturday": saturday, "sunday": sunday } ], "specialdates": [], "transfertime": [ { "tourId": tourId, "tourOptionId": tourOptionId, "transferType": transferType, "transferTime": transferTime, "duration": duration } ] ] }

Parent Tag	Tag	Child Tag	Type	Description
statuscode			int	Response status & custom error code.
error			string	Fields with error description, shown if error occurs.
url			string	CDN path. (Note: If required)
count			int	Count REST API to obtain the number of Informatica resources based on a search expression.
result			array	Result for available tour static option searches.
	touroption		array	Tour options.
		tourId	int	Unique identifier of the tour.
		tourOptionId	int	Unique identifier of the tour options.
		optionName	string	Tours option name.
		childAge	string	As per child policy.
		infantAge	string	As per child policy.
		optionDescription	string	A short information about tours option.
		cancellationPolicy	string	Cancellation policy of the tours option.
		cancellationPolicyDescription	string	Cancellation policy description of the tours option.
		childPolicyDescription	string	Child cancellation policy name of the tours option.
		xmlcode	string	XML code.
		xmloptioncode	string	XML option code.
		countryId	int	Tour's country id.
		cityId	int	Tour's city id.
		minPax	int	Minimum number of passangers.
		cityId	int	Tour's city id.
		maxPax	int	Maximum number of passangers.
		duration	string	Time duration of tours.
		timeZone	string	Tours time zone.
	operationdays		array	Availiblity of tour on days.
		tourId	int	Unique identifier of the tour.
		tourOptionId	int	Unique identifier of the tour options.
		monday	int
		tuesday	int
		wednesday	int
		thursday	int
		friday	int
		saturday	int
		sunday	int
	specialdates		array	Tour available on dates or festivals.
	transfertime		array
		tourId	int	Unique identifier of the tour.
		tourOptionId	int	Unique identifier of the tour options.
		transferType	string	Available transferId for tour. Available transfer types.
		transferTime	string
		duration	string	Time duration of tours.

Tour Price

The following sections describes the Tour Price request and response format

Request URL

{{BaseURL}}/api/Tour/tourlist

This URL is for fetching Tour Price data

JSON Request Format:

{ "countryId": Country Id, "cityId": City Id, "travelDate": Travel Date, }

Tag	Type	Description	Optionality
countryId	int	Tour's country id, You will get countryId from {{BaseURL}}/api/Tour/countries API.	Mandatory
cityId	int	Tour's city id, You will get cityId from {{BaseURL}}/api/Tour/cities API.	Mandatory
travelDate	string	Tour travel date Formats.	Mandatory

JSON Response Format:

{ "statuscode": Status code, "error": Error description, "url": Url, "count": Tour Data Count, "result": [ { "tourId": tourId, "contractId": contractId, "amount": amount, "discount": discount, "sortOrder": sortOrder } ] }

Parent Tag	Tag	Type	Description	Note:
statuscode		int	Response status & custom error code.
error		string	Fields with error description, shown if error occurs.
url		string	CDN path.	If required.
count		int	Count REST API to obtain the number of Informatica resources based on a search expression.
result		array	Result for tour price.
	tourId	int	Unique identifier of the tour.
	contractId	int	ContractId we use internally to identify to tour is supplier tour or not in API you get this contractid in "tourStaticData" API.
	amount	decimal	Tour amount.
	discount	decimal	Discount for tour.
	sortOrder	int

Tour Options

The following sections describes the Tour Options request and response format

Request URL

{{BaseURL}}/api/Tour/touroption

This URL is for fetching Tour Options data

JSON Request Format:

{ "tourId": tourId, "contractId": contractId, "travelDate": TravelDate, "noOfAdult": NoOfAdult, "noOfChild": NoOfChild, "noOfInfant": NoOfInfant }

Tag	Type	Description	Optionality
tourId	int	Unique identifier of the tour, You will get tourId from {{BaseURL}}/api/Tour/tourlist API.	Mandatory
contractId	int	ContractId we use internally to identify to tour is supplier tour or not in API you get this contractid in "tourStaticData" API.	Mandatory
travelDate	string	Tour travel date Formats.	Mandatory
noOfAdult	int	Number of adult.	Mandatory
noOfChild	int	Number of child.
noOfInfant	int	Total number of adult and child.

JSON Response Format:

{ "statuscode": Status code, "error": Error description, "url": Url, "count": Tour Option Data Count, "result": [ { "tourId": tourId, "tourOptionId": tourOptionId, "transferId": transferId, "transferName": transferName, "adultPrice": adultPrice, "childPrice": childPrice, "infantPrice": infantPrice, "withoutDiscountAmount": withoutDiscountAmount, "finalAmount": finalAmount, "startTime": startTime, "departureTime": departureTime, "disableChild": disableChild, "disableInfant": disableInfant, "allowTodaysBooking": allowTodaysBooking, "cutOff": cutOff, "isSlot": isSlot, "isDefaultTransfer": isDefaultTransfer, "rateKey": rateKey, "inventoryId": inventoryId } ] }

Parent Tag	Tag	Type	Description	Note:
statuscode		int	Response status & custom error code.
error		string	Fields with error description, shown if error occurs.
url		string	CDN path.	If required.
count		int	Count REST API to obtain the number of Informatica resources based on a search expression.
result		array	Result for available tour option.
	tourId	int	Unique identifier of the tour.
	tourOptionId	int	Unique identifier of the tour options.
	transferId	int	Available transferId and transferName for tour. Available transfer types.
	transferName	string
	adultPrice	decimal	Price per adult, as per transferType.
	childPrice	decimal	Price per child, as per transferType.
	infantPrice	decimal	Total price.
	withoutDiscountAmount	decimal	Amount without discount.
	finalAmount	decimal	Total amount as per booking. (adult + child)
	startTime	string	Start time of tour.
	departureTime	string	Departure time of tours.
	disableChild	bool	If disable child is allow.
	disableInfant	bool	If disable adult is allow.
	allowTodaysBooking	bool	Booking allow for today.
	cutOff	int
	isSlot	bool	If "isSlot" true, you will get multiple time slote list.	Required tour timeslot should pass.
	isDefaultTransfer	int	If tour option have default transfer.
	rateKey	string
	inventoryId	int	Unique inventory id.

Tour Timeslot

The following sections describes the Tour Timeslot request and response format

Request URL

{{BaseURL}}/api/Tour/timeslot

This URL is for fetching Tour Timeslot data

JSON Request Format:

{ "tourId": tourId, "tourOptionId": tourOptionId, "travelDate": travelDate, "transferId":transferId, "contractId": contractId }

Tag	Type	Description	Optionality
tourId	int	Unique identifier of the tour, You will get tourId from {{BaseURL}}/api/Tour/tourlist API.	Mandatory
tourOptionId	int	Unique identifier of the tour options, You will get tourOptionId from {{BaseURL}}/api/Tour/touroption API.	Mandatory
TravelDate	string	Tour travel date Formats.	Mandatory
transferId	int	The transferId, Required as per tour requirement.
contractId	int	ContractId we use internally to identify to tour is supplier tour or not in API you get this contractid in "tourStaticData" API.	Mandatory

JSON Response Format:

{ "statuscode": Status code, "error": Error description, "url": Url, "count": Timeslot Count, "result": [ { "tourOptionId": tourOptionId, "timeSlotId": timeSlotId, "timeSlot": timeSlot, "available": available, "adultPrice": adultPrice, "childPrice": childPrice, "isDynamicPrice": isDynamicPrice } ] }

Parent Tag	Tag	Type	Description	Note:
statuscode		int	Response status & custom error code.
error		string	Fields with error description, shown if error occurs.
url		string	CDN path.	If required.
count		int	Count REST API to obtain the number of Informatica resources based on a search expression.
result		array	Result for available tour time slot.
	tourOptionId	int	Unique identifier of the tour options.
	timeSlotId	int	Unique identifier of the tour options time slot.
	timeSlot	string	Available time slot for tour.
	available	int	Number of slot available.
	adultPrice	decimal	Price per adult, as per transferType.
	childPrice	decimal	Price per child, as per transferType.
	isDynamicPrice	bool	If the flag is False then you have to consider the price from the Option API.

Tour Availability

The following sections describes the Tour Availability request and response format

Request URL

{{BaseURL}}/api/Tour/availability

This URL is for fetching Tour Availability data

JSON Request Format:

{ "tourId": tourId, "tourOptionId": tourOptionId, "transferId": transferId, "travelDate": travelDate, "adult": adult, "child": child, "infant": infant, "contractId": contractId }

Tag	Type	Description	Optionality
tourId	int	Unique identifier of the tour, You will get tourId from {{BaseURL}}/api/Tour/tourlist API.	Mandatory
tourOptionId	int	Unique identifier of the tour options, You will get tourOptionId from {{BaseURL}}/api/Tour/touroption API.	Mandatory
transferId	int	The transferId.	Mandatory
TravelDate	string	Tour travel date Formats.	Mandatory
adult	int	Total number of adult.	Mandatory
child	int	Total number of child.
infant	int	Total number of infant.
contractId	int	ContractId we use internally to identify to tour is supplier tour or not in API you get this contractid in "tourStaticData" API.

JSON Response Format:

{ "statuscode": Status code, "error": Error description, "url": Url, "count": Array Count, "result": [ { "status": status, "message": message, "productType": productType } ] }

Parent Tag	Tag	Type	Description	Note:
statuscode		int	Response status & custom error code.
error		string	Fields with error description, shown if error occurs.
url		string	CDN path.	If required.
count		int	Count REST API to obtain the number of Informatica resources based on a search expression.
result		array	Result for available tour.
	status	int	Status code as per availiblity
	message	string	You will got the massages as tour availiblity. "success": tour is available. "This tour is available only for 12/12/2021": Tour is abailable for (Eg: 12/12/2021) specify date only, Please select other date. "This tour is available only From 12/12/2021 To 31/12/2021": Tour is available between (Eg: 12/12/2021 To 31/12/2021), Please select other date. "This tour is not available From 12/12/2021 To 31/12/2021": Tour is not available between (Eg: 12/12/2021 To 31/12/2021), Please select other date. "Sorry, the tour is not available on the selected date. Kindly choose the other date": Tour is not abailable for selected date, Please select other date. "Sorry The Tour is Not Operational on the Selected Date.": "Selected transfer type not available": Selected transfer type is not available for selected tour. "Sorry, Child are not allowed in TourOptionName": Children are not allowed for this tour option. "Sorry, Infant are not allowed in TourOptionName": Infant are not allowed for this tour option. "We regret to inform you the tickets are not available for this option": Tickets are not available for this tour. "Sorry, the tour is not available on the selected date due to stop sell, Kindly choose the other date": Tour is not abailable due to stop selling. "You cannot book this tour for 12/12/2021":
	productType	int

Tour Cancellation Policy

The following sections describes the Tour Availability request and response format

Request URL

{{BaseURL}}/api/Tour/policy

This URL is for fetching Tour cancellation policy.

JSON Request Format:

{ "tourId": tourId, "travelDate": travelDate, "startTime": startTime, "currentDate": currentDate, "contractId": contractId, "tourOptionId": tourOptionId }

Tag	Type	Description	Optionality
tourId	int	Unique identifier of the tour, You will get tourId from {{BaseURL}}/api/Tour/tourlist API.	Mandatory
travelDate	string	Tour travel date. (Note: Date format is yyyy-MM-dd)	Mandatory
startTime	string	Start time of tour.	Mandatory
currentDate	string	You should enter current date time (yyyy/MM/dd/HH/mm).	Mandatory
contractId	int	ContractId we use internally to identify to tour is supplier tour or not in API you get this contractid in "tourStaticData" API.	Mandatory
tourOptionId	int	Unique identifier of the tour options.	Mandatory

JSON Response Format:

{ "statuscode": Status code, "error": Error description, "currency": currency, "currencysymbol": currencysymbol, "errormessage": errormessage, "count": Arry Count, "result": [ { "tourId": tourId, "optionId": optionId, "fromDate": From date, "toDate": To date, "percentage": Percentage charge (Eg: 100%) } ] }

Parent Tag	Tag	Type	Description	Note:
statuscode		int	Response status & custom error code.
error		string	Fields with error description, shown if error occurs.
currency		string	You will get currency name.
currencysymbol		string	You will get the currency symbol.
errormessage		string	You will get the error massage if error acour.
count		int	Count REST API to obtain the number of Informatica resources based on a search expression.
result		array	Result for cancallation policys.
	tourId	int	Unique identifier of the tour.
	optionId	int	Unique identifier of the tour options.
	fromDate	string	Represents FromDate.	Date format is: MM-DD-YYYY Example: 12-18-2018
	toDate	string	Represents ToDate.	Date format is: MM-DD-YYYY Example: 12-18-2018
	percentage	int	This is indicate cancellation charges percentage.

Tour Booking

The following sections describes the Tour Booking request and response format

Request URL

{{BaseURL}}/api/Booking/bookings

This URL is for fetching Tour Booking data

JSON Request Format:

{ "uniqueNo": uniqueNo, "TourDetails": [ { "serviceUniqueId": serviceUniqueId, "tourId": tourId, "optionId": optionId, "adult": adult, "child": child, "infant": infant, "tourDate": tourDate, "timeSlotId": timeSlotId, "startTime": startTime, "transferId": transferId, "pickup": pickup, "adultRate": adultRate, "childRate": childRate, "serviceTotal": serviceTotal } ], "passengers": [ { "serviceType": serviceType, "prefix": prefix, "firstName":firstName, "lastName": lastName, "email": email, "mobile": mobile, "nationality": nationality, "message": message, "leadPassenger": leadPassenger, "paxType": paxType, "clientReferenceNo": clientReferenceNo } ] }

Parent Tag	Tag	Type	Description	Optionality
uniqueNo		int	Identifier of the booking (at the partner) made by the partner. Shall be unique for the contract, otherwise an error will be returned. (Note: Max 6 digit)	Mandatory
TourDetails		array		Mandatory
	serviceUniqueId	int	Service uniqueId must be unique for each tour booked under the same referance. If the referanceNo having only one tour then you can pass same uniqueId. (Note: Max 6 digit)	Mandatory
	tourId	int	Unique identifier of the tour, You will get tourId from tourlist API.	Mandatory
	optionId	int	Unique identifier of the tour options, You will get tourOptionId from touroption API.	Mandatory
	adult	int	Total number of adult.	Mandatory
	child	int	Total number of child.	Mandatory
	infant	int	Total number of infant.	Mandatory
	tourDate	string	Tour booking date Formats.	Mandatory
	timeSlotId	int	Unique identifier of the tour options time slot. (Note: If required)	Mandatory
	startTime	string	Start timing of tour.	Mandatory
	transferId	int	You should enter the transferId as per requierment.	Mandatory
	pickup	string	Enter pickup location. (If requier)	Mandatory
	adultRate	decimal	Total adult price.	Mandatory
	childRate	decimal	Total child price.	Mandatory
	serviceTotal	string	Total amount of service. (adultRate + childRate)	Mandatory
passengers		array	Passanger details.	Mandatory
	serviceType	string	Service type is tour.	Mandatory
	prefix	string	Mr./ Ms./ Mrs.	Mandatory
	firstName	string	First name of passanger.	Mandatory
	lastName	string	Last name of passanger.	Mandatory
	email	string	EmailId of passanger's, manager for contact purposes & transactional emails.	Mandatory
	mobile	string	Mobile number of the passanger's manager for contact purposes.	Mandatory
	nationality	string	Passanger's nationality.	Mandatory
	pickup	string	Pickup location of passanger. (If requier)	Mandatory
	message	string	Short information about the passanger.	Mandatory
	leadPassenger	bool	Lead passanger name, who guid and lead the tours.	Mandatory
	adultRate	decimal	Price per adult, as per transferType. You will get tourRates from tourlist API.	Mandatory
	paxType	string	The passanger is Adult, Chind or Infant.	Mandatory
	clientReferenceNo	string	Your referenceNo.	Mandatory

JSON Response Format:

{ "statuscode": Status code, "error": Error description, "url": Url, "count": Array Count, "result": [ { "refernceNo": refernceNo, "status": status, "bookingId": bookingId, "downloadRequired": downloadRequired, "serviceUniqueId": serviceUniqueId, "servicetype": servicetype, "confirmationNo": confirmationNo } ] }

Parent Tag	Tag	Type	Description
statuscode		int	Response status & custom error code.
error		string	Fields with error description, shown if error occurs.
url		string	CDN path.
count		int	Count REST API to obtain the number of Informatica resources based on a search expression.
result		array	Result for available tour time slot.
	refernceNo	string	Rayna booking confirmation number.
	status	string	Represents booking status with details.
	bookingId	int	The bookingId unique booking identifier.
	downloadRequired	bool	If "downloadRequired" true, the tour must hit Ticket Details API. and you must hit the tour ticket detail API.
	serviceUniqueId	string	Service uniqueId must be unique for each tour. You can enter uniqueNo if book only one tour.
	servicetype	string	Service type is tour.
	confirmationNo	string	Identifier of the booking (at the supplier) made by the supplier.

Tour Ticket

The following sections describes the Ticket request and response format

Request URL

{{BaseURL}}/api/Booking/GetBookedTickets

This URL is for fetching Ticket data

JSON Request Format:

{ "uniqNO": Uniq NO, "referenceNo": Reference No, "bookedOption": [ { "serviceUniqueId": Service Unique Id", "bookingId": Booking Id } ] }

Parent Tag	Tag	Type	Description	Optionality
uniqueNo		int	Identifier of the booking (at the partner) made by the partner while booking (Booking uniqueNo).	Mandatory
referenceNo		string	The refernceNo unique booking identifier (you will get it from booking response).	Mandatory
bookedOption		array		Mandatory
	serviceUniqueId	string	Service uniqueId must be unique for each tour (Booking serviceUniqueId).	Mandatory
	bookingId	int	The bookingId unique booking identifier (get from booking response).	Mandatory

JSON Response Format:

{ "statuscode": Status Code, "error": Error, "result": { "bookingId": Booking Id, "referenceNo": referenceNo, "BookingStatus": BookingStatus, "ticketURL": Ticket URL, "optionName":Option Name, "validity": Validity, "validityExtraDetails": Validity Extra Details, "printType": Print Type, "slot": Slot, "pnrNumber": pnrNumber, "ticketDetails": [ { "barCode": Bar Code, "type": "Type", "noOfAdult": No Of Adult, "noOfchild": No Of Child } ] } }

Parent Tag	Tag	Child Tag	Type	Description
statuscode			int	Response status & custom error code.
error			string	Fields with error description, shown if error occurs.
result			array	Result for tours tecket details.
	bookingId		int	The bookingId unique booking identifier.
	referenceNo		string	The refernceNo unique booking identifier (you will get it from booking response).
	BookingStatus		string	You will get the booking status.
	ticketURL		string	From ticket url you will download the ticket.
	optionName		string	Tour option name.
	validity		string	Validity of tours ticket download.
	validityExtraDetails		string	Some more information about validity of booked tour.
	printType		string	This is identfy that barcode or QR cord.
	slot		string	Tour slot timing, if tour have slot
	pnrNumber		string	Supplier confirmation number, You will get it from booking response.
	ticketDetails		array
		barCode	string	Barcode number.
		type	string	Tour type.
		noOfAdult	int	Number of adult.
		noOfchild	int	Number of child.

Tour Cancellation

The following sections describes the Tour Cancellation request and response format

Request URL

{{BaseURL}}/api/Booking/cancelbooking

This URL is for fetching Tour Cancellation data

JSON Request Format:

{ "bookingId": bookingId, "referenceNo": referenceNo, "cancellationReason": cancellationReason }

Tag	Type	Description	Optionality
bookingId	int	The bookingId unique booking identifier (get from booking response).	Mandatory
referenceNo	string	The refernceNo unique booking identifier (get from booking response).	Mandatory
cancellationReason	string	Reason for cancle the tour.	Mandatory

JSON Response Format:

{ "statuscode": Status code, "error": Error description, "url": Url, "count": Array Count, "result": [ { } ] }

Parent Tag	Type	Description
statuscode	int	Response status & custom error code.
error	string	Fields with error description, shown if error occurs.
url	string	CDN path.
count	int	Count REST API to obtain the number of Informatica resources based on a search expression.
result	array	Result of cancel tour.

Introduction

Connection properties

Request	value	Description
Request Method	POST	The requested method.
Content-Type	application/json	The content type.

Request/Response

It is recommended that at least all booking and cancellation transactions sent through the Test / Live environment should be logged and maintained by the hotel agent for at least 6 months.

Go-Test/Live Process

In order to start testing, please notify our support team via e-mail at [email protected]

When you have completed your development, contact your Account Manager for the activation of the access IP address of Test/Live Server is essential for whitelisting

Client Requirements

Client requests must be issued from a public, static IP address registered with System.
Client requests must be made via an HTTPS POST request.
SSL.
All data sent and received via the interface will be encoded in UTF-8.
we use deflate compression for response.

Development Phase

Status & Error Code

No	Status Code	Description
1	200	OK
2	400	Bad Request
3	401	Unauthorized
4	403	Forbidden
5	404	Not Found
6	500	Internal Server Error
7	503	Service Unavailable
8	429	Too Many Requests (QPS Limit exceeds)

Process Flow Diagram

Implementation Approach

Client review of the API specifications

Review of API specifications

Test Environment Integration

API Integration.
Test Execution by your Tech Team.

Integration Testing

Determining the necessary test cases based on the API's by Our Tech Team
Test Execution
Certification by Our Tech Team

Before you go live you need to share pdf sample voucher after booking.

Production Environment

API Integration
Schedule Go Live Date
Transaction Monitoring and issue Resolution

Important note

Follow these guidelines when searching for properties for your test bookings, even for static tests. Being diligent in your property selection will help you avoid incurring any accidental charges during your booking tests.
Please use city id : 16424= Bangkok. for testing purpose
To use different nationality of different countries use same name in countries api response.
Verify the booking will be outside of the hotel's cancellation policy.
Never pick next-day or same-day availabilities, even to test promos.
Shop a few months ahead whenever possible.
Use Real Name for first name and last name. Do not use test name.
Never automate static booking tests -we may flag or temporarily disable your account.
Shopping at least a few months ahead and paying attention to Policy will help you avoid the most common problems with test bookings. Remember, client is not responsible for any unintentional live or nonrefundable bookings you place during testing.
Make sure you cancel each test booking using api, if face any issue in cancellation contact us immediately.
Always do refundable feature booking and cancel booking after done.
No duplication allowed for internalreference, it must be unique for each time you hit that api.

Documentation and Downloads

JSON Request Format:-

{ "code": "NOCOUNT_ERROR", "type": "GENERAL", "description": "No availability found for given criteria try search with other criteria" }

JSON Response Format:-

{ "code": "INTERNAL_ERROR", "type": "API_ERROR", "description": "the server was unable to process the request due to an internal error" }

Date Format

Date format send to Payload MM-DD-YYYY

Error and Description

ErrorCode	ErrorType	ErrorDescription
INTERNAL_ERROR	API_ERROR	The server was unable to process the request due to an internal error
NOTPERMITTED_ERROR	Permission	1.Bookings within cancellation deadline are not permitted for this User. 2.Bookings are not permitted for this User.
CacheNotAvailable	CacheNotAvailable	Access to one of the cache failed. The cache for this search key is no longer available
DUPLICATION_ERROR	Duplicate	1.Bookings within cancellation deadline are not permitted for this User 2.Booking token already exist for this criteria
MISMATCH_ERROR	Mismatch	1.Pricing could not complete - rate missing. 2.Data mismatch from previous response.
CacheNotAvailable	CacheNotAvailable	Access to one of the cache failed. The cache for this search key is no longer available
INVALID_REQUEST	RequestError	Request is not well formed please check and try again.
NOCOUNT_ERROR	GENERAL	1.No record found for given criteria 2.No availability found for given criteria try search with other criteria

Countries

The Countries API has been designed to provide All Countries data. The following sections describe the Countries API Request and Response Format.

The Request URL:

baseurl/api/xconnect/Countries/

JSON Request format:

{ "Token": "Token" }

Tag	Description	Optionality
Token	You have to put unique token which is provided by the system	Mandatory

JSON Response format:

{ "CountryId": "ID", "Name": "name" }, Example : "CountryId": "25773", "Name": "AFGHANISTAN"

Tag	Description
CountryId	Represent unique CountryId.
Name	Represent Name

Cities

The Hotel List Search API has been designed to provide list of all Hotels with display Minimum price for particular city. The following sections describe the Hotel List Search request and response format

Request URL

baseurl/api/xconnect/Cities/

JSON Request Format:

{ "Token": “Token”, "Request": { "CountryId": "ID" } }

Parent Tag	Tag	Description	Optionality
Request	CountryId	Represents unique CountryId	Mandatory
Token	Token	You have to put unique token which is provided by the system	Mandatory

JSON Response Format:

{ "CityId":ID, "Name": "NAME" } Example : "CityId":26467, "Name": "KABUL"

Tag	Description
CityId	Represents unique CityId.
Name	Represents unique city name.

AllCitieswithCountry

AllCitieswithCountry API has been designed to provide list of all cities with country .The following sections describe the AllCitieswithCountry in one API call request and response format.

The Request URL:

baseurl/api/xconnect/AllCitieswithCountry

JSON Request Format:

{ "Token": "", "Request": { "onlyhotel": 0 } }

Parent Tag	Tag	Description	Optionality
Token	Token	You have to put unique token which is provided by the system.	Mandatory
Request	onlyhotel	Represents onlyhotel	onlyhotel: 1 you will get all cities onlyhotel: 0 you will get active cities

JSON Response Format:

{ "cityid": ID, "cityname": "", "countryid": ID, "countryname": "" },

Tag	Description
cityid	Represents cityid
cityname	Represents cityname
Countryid	Represents Country id
countryname	Represents country name.

All Hotels By City

AllHotelsByCity API has been designed to provide list of all Hotel details for that particular City.
The following sections describe the AllHotelsByCity API request and response format.

The Request URL:

baseurl/api/xconnect/AllHotelsByCity

JSON Request Format:

{ "Token":"Token" , "Request": { "CityId" : ID } }

Parent Tag	Tag	Description	Optionality
Request	CityId	Represents unique CityId	Mandatory
Token	Token	You have to put unique token which is provided by the system.	Mandatory

JSON Response Format:

{ "HotelId": ID, "HotelName": "", "Latitude": " ", "longitude": " ", "Address": " ", "Rating": " ", "IsRecomondedHotel": false },

Tag	Description	Optionality
HotelId	Represents HotelId	Mandatory
HotelName	Represents HotelName	Mandatory
Latitude	Represents Latitude	Mandatory
longitude	Represents longitude	Mandatory
Address	Represents Address	Mandatory
Rating	Represents Rating	Mandatory
IsRecomondedHotel	-	Mandatory

All Hotels By City Full (for live data mapping)

The AllHotelsByCityFull API has been designed to provide All hotels basic data with city wise.
The following sections describe the AllHotelsByCityFull API Request and Response Format.

The Request URL:

baseurl/api/xconnect/AllHotelsByCityFull/

JSON Request Format:

{ "Token":"Token" }

Tag	Description	Optionality
Token	You have to put unique token which is provided by the system	Mandatory

JSON Response Format:

{ "Count": " ", "HotelList": [ { "HotelId": " ", "HotelName": " ", "Description": "", "Latitude": " ", "Longitude": " ", "Address": " ", "Rating": " ", "CountryId": " ", "CountryName": " ", "CityId": " ", "CityName": " ", "HotelFrontImage": "", "IsRecomondedHotel": "FALSE", "IsActive": "", "UpdatedDate": "" } ] }

Example :{ "HotelList": [ { "HotelId": 100530, "HotelName": "A la Carte Danang", "Description": "-", "Latitude": "16.0687593", "Longitude": "108.24506140000005", "Address": "200 Vo Nguyen Giap Street, Son Tra District, Da Nang, Vietnam", "Rating": "4", "CountryId": 43240, "CountryName": "Vietnam", "CityId": 43261, "CityName": "Da Nang", "HotelFrontImage": "https://d2lzo8rjhr36c.cloudfront.net//Images/Dubai/100530/1-ThumbNail.jpg", "IsRecomondedHotel": "FALSE", "IsActive": "active" } ], "Count": 1 }

Tag	Description
Count	Represent total number of hotels
HotelList	Represents HotelList
HotelId	Represents HotelId
HotelName	Represents HotelName
Description	Represents Description
Latitude	Represent Latitude
Longitude	Represent Longitude
Address	Represent Address
Rating	Represent Rating
CountryId	Represent CountryId
CountryName	Represent Address
CityId	Represent CityId
CityName	Represent CityName
HotelFrontImage	Represent HotelFrontImage
IsRecomondedHotel	Represent IsRecomondedHotel
IsActive	Represent status of hotel is active or not.
UpdatedDate	Represents UpdatedDate format: MM-DD-YYYY Example: 08-12-2018

Availability

The Availability API has been designed to provide list of all Hotels The following sections describe the hotellistsearch API request and response format. Currency set up done only once account is created and you have to use that Currency for transaction with api.

The Request URL:

baseurl/api/xconnect/Availability/

JSON Request Format:

{ "Token": "", "Request": { "Rooms": [ { "RoomNo": 1, "NoofAdults": 1, "NoOfChild": 1, "ChildAge": [ 1, 0 ] } ], "CityID": 1, "CheckInDate": "", "CheckOutDate": "", "NoofNights": 1, "Nationality": "", "Filters": { "IsRecommendedOnly": 0, "IsShowRooms": 1, "IsOnlyAvailable": 0, "StarRating": { "Min":0, "Max":5 }, "HotelIDs": "" } }, "AdvancedOptions": { "CustomerIpAddress": "11.111.111.111", "Currency": "" } }

Tag	Description	Optionality
Room	An array represents Room	Mandatory
RoomNo	Represents RoomNo	Mandatory
NoofAdults	Represents total number of Adults	Mandatory
NoOfChild	Represents total number of child.	Mandatory
ChildAge	Array represents child Age. (1 to 12)	Mandatory
CityID	Represents unique CityID.	Mandatory
Nationality	Represents unique Nationality.	Mandatory
CheckInDate	Represents CheckInDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018	Mandatory
CheckOutDate	Represents CheckOutDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018	Mandatory
NoofNights	Represents number of Nights	Mandatory
IsShowRooms	1 Show Rooms 0 HotelOnly	Mandatory
IsRecommendedOnly	1 Only Preferred Hotels 0 All Hotels	Mandatory
IsOnlyAvailable	1 Available only 0 Include Onrequest	Mandatory
StarRating	Selection of star rating between two categories.
Min	min=min star rating	0 star rating for unspecified or apartment
max	max=max star rating	Mandatory
HotelIDs	Represents list of comma seperated HotelIDs by city	Optional
CustomerIpAddress	Represents CustomerIpAddress	Ip address of final end user Mandatory
currency	Represents currency	Mandatory

JSON Response Format:

{ "AvailabilityRS": { "SearchKey": "", "Count": 1, "Currency": "", "HotelResult": [ { "StartPrice": 0, "HotelId": 0, "HotelOption": [ { "HotelOptionId": "", "MinPrice": 0, "IsCombineRoom": true, "HotelRooms": [ [ { "RoomNo": "", "RoomTypeName": "", "MealName": "", "Price": 0, "BookingStatus": "", "RoomToken": "" } ] ] } ] } ] } }

Tag	Description
Count	Represents Count.
SearchKey	SearchKey will use in next steps ,expires after 25 minutes. You have to do booking within that time limits.
Start price	Represents unique Price
HotelID	Represents unique Hotel id
HotelCode	Represents unique hotel code
Currency	Represents Currency.
Hoteloption	Array display detail.
HoteloptionId	Represents unique hoteloptionid
MinPrice	Represent Min Price
IsCombined	True = Multiple rooms are combined in one False = recieve list of rooms
HotelRooms	Array display details
RoomNo	Represents room number. You will get some combine rooms for multiple rooms search.
RoomTypeName	Represents room type
MealName	Represents MealName
Price	Represents Price
BookingStatus	Represents BookingStatus.
RoomToken	It display unique AvailToken which is provided by the system

Note:

As we have both direct inventories and dynamic rates also so for some cases you will receive combined room in multiple room search ,
so for easy to identify these rates we have now added new parameter in availability response IsCombined (true,false) if its true then rooms are combined to one room .
for example : if search is for
rooms :2
room 1 : 1 adult
room 2 : 2 adult
then id IsCombined =true that means both rooms are combined in one (roomNo: "1") ;
if False : then you recieve list of rooms(RoomNo:1,RoomNo:2).
and when you try to book such combined room you have to pass pax details separately for both the rooms.
-For Essential information you need to hit CancellationPolicy/Multi API

AvailabilityWithCancellation

The AvailabilityWithCancellation API has been designed to provide list of Hotels with cancellation policy. The following sections describe the hotellistsearch API request and response format. Currency set up done only once account is created and you have to use that Currency for transaction with api.

The Request URL:

baseurl/api/xconnect/AvailabilityWithCancellation/

JSON Request Format:

Tag	Description	Optionality
Room	An array represents Room	Mandatory
RoomNo	Represents RoomNo	Mandatory
NoofAdults	Represents total number of Adults	Mandatory
NoOfChild	Represents total number of child.	Mandatory
ChildAge	Array represents child Age. (1 to 12)	Mandatory
CityID	Represents unique CityID.	Mandatory
Nationality	Represents unique Nationality.	Mandatory
CheckInDate	Represents CheckInDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018	Mandatory
CheckOutDate	Represents CheckOutDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018	Mandatory
NoofNights	Represents number of Nights	Mandatory
IsShowRooms	1 Show Rooms 0 HotelOnly	Mandatory
IsRecommendedOnly	1 Only Preferred Hotels 0 All Hotels	Mandatory
IsOnlyAvailable	1 Available only 0 Include Onrequest	Mandatory
StarRating	Selection of star rating between two categories.
Min	min=min star rating	0 star rating for unspecified or apartment
max	max=max star rating	Mandatory
HotelIDs	Represents list of comma seperated HotelIDs by city	Optional
CustomerIpAddress	Represents CustomerIpAddress	Ip address of final end user Mandatory
currency	Represents currency	Mandatory

JSON Response Format:

Tag	Description
Count	Represents Count.
SearchKey	SearchKey will use in next steps ,expires after 25 minutes. You have to do booking within that time limits.
Start price	Represents unique Price
HotelID	Represents unique Hotel id
HotelCode	Represents unique hotel code
Currency	Represents Currency.
Hoteloption	Array display detail.
HoteloptionId	Represents unique hoteloptionid
MinPrice	Represent Min Price
IsCombined	True = Multiple rooms are combined in one False = recieve list of rooms
HotelRooms	Array display details
RoomNo	Represents room number. You will get some combine rooms for multiple rooms search.
RoomTypeName	Represents room type
MealName	Represents MealName
CancellationPolicy	Represents cancellation policy
Price	Represents Price
BookingStatus	Represents BookingStatus.
RoomToken	It display unique AvailToken which is provided by the system

Note:

Cancellation Policy

The CancellationPolicy for Hotel API has been designed to provide Price of cancellation for particular Room. The following section describes API request and response format.

The Request URL:

baseurl/api/xconnect/CancellationPolicy/

JSON Request Format:

{ "Token": "", "Request": { "SearchKey": "", "HotelOptionId": "", "RoomToken": "" }, "AdvancedOptions": { "CustomerIpAddress": "11.111.111.111", "Currency": "" } }

Parent Tag	Tag	Description	Optionality
Token	Token	Token	Mandatory
Request	Search key
	HotelOptionId	Represents unique HotelOptionID.	Mandatory
	RoomToken	Unique RoomToken which is provided by the system.	Mandatory
	currency	Represents currency	Mandatory
	CustomerIpAddress	Represents CustomerIpAddress	Ip address of final end user Mandatory

JSON Response Format:

{ "Error": [], "CancellationRS": { "Currency": "", "EssentialInformation": "", "CancellationPolicy": [ { "FromDate": "", "ToDate": "", "CancellationPrice": 0 }, { "FromDate": "", "ToDate": "", "CancellationPrice": 4 } ] } }

Parent Tag	Tag	Description
CancellationPolicy	FromDate	Represents FromDate
	ToDate	Represents ToDate.
	CancellationPrice	Represents cancellation price.
	Currency	Represents Currency.

Cancellation Policy Multi

The CancellationPolicyMulti for Hotel API has been designed to provide Price of cancellation for multiple Room in single request. The following section describes API request and response format.

The Request URL:

baseurl/api/xconnect/CancellationPolicyMulti

JSON Request Format:

{ "Token": "", "Request": { "SearchKey": "", "HotelOption": { "HotelOptionId": "", "HotelRooms": [ { "RoomNo": "1", "RoomToken": " " }, { "RoomNo": "2", "RoomToken": " " } ] } }, "AdvancedOptions": { "CustomerIpAddress": "11.111.111.111", "Currency": "USD" } }

Parent Tag	Tag	Description	Optionality
Token	Token	Token	Mandatory
Request	Search key
	HotelOptionId	Represents unique HotelOptionID.	Mandatory
	HotelRooms	Represents HotelRooms	Mandatory
	RoomToken	Represents RoomNo	Mandatory
	RoomToken	Unique RoomToken which is provided by the system.	Mandatory
AdvancedOptions
	CustomerIpAddress	Represents CustomerIpAddress	Ip address of final end user Mandatory
	currency	Represents currency	Mandatory

JSON Response Format:

{ "Error": [], "Currency": "MYR", "CancellationRS": [ { "RoomNo": " ", "RoomTypeName": " ", "MealName": " ", "EssentialInformation": " ", "CancellationPolicy": [ { "FromDate": " ", "ToDate": " ", "CancellationPrice": 0 }, { "FromDate": " ", "ToDate": " ", "CancellationPrice": } ] }, { "RoomNo": "2", "RoomTypeName": " ", "MealName": " ", "EssentialInformation": " ", "CancellationPolicy": [ { "FromDate": " ", "ToDate": " ", "CancellationPrice": 0 }, { "FromDate": " ", "ToDate": " ", "CancellationPrice": 0 } ] } ] }

Parent Tag	Tag	Description
Error
	ToDate	Represents ToDate.
	Currency	Represents Currency
CancellationRS
	RoomNo	Represents RoomNo
	RoomTypeName	Represents RoomTypeName
	MealName	Represents MealName
	EssentialInformation	Represents EssentialInformation
CancellationPolicy	FromDate	Represents FromDate
	ToDate	Represents ToDate
	CancellationPrice	Represents cancellation price.

PreBook

The PreBook API has been designed to check availability status of booking before book. This API must hit once for one booking or you will get duplication error.The following section describes API request and response format. in case of isCombineRoom= true we are going to do one change in previous response we sending price = 0 in other rooms and in roomNo=1 we giving you total price , but in new response we divide price in each room Total price will not change.only price is divided inside room.

The Request URL:

baseurl/api/xconnect/PreBook/

JSON Request Format:

{ "Token": "", "Request": { "SearchKey": "", "HotelOption": { "HotelOptionId": "", "HotelRooms": [ { "RoomNo": "1", "RoomToken": "" } ] } }, "AdvancedOptions": { "CustomerIpAddress": "11.111.111.111", "Currency": "" } }

Parent Tag	Tag	Description	Optionality
Token	Token	Token	Mandatory
Request	Search key
	HotelOptionId	Represents HotelOptionId	Mandatory
	HotelRooms	An array represents room details	Mandatory
	RoomNo	Represents room number	Mandatory
	RoomToken	Unique RoomToken which is provided by the system.	Mandatory
	CustomerIpAddress	Represents CustomerIpAddress	Ip address of final end user Mandatory
	currency	Represents currency	Mandatory

JSON Response Format:

{ "PreBookRS": { "HotelOption": { "HotelName": "", "Nationality": "", "BookingToken": "", "Status": "Bookable", "IsPriceChange": 0, "CheckInDate": "", "CheckOutDate": "", "TotalPrice": 0, "HotelRooms": [ { "UniqueId": 0, "RoomNo": "1", "RoomTypeName": "", "MealName": "", "Price": 0, "PriceChange": { "OldPrice": 0, "NewPrice": 0 } } ] } }, "Currency": "" }

JSON Response (Example ) IsCombineRoom=true

{ "Error": [], "PreBookRS": { "HotelOption": { "HotelName": "AVANI Deira Dubai Hotel", "Nationality": "malaysia", "BookingToken": "BookingToken" , "Status": "Bookable", "IsPriceChange": 0, "CheckInDate": "01-21-2020", "CheckOutDate": "01-22-2020", "TotalPrice": 522.38, "HotelRooms": [ { "UniqueId": 158841, "RoomNo": "1", "RoomTypeName": "2 X Single room ", "MealName": "Room Only", "Price": 261.19, "PriceChange": { "OldPrice": 0, "NewPrice": 0 } }, { "UniqueId": 158842, "RoomNo": "2", "RoomTypeName": "2 X Single room ", "MealName": "Room Only", "Price": 261.19, "PriceChange": { "OldPrice": 0, "NewPrice": 0 } } ] }, "Currency": "AED" } }

Parent Tag	Tag	Description
PreBookRS
HotelOption
	HotelName	Represents HotelName
	Nationality	Represents Nationality
	BookingToken	Unique BookingToken which is provided by the system. And used for final booking request
	Status	If status is bookable than only proceed for booking.
	IsPriceChange	0 Represents Not Change in IsPriceChange 1 you have to notify price to customer before booking
	CheckInDate	Represents CheckInDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018
	CheckOutDate	Represents CheckOutDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018
	TotalPrice	Represents TotalPrice
HotelRooms		Arrary represents Hotelrooms
	UniqueId	Represents UniqueId
	RoomNo	Represents RoomNo
	RoomTypeName	Represents RoomTypeName
	MealName	Represents MealName
	Price	Represents Price
	PriceChange	Represents PriceChange
	OldPrice	Represents OldPrice
	NewPrice	Represents NewPrice
	Currency	Represents Currency.

Book

The Book API has been designed to give booking details .The following section describes API request and response format. After getting response or error in book response. you have to mandatory perform booking detail api to get the actual status of booking using your internal reference or reference number from Bookresponse.

The Request URL:

baseurl/api/xconnect/Book/

JSON Request Format:

{ "Token": "", "Request": { "SearchKey": "", "BookRQ": { "BookingToken": "", "TotalPrice": 90, "InternalReference": "", "HotelRooms": [ { "UniqueId": 44144, "RoomNo": 1, "IsLead": "1", "PaxType": "Adult", "Prefix": "Mr.", "FirstName": "IOS", "LastName": "Test", "ChildAge": "0" }, { "UniqueId": 44145, "RoomNo": 2, "IsLead": "1", "PaxType": "Adult", "Prefix": "Mrs.", "FirstName": "test", "LastName": "test", "ChildAge": "0" } ] } }, "AdvancedOptions": { "CustomerIpAddress": "11.111.111.111", "Currency": "USD" } }

Parent Tag	Tag	Description	Optionality
Token	Token	Token	Mandatory
Request	Search key
Book	BookingToken	Unique BookingToken which is provided by the system.	Mandatory
	TotalPrice	Represents Price	Mandatory
	InternalReference	your internal reference. should be 10 max character (No duplication allowed)	Mandatory
	HotelRooms	An array represent HotelRoom Details.	Mandatory
	UniqueId	Represents UniqeId	Mandatory
	RoomNo	Represents RoomNo	Mandatory
	IsLead	0 Represents No IsLead For 1 booking you have to set ISLead = 1 and IsLead passeger must adult.	Mandatory
	PaxType	Represents Adult / Child.	Mandatory
	Prefix	Represents Mr. / Mrs. /Ms.	Mandatory
	FirstName	Represents FirstName	Mandatory
	LastName	Represents LastName	Mandatory
	ChildAge	Represents ChildAge	Mandatory
	UniqueId	Represents UniqeId	Mandatory
	CustomerIpAddress	Represents CustomerIpAddress	Ip address of final end user Mandatory
	currency	Represents currency	Mandatory

JSON Response Format:

{ "BookRS": { "BookingId": 0, "ReferenceNo": "1577MA011900115", "InternalReference": "animesh" } , "Currency": "" , "Error": [] }

Parent Tag	Tag	Description
BookRS
	BookingId	Represents BookingId
	ReferenceNo	You need to show reference number on your voucher.
	InternalReference	Represents InternalReference
	Currency	Represents Currency.
	Error	Array Represents Error

Booking Detail

API has been designed to Generate bookingDetails .The following section describes API request and response format. Only one ID can be passed. You can get booking details using either BookigID or your internalReference

The Request URL:

baseurl/api/xconnect/BookingDetail

JSON Request Format:

{ "Token": "", "Request": { "BookingDetailRQ": { "BookingId": "0", "InternalReference": "", "ReferenceNo": "" } }, "AdvancedOptions": { "CustomerIpAddress": "11.111.111.111", "Currency": "" } }

Parent Tag	Tag	Description	Optionality
Token	Token	Token	Mandatory
Request
BookingDetailRQ
	BookingId	Represents BookingId	Optional
	InternalReference	Represents InternalReference	optional
	ReferenceNo	Represents ReferenceNo	optional
	CustomerIpAddress	Represents CustomerIpAddress	Ip address of final end user Mandatory
	currency	Represents currency	Mandatory

JSON Response Format:

{ "BookingDetailRS": { "HotelOption": { "HotelName": "", "HotelId": "", "Nationality": "", "BookingId": "", "InternalReference": "", "CheckInDate": "", "CheckOutDate": "", "BookingDate": "", "LeadPaxName": "", "TotalPrice": "", "HotelRooms": [ { "RoomNo": "", "RoomTypeName": "", "MealName": "", "Price": "", "BookingStatus": "Confirmed", "CancellationPolicy": [ { "FromDate": "", "ToDate": "", "CancellationPrice": 0 } ], "Passenger": [ { "IsLead": "", "PaxType": "", "Name": "", "ChildAge": "" } ] } ] } } , "Currency": "" , "Error": [] }

Parent Tag	Tag	Description
BookingDetailRS
	HotelOption
	HotelName	Represent HotelName
	HotelId	Represent HotelId
	Nationality	Represent Nationality
	BookingId	Represent BookingId
	InternalReference	Represents InternalReference
	CheckInDate	Represents CheckOutDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018
	CheckOutDate	Represents CheckOutDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018
	BookingDate	Represents BookingDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018
	LeadPaxName	Represents LeadPaxName
	TotalPrice	Represents TotalPrice
	HotelRooms	Array Represents HotelRooms
	BookingStatus	Represents booking status with details Vouchered : Confirmed Confirmed : Confirmed Completed : Travel done. Cancelled : booking cancelled On Request : On Request Not Confirmed : Not Confirmed Cancel Charge: cancel charges if any for booking
	RoomNo	Represents RoomNo
	RoomTypeName	Represents RoomTypeName
	MealName	Represents MealName
	Price	Represents Price
	CancellationPolicy	Array represents CancellationPolicy
	FromDate	Represents FromDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018
	ToDate	Represents ToDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018
	CancellationPrice	Represents CancellationPrice
	Passenger	No special character allowed max length 20 character. Douplication passenger not allowed.
	IsLead	Represents lead pax
	PaxType	Represents Adult / Child
	Prefix	Represents Mr./Ms./Miss
	Name	Represents Name
	ChildAge	Represents ChildAge
	Currency	Represents Currency.
	Error	Array Represents Error

Check HotelCancellation Charges

The Request URL:

baseurl/api/xconnect/CheckHotelCancellationCharges

JSON Request Format:

{ "Token": "", "Request": { "CheckHotelCancellationChargesRQ": { "BookingId": "0", "InternalReference": "", "ReferenceNo": "1577MA011900115" } }, "AdvancedOptions": { "CustomerIpAddress": "11.111.111.111", "Currency": "USD" } }

Parent Tag	Tag	Description	Optionality
Token	Token	Token	Mandatory
Request
CheckHotelCancellationChargesRQ
	BookingId	Represents BookingId	Mandatory
	InternalReference	your internal reference.	Mandatory
	ReferenceNo		Mandatory
	CustomerIpAddress	Represents CustomerIpAddress	Ip address of final end user Mandatory
	currency	Represents currency	Mandatory

JSON Response Format:

{ "CheckHotelCancellationChargesRS": { "HotelOption": { "BookingId": "", "TotalPrice": "", "TotalCharge": 0, "TotalRefund": "", "CancelCode": "", "HotelRooms": [ { "BookingDetailId": 0, "RoomTypeName": "", "Price": "", "RefundAmount": "" } ] } } , "Currency": "" , "Error": [] }

Parent Tag	Tag	Description
CheckHotelCancellationChargesRS
	HotelOption	Represents HotelOption
	BookingId	Represents BookingId
	TotalPrice	Represents TotalPrice
	TotalCharge	Represents TotalCharge
	TotalRefund	Represents TotalRefund
	CancelCode	Represents CancelCode
	HotelRooms	An Array Represents HotelRooms
	BookingDetailId	Represents BookingDetailId
	RoomTypeName	Represents RoomTypeName
	Price	Represent Price
	RefundAmount	Represents RefundAmount
	Currency	Represents Currency.
	Error	An Array Represent Error

Cancel Booking

API has been designed to cancle booking .The following section describes API request and response format.

The Request URL:

baseurl/api/xconnect/CancelBooking/

JSON Request Format:

{ "Token": "", "Request": { "CancelRQ": { "BookingId": "", "BookingDetailId": "0", "CancelCode": "", "Reason": "" "CancelAll":1 } }, "AdvancedOptions": { "CustomerIpAddress": "11.111.111.111", "Currency": "USD" } }

Parent Tag	Tag	Description	Optionality
Token	Token	Token	Mandatory
Request
CancelRQ	BookingID	Represent BookingID	Mandatory
	BookingDetailId	BookingDetailId	Value = 0 to cancel whole booking.
	CancelCode	CancelCode	Mandatory
	Reason	Represents Reason	Mandatory
	CancelAll	CancelAll	Value = 1 to cancel whole booking.
	CustomerIpAddress	Represents CustomerIpAddress	Ip address of final end user Mandatory
	currency	Represents currency	Mandatory

Note : To cancel whole booking you must have to pass cancelAll with value 1 and BookingDetailId=0

JSON Response Format:

{ "CancelRS": { "HotelOption": { "BookingId": "", "HotelRooms": [ { "RoomTypeName": "", "Message": "Hotel Cancelled Successfully!!!", "CancelStatus": 1 } ] } } , "Currency": "" , "Error": [] }

Parent Tag	Tag	Description
CancelRS
HotelOption
	BookingId	Represents BookingId
	HotelRooms	Array Represents HotelRooms
	RoomTypeName	Represents RoomTypeName
	Message	Represents Message
	CancelStatus	1 Represents booking cancel
	Currency	Represents Currency.
	Error	Array Represents Error

Booking Search

API has been designed to Generate bookingDetails .Date range allowed 31 days. The following section describes API request and response format.

The Request URL:

baseurl/api/xconnect/BookingSearch

JSON Request Format:

{ "Token": "", "Request": { "BookingSearchRQ": { "SearchBy": "bookingdate", {bookingdate or checkindate}, "OnlyAPI":1, "SearchCriteria": { "Dates": { "FromDate": "03-19-2019", "ToDate": "04-19-2019" } } } }, "AdvancedOptions": { "Currency": "MYR" } }

Parent Tag	Tag	Description	Optionality
Token	Token	Token	Mandatory
Request			Mandatory
BookingSearchRQ			Mandatory
	SearchBy	Search By BookingDate or CheckingDate	Mandatory
	OnlyAPI	0 Represents All booking 1 Represents only apibookings	Mandatory
SearchCriteria
Dates
	FromDate	Represents FromDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018	Mandatory
	ToDate	Represents ToDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018	Mandatory
AdvancedOptions	Currency	Represents Currency	Mandatory

Note : OnlyAPI = 0 Represents All booking OnlyAPI = 1 Represents Api booking

JSON Response Format:

{ "Error": [], "BookingSearchRS": { "BookingList": [ { "HotelName": "J", "HotelId": "1", "BookingId": , "InternalReference": "", "ReferenceNo": "AAA", "CheckInDate": "08-14-2019", "CheckOutDate": "08-15-2019", "BookingDate": "04-01-2019", "TotalPrice": 1, "BookingStatus": "cancelled", "IsAPI":true ,false } ], "Currency": "MYR" } }

Parent Tag	Tag	Description
Error
BookingSearchRS
BookingList
	HotelName
	HotelId	Represents HotelId
	InternalReference	Represent InternalReference
	ReferenceNo	Represent ReferenceNo
	CheckinDate	Represents CheckinDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018
	CheckOutDate	Represents CheckOutDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018
	BookingDate	Represents BookingDate. Date should be in the format: MM-DD-YYYY Example: 08-12-2018
	TotalPrice	Represents TotalPrice
	BookingStatus	Represents BookingStatus
	IsAPI	IsAPI = True Represents booking made via api IsAPI = False Represents booking made direct on client portal
	Currency	Represents Currency.

Certification process

Please go through certification process in order to get live access.

Step 1 : Work Flow.

To ensure what API methods you are using, flow of method calls for these methods. This will help us to verify the integration.

Step 2 : Test Cases Execution by client.

Here we are providing a list of test cases needs to be executed .
Request / response for these cases will be required for verification .

[Test 1] :
Room 1 – Adult 1 (1 night)
[Test 2] :
Room 1 – Adult 2, Child 2 (3 night)
[Test 3] :
Room 1 – Adult 1 | Room 2 – Adult 1 both (2 night)
[Test 4] :
Room 1 – Adult 1, Child 1 | Room 2 – Adult 1 (1 night)
Provide Logs As below
[Test 1] : Availability→CancellationPolicyMulti→PreBook→Book
BookingDetail→CheckHotelCancellationCharges→CancelBooking.

Step 3: Test Verification

Technical team will verify the test cases using Request / Response and suggest if there is any change required.

Step 4: Client Portal verification

After completion of step 3, you have to provide test link of your integration website to verify the integration flow.

Step 5: Sign off and Live access

On successful completion of all the above steps, we will give sign off and provide Live access details.