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 Method	Content-Type
POST	application/json
The requested method.	The content type.

Go-Test/Live Process

In order to start testing, please notify our support team via e-mail at supportapi@technoheaven.net.

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	Bad Request
3	401	Unauthorized
4	403	Forbidden
5	404	Not Found
6	500	Internal Server Error
7	503	Service Unavailable

Image Path

Root URL : https://d2g4iwshf24scx.cloudfront.net
ImagePath : /Images/Dubai/5104/1-ThumbNail.jpg
You will get this in static json data .
Complete URL : https://d2g4iwshf24scx.cloudfront.net/Images/Dubai/5104/1-ThumbNail.jpg

Date Format

Date format send to Payload MM/DD/YYY

Getcitieswithhotel

The getcitieswithhotel API has been designed to provide Country and City data with available count of hotel in particular city.

The following sections describes the getgiatadatav2 API Request and Response Format

The Request URL:

http://mobileapiwithinearth.technoheaven.com/api/Hotel/GetHotelAPIDetails

JSON Request Format:

{ "IsB2B":"IsB2B", "APIName":"getcitieswithhotel", "payload": {"prefix":"prefix"}, "token":"YOUR TOKEN" }

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

Parent Tag	Tag	Description	>Optionality
IsB2B	IsB2B	-	-
APIName	APIName	APIName is key factor	Mandatory
payload	-	-	-
-	prefix	String representing prefix	Mandatory
token	token	You have to put unique token which is provided by the system.	Mandatory

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

Booking Status

No	Booking Status	Description
1	Vouchered	Vouchered If your booking status is vouchered, you can get supplier confirmation number 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	Completed	Completed It is completed at their travel date.
5	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.

Access Information

API NAME	Access Type MandatoryOptional
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

Ticketing tours

NonTicketing tours

Static Data Request

*Applicable to clients that will pull tour information as well (inclusions, description, policies, T&C)

Some data changes frequently and therefore it can be stored locally by the api client. The following types of static data will be needed to make other types of json request to fetch the json file you need to authenticate it by adding user name, password, IP to get static data for city wise tours.

Please read below for more details.

Country & City Static Data

JSON code Request URL:

http://dlvz9zmk16t7v.cloudfront.net/Tour/_CountryCityStaticData.json

If you hit this URL you will get all Country & city ID with respective of its name.

Once the request is applied you will get the list of country & city. For static data as mentioned above you need to generate it country and city wise.

Static Data Response

After you have initiated the request of static data our system will process it and send you results.

Static Data Response

Request URL:

http://dlvz9zmk16t7v.cloudfront.net/Tour/statictourdata_13668.json

If you want Abu Dhabi data then hit the same URL with Abu Dhabi city ID(13236)

So your request URL will be

http://dlvz9zmk16t7v.cloudfront.net/Tour/statictourdata_13236.json

statictourdata_13668.json : Here the mentioned ID 13668 is Dubai City ID

Here you can get response of all Static data

JSON Response Format:

"TourDetails": [{ "CityTourID": CityTourID, "TourName": "TourName ", "CountryId":CountryId, "CityId”:CityId, "ChildFromAge": ChildFromAge, "ChildToAge": ChildToAge, "InfantFromAge": InfantFromAge, "InfantToAge": InfantToAge, "CityTourTypeId": CityTourTypeId, "IsComboTour": IsComboTour, "IsTimeSlot": IsTimeSlot, "SpecialNoteWF": “SpecialNoteWF ", "CancellationPolicyID": CancellationPolicyID, "UsefulInformationID": UsefulInformationID, "TermsAndConditionID": TermsAndConditionID, "FAQCategoryID": FAQCategoryID }], "TourImage": [{ "CityTourID": CityTourID "ImageCaptionName": "ImageCaptionName", "ImagePath": "ImagePath", "IsFrontImage": IsFrontImage "ImagePathThumbNail": "/ImagePathThumbNail" }], "TourDescription": [{ "CityTourID": CityTourID, "TourDescription": "TourDescription", "TourInclusion":"TourInclusion", "TourShortDescription":"TourShortDescription" }], "TourTime": [{ "CityTourID": CityTourID, "TourTimeId": TourTimeId "DeparturePoint": "DeparturePoint", "DepartureTime": "DepartureTime", "ReportingTime": "ReportingTime", "Duration": "Duration", "TourLanguage": "TourLanguage", "Meals": "Meals" }], "TourTimeOption": [{ "TourTimeOptionId": TourTimeOptionId "TourTimeId": TourTimeId "OptionName": "OptionName", "Description": "Description", "DepartureTime": "DepartureTime", "ByOrder": ByOrder, "StartTime": "StartTime" "CityTourID":"CityTourID" } "TourTransfer": [{ "CityTourID": CityTourID, "TransferId": TransferId, "MinimumPax":MinimumPax, "IsDefault": IsDefault, "TransferName":"TransferName" }, "TourCancellationPolicy": [{ "CancellationPolicyId": CancellationPolicyId, "CancellationPolicy": "CancellationPolicy", "Description": "Description", "IsRefundable": IsRefundable "RefundPolicy": "RefundPolicy" }], "TourUsefulInformation": [{ "UsefulInformationDetail": "UsefulInformationDetail", "FAQCategory": "FAQCategory", "UsefulInformationID": UsefulInformationID }], "TourTermsAndCondition": [{ "TermsAndConditionDetail": "TermsAndConditionDetail", "TermsAndCondition": "TermsAndCondition", "TermsAndConditionID": TermsAndConditionID }], "TourFAQCategory": [{ "FAQCategoryDetail": "FAQCategoryDetail", "FAQCategory": "FAQCategory", "FAQCategoryID": FAQCategoryID }], "TcketingTourTermsAndCondition":[{ "CityTourId": "CityTourId" "TermsAndConditions":"TermsAndConditions” }]}

Parent Tag	Tag	Description	Optionality
TourDetails	CityTourID	String representing unique CityTourID	Mandatory
	TourName	String representing unique TourName	Mandatory
	ChildFromAge	String representing unique ChildFromAge	Mandatory
	ChildToAge	String representing unique ChildToAge	Mandatory
	InfantFromAge	String representing unique InfantFromAge	Mandatory
	InfantToAge	String representing unique InfantToAge	Mandatory
	CityTourTypeId	String representing unique CityTourTypeId	Mandatory
	IsTimeSlot	String representing unique IsTimeSlot	Mandatory
	SpecialNoteWF	String representing unique SpecialNoteWF	Optional
	CancellationPolicyID	String representing unique CancellationPolicyID	Mandatory
	UsefulInformationID	String representing unique UsefulInformationID	Optional
	TermsAndConditionID	String representing unique TermsAndConditionID	Mandatory
	FAQCategoryID	String representing unique FAQCategoryID	Optional
TourImage	CityTourID	String representing unique CityTourID	Mandatory
	ImageCaptionName	String representing ImageCaptionName	Optional
	ImagePath	String representing image Url.	Mandatory
	IsFrontImage	String representing IsFrontImage. Boolean field: TRUE or FALSE.	Optional
	ImagePathThumbNail	String representing ImagePathThumbNail	Optional
TourDescription	CityTourID	String representing unique CityTourID	Mandatory
	TourDescription	String representing TourDescription	Mandatory
TourTime	CityTourID	String representing unique CityTourID	Mandatory
	TourTimeId	String representing unique TourTimeId	Mandatory
	DeparturePoint	String representing DeparturePoint	Mandatory
	DepartureTime	String representing DepartureTime	Mandatory
	ReportingTime	String representing ReportingTime	Mandatory
	Duration	String representing Duration	Optional
	TourLanguage	String representing TourLanguage	Optional
	Meals	String representing Meals	Optional
TourTimeOption	TourTimeOptionId	String representing unique TourTimeOptionId	Mandatory
	TourTimeId	String representing unique TourTimeId	Mandatory
	OptionName	String representing OptionName	Mandatory
	Description	String representing Description	Optional
	DepartureTime	String representing DepartureTime	Optional
	ByOrder	String representing unique ByOrder	Optional
	StartTime	String representing StartTime	Mandatory
TourTransfer	CityTourID	String representing unique CityTourID	Mandatory
	TransferId	String representing TransferId	Mandatory
	MinimumPax	String representing MinimumPax	Mandatory
	IsDefault	String representing IsDefault	Mandatory
TourCancellationPolicy	CancellationPolicyId	String representing unique CancellationPolicyId	Mandatory
	Description	String representing Description	Mandatory
	IsRefundable	String representing IsRefundable Boolean field: TRUE or FALSE.	Mandatory
	RefundPolicy	String representing RefundPolicy	Mandatory
TourUsefulInformation	UsefulInformationDetail	String representing UsefulInformationDetail	Optional
	FAQCategory	String representing FAQCategory	Optional
	UsefulInformationID	String representing unique UsefulInformationID	Mandatory
TermsAndConditionDetail	TermsAndConditionDetail	String representing TermsAndConditionDetail	Mandatory
	TermsAndCondition	TermsAndCondition String representing TermsAndCondition	Mandatory
	TermsAndConditionID	String representing unique TermsAndConditionID	Mandatory
TourFAQCategory	FAQCategoryDetail	String representing FAQCategoryDetail	Optional
	FAQCategory	String representing FAQCategory	Optional
	FAQCategoryID	String representing unique FAQCategoryID	Optional
TicketingTourTermsAndCondition	CityTourId	String representing unique CityTourId	Mandatory
	TermsAndConditions	String representing TermsAndConditions	Mandatory

Price Request / Get tour price

The Gettourprice API has been designed to provide list of all tour with display Minimum price for particular city. The following sections describes the Get tour price request and response format

Request URL

http://api.withinearth.com/api/TourData/GetTourData

This URL is for fetching dynamic data

JSON Request Format:

{ "apiname": "gettourprice", "payload": { "CityId": " CityId ", "travelDate”: " travelDate " }, "token": "YOUR TOKEN" }

Tag	Parent Tag	Description	Optionality
apiname	apiname	apiname is the key factor	Mandatory
	Payload
CityId	Payload	String representing Unique CityId	Mandatory
travelDate	Payload	It is travel date. Date should be in the format: MM/DD/YYYY Example: 07-28-2018	Mandatory
Token		You have to put unique token which is provided by the system	Mandatory

JSON Response Format:

{ "TourPrice": [{ "CityTourId": CityTourId, "Duration": " Duration", "CityTourTypeId": " CityTourTypeId ", "TransferId": TransferId, "TransferName": " TransferName ", "IsDiscount": IsDiscount, "Recommended": Recommended, "TourTimeOptionId": TourTimeOptionId, "FromPax": FromPax, "ToPax": ToPax, "FinalAdultAmount": #.##, "FinalAdultAmountWithoutDiscount": ##.##, "FinalChildAmount": #.#, "FinalChildAmountWithoutDiscount": ##.## "SupplierName":"SupplierName" }, }

Tag	Parent Tag	Description
TourPrice
CityTourId	TourPrice	String representing unique CityTourId
CityTourTypeId	TourPrice	String representing unique CityTourTypeId
Duration	TourPrice	You will get approximate time period
TransferId	TourPrice	String representing unique ID for transfer type. IDs are as mention in Documents and Downloads section.
TransferName	TourPrice	String representing unique name provided for every transfer option. Transfer names are as mention in Documents and Downloads section.
IsDiscount	TourPrice	Does Tour option provides discount. For particular tour. Boolean field: 0 or 1. 0 – Not Available 1 – Available
Recommended	TourPrice	Is this tour Recommended (suggested). Boolean field: 0 or 1. 0 – Not Available 1 – Available
TourTimeOptionId	TourPrice	String representing unique TourTimeOptionId
FromPax	TourPrice	Which give you start range of pax
ToPax	TourPrice	Which give you end range of pax
FinalAdultAmount	TourPrice	It is display price for adult
FinalAdultAmountWithoutDiscount	TourPrice	It is display price for adult without discount
FinalChildAmount	TourPrice	It is display price for child
FinalChildAmountWithoutDiscount	TourPrice	It is display price for child without discount

Tours Option

The Tour Option API provides a list of available Tour Options with their Transfer option and final adult and child amount.

Request URL

http://api.withinearth.com/api/TourData/GetTourData

This URL is for fetching dynamic data

JSON Request Format:

{ "apiname": "gettourlist_options", "payload": { "travelDate" : " travelDate ", "TourId" : TourId, "TourTypeId" : TourTypeId, "transferId" : transferId, "Adult" : Adult, "Child" : Child, "optionId" : optionId, "tourtimelotid" : tourtimelotid }, "token": "YOUR TOKEN" }

Tag	Parent Tag	Description	Optionality
apiname	apiname	apiname is the key factor	Mandatory
	Payload
travelDate	Payload	It is travel date. Date should be in the format: MM/DD/YYYY Example: 07-28-2018	Mandatory
TourId	Payload	String representing unique TourId	Mandatory
TourTypeId	payload	String representing unique identification for Tour category. Example: 1.City Tours 2.Desert Safari	Optional
Adult	Payload	You need to pass the count Of adults	Mandatory
Child	Payload	You need to pass the count Of child	Mandatory
optionId	Payload	String representing unique optionId.	Optional
tourtimelotid	Payload	String representing unique Id for particular slot of time. EventId&TourTimeSlotId are same.	Optional
Token	Payload	You have to put unique token which is provided by the system	Mandatory

JSON Response Format:

{ "TourOptionPrice": [{ "TourId": "TourId", "TransferId": "TransferId", "TransferMinPax": "TransferMinPax", "TourTimeOptionId": "TourTimeOptionId", "AdultAmount": "AdultAmount", "ChildAmount": "ChildAmount", "StartTime": "StartTime", "CutOff": "CutOff", "InfantAge": "InfantAge", "ChildAge": "ChildAge", "TimeZone": "TimeZone" }, { "TourId": "TourId", "TransferId": "TransferId", "TransferMinPax": "TransferMinPax", "TourTimeOptionId": "TourTimeOptionId", "AdultAmount": "AdultAmount", "ChildAmount": "ChildAmount", "StartTime": "StartTime", "CutOff": "CutOff", "InfantAge": "InfantAge", "ChildAge": "ChildAge", "TimeZone": "TimeZone" }], "TourOptionPriceDetails": [{ "TourId": "TourId", "TransferId": "TransferId", "TransferMinPax": "TransferMinPax", "TourTimeOptionId": "TourTimeOptionId", "FromPax": "FromPax", "ToPax": "ToPax", "AdultAmount": "AdultAmount", "ChildAmount": "ChildAmount", "StartTime": "StartTime" "CutOff": "CutOff", "InfantAge": "InfantAge", "ChildAge": "ChildAge", "TimeZone": "TimeZone" }, { "TourId": "TourId", "TransferId": "TransferId", "TransferMinPax": "TransferMinPax", "TourTimeOptionId": "TourTimeOptionId", "FromPax": "FromPax", "ToPax": "ToPax", "AdultAmount": "AdultAmount", "ChildAmount": "ChildAmount", "StartTime": "StartTime" "CutOff": "CutOff", "InfantAge": "InfantAge", "ChildAge": "ChildAge", "TimeZone": "TimeZone" }] }

Tag	Parent Tag	Description
TourOptionPrice		JsonArray contain the Default Transfer type option of tours with Price .
TourId	TourOptionPrice	String representing unique TourID.
TransferId	TourOptionPrice	String representing unique ID for transfer type. IDs are as mention in Documents and Downloads section
TransferMinPax	TourOptionPrice	TransferMinPax Which shows you the min. pax occupancy of tour.
TourTimeOptionId	TourOptionPrice	String representing unique TourTimeOptionID.
AdultAmount	TourOptionPrice	It is the calculated price of particular tour option with transfer type and number of adults. (You need to pass this amount in the Booking request API)
ChildAmount	TourOptionPrice	It is the calculated price of particular tour option with transfer type and number of child. (You need to pass this amount in the Booking request payload)
StartTime	TourOptionPrice	StartTime is the tours Operating Time which mean that tours is started from that time.
CutOff	TourOptionPrice	- When the tours give you some cutoff time like 3 hr and my tours starttime is : 17:00:00 that means you can book this tours earlier of the starttime of the tour
InfantAge	TourOptionPrice	Age of infant is described.
ChildAge	TourOptionPrice	Age of Child is described.
TimeZone	TourOptionPrice	TimeZone (UTC +04 : 00) destination time zone.
FromPax	TourOptionPrice	Describes start range of pax
ToPax	TourOptionPrice	Describes end range of pax
TourOptionPriceDetails	TourOptionPrice	JsonArray contains Optional Transfer tour options Price.

Get Tour Time Slot

For the static data of the city where its specified true and false (Istimeslot), where ever its True, then you need to hit the API to get the multiple time slot.

Request URL

http://api.withinearth.com/api/TourData/GetTourData

JSON Request Format:

{ "apiname": "gettourtimeslot", "payload": { "TourID": " TourID ", "TourTimeOptionId": " TourTimeOptionId ", "travelDate": " travelDate " }, "token": " YOUR TOKEN " }

Tag	Parent Tag	Description	Optionality
apiname	apiname	apiname is the key factor	Mandatory
	Payload
TourID	Payload	String representing Unique CityId	Mandatory
TourTimeOptionId	Payload	String representing TourTimeOptionId.	Mandatory
travelDate	Payload	It is travel date. Date should be in following format: MM/DD/YYYY Example: 07-28-2018	Mandatory
Token		You have to put unique token which is provided by the system	Mandatory

In response of gettourtimeslot API you get time slot id/Event id for particular tour option for the selected time and its availability for that particular time

JSON Response Format:

{ "TimeSlot": [ { "EventID": " EventID ", "EventName": " EventName ", "StartDateTime": " StartDateTime ", "EndDateTime": " EndDateTime ", "EventTypeID": " EventTypeID ", "ResourceID": " ResourceID ", "Available": " Available ", "Status": " Status ", "TourTimeOptionId": " TourTimeOptionId ", "IsXmlSupplier": " IsXmlSupplier ", "TourTimeSlotId": " TourTimeSlotId " }

Tag	Parent Tag	Description
TimeSlot	TimeSlot	JsonArray contain the Tours options timeslot.
EventID	TimeSlot	String representing unique ID for particular slot/Event of time.
StartDateTime	TimeSlot	StartDateTime Format YYYY-MM-DDThh:mm:ss Example: 2018-07-28T00:05:00
EndDateTime	TimeSlot	EndDateTime format YYYY-MM-DDThh:mm:ss Example : 2018-07-28T00:05:00
EventTypeID	TimeSlot	IsXmlSupplier system processing parameter
ResourceID	TimeSlot	IsXmlSupplier system processing parameter
Available	TimeSlot	Count of Available Ticket.
Status	TimeSlot	If status = 0 tickets available & status = 2 tickets not available.
TourTimeOptionId	TimeSlot	String representing unique TourTimeOptionId.
IsXmlSupplier	TimeSlot	IsXmlSupplier system processing parameter. Boolean field: TRUE or FALSE.
TourTimeSlotId	TimeSlot	String representing unique Id for particular slot of time. EventId &TourTimeSlotId are same.

Tour Availability Request

The Availability API enables to determine if the tour has availability in real time.

Request URL

http://api.withinearth.com/api/TourData/GetTourData

This URL is for fetching dynamic data

JSON Response Format:

{ "apiname": "touravalibility", "payload": { "TourID": " TourID", "TourTimeOptionId": “TourTimeOptionId", "NoOfChild": NoOfChild, "NoOfInfant": NoOfInfant, "TourTimeSlotId": TourTimeSlotId, "NoOfAdult": NoOfAdult, "transferId": transferId, "travelDate": “travelDate" }, "token": “YOUR TOKEN" }

Tag	Parent Tag	Description	Optionality
apiname	apiname	apiname is the key factor	Mandatory
	Payload
TourID	Payload	String representing unique TourId	Mandatory
TourTimeOptionId	Payload	String representing unique TourTimeOptionId	Mandatory
NoOfChild	payload	You need to pass count Of child	optional
NoOfInfant	Payload	You need to pass count Of Infant	Optional
TourTimeSlotId	Payload	String representing unique TourTimeSlotId	optional
NoOfAdult	Payload	You need to pass count Of Adult	Optional
transferId	Payload	String representing unique ID for transfer type. IDs are as mention in Documents and Downloads section	Optional
travelDate	Payload	It is travel date. Date should be in the format: MM/DD/YYYY Example: 07-28-2018	Mandatory
Token		You have to put unique token which is provided by the system	Mandatory

Response

Message :

1."success"

2. "You cannot book this tour for Friday".

Booking Request

The save booking method is used to generate a Booking which contains one or more successfully booked tours. Each booked tour will have a unique reference number (Booking Code) which can be individually vouchered & cancelled.

The format of the request and response for this method is explained in the following sections.

Request URL

http://api.withinearth.com/api/Common/GetCommonAPIDetails

This URL is for fetching dynamic data

JSON Code (Single Tours):

{ "apiname": " apiname ", "payload": { "lstPassenger": [ { "PaxType": " PaxType ", "Email": " Email ", "FirstName": " FirstName ", "LastName": " LastName ", "Message": " Message ", "Mobile": " Mobile ", "Prefix": " Prefix.", "TourId": " TourId " } ], "lstTourdata": [ { "TourId": TourId, "TransferId": TransferId, "TourTimeOptionId": TourTimeOptionId, "NoOfAdult": " NoOfAdult ", "NoOfChild": " NoOfChild ", "NoOfInfant": " NoOfInfant ", "AdultRate": " AdultRate ", "ChildRate": ChildRate, "CheckInDate": " CheckInDate ", "ServiceTotal": ServiceTotal, "StartTime": " StartTime ", "EventID": " EventID ", "PickDetails": " PickDetails " } ] }, "token": " token " }

Multiple Tour :

{ "apiname": " apiname ", "payload": { "lstPassenger": [{ "PaxType": " PaxType ", "Email": " Email ", "FirstName": " FirstName ", "LastName": " LastName ", "Message": " Message ", "Mobile": " Mobile ", "Prefix": " Prefix.", "TourId": " TourId " }, { "PaxType": " PaxType ", "Email": " Email ", "FirstName": " FirstName ", "LastName": " LastName ", "Message": " Message ", "Mobile": " Mobile ", "Prefix": " Prefix.", "TourId": " TourId " } ], "lstTourdata": [{ "TourId": TourId, "TransferId": TransferId, "TourTimeOptionId": TourTimeOptionId, "NoOfAdult": " NoOfAdult ", "NoOfChild": " NoOfChild ", "NoOfInfant": " NoOfInfant ", "AdultRate": " AdultRate ", "ChildRate": ChildRate, "CheckInDate": " CheckInDate ", "ServiceTotal": ServiceTotal, "StartTime": " StartTime ", "EventID": " EventID ", "PickDetails": " PickDetails " }, { "TourId": TourId, "TransferId": TransferId, "TourTimeOptionId": TourTimeOptionId, "NoOfAdult": " NoOfAdult ", "NoOfChild": " NoOfChild ", "NoOfInfant": " NoOfInfant ", "AdultRate": " AdultRate ", "ChildRate": ChildRate, "CheckInDate": " CheckInDate ", "ServiceTotal": ServiceTotal, "StartTime": " StartTime ", "EventID": " EventID ", "PickDetails": " PickDetails " } ] }, "token": " token " }

Tag	Parent Tag	Description	Optionality
apiname	apiname	apiname is the key factor	Mandatory
lstPassenger	Payload
PaxType	IsPassenger	You have to put PaxType like Adult, child, infant.	Mandatory
Email	IsPassenger	You have to put Customer Emaild	Mandatory
FirstName	IsPassenger	You have to put Customer FirstName.	Mandatory
LastName	IsPassenger	You have to put Customer LastName.	Mandatory
Message	IsPassenger	You have to put Special Request from customer at time of booking.	Mandatory
Mobile	IsPassenger	You have to put Customer Mobile number.	Mandatory
Prefix	IsPassenger	You have to put Customer Prefix like Mr., Miss, Ms.	Mandatory
TourId	IsTourData	String representing unique TourId.	Mandatory
TransferId	IsTourData	String representing unique ID for transfer type. IDs are as mention in Documents and Downloads section	Mandatory
TourTimeOptionId	IsTourData	String representing unique TourTimeOptionId.	Mandatory
NoOfAdult	IsTourData	You need to pass the count Of adults.	Mandatory
NoOfChild	IsTourData	You need to pass the count of child.	Mandatory
NoOfInfant	IsTourData	You need to pass the count of infant.	Mandatory
AdultRate	IsTourData	You have to put AdultRate from response of tour option API	Mandatory
ChildRate	IsTourData	You have to put ChildRate from response of tour option API	Mandatory
CheckInDate	IsTourData	You have to put travel Date	Mandatory
ServiceTotal	IsTourData	You have to put ServiceTotal. (i.e. addition of Adult rate and child rate)	Optional
StartTime	IsTourData	StartTime is the tours Operating Time which means that tours is started from that time. IT should be in the string format as following: hh:mm:ss Example: "18:00:00"	Mandatory
EventID	IsTourData	You have to put tours EventID which you get from timeslot API	Mandatory (Valid only for Tours having time slot)
PickDetails	IsTourData	You have to put tours PickDetails	Mandatory (When Transfer type is sharing or private)
token		You have to put Unique token which provided by system.	Mandatory

Booking Response

The voucher generation booking method ofsavebooking is used to generate a unique booking number which contains one or more tours booked. Each tours booked will have a unique reference number which could be individually cancelled. Multiple tours booked in the same booking will be grouped together by a unique booking Number.

The general format of the response is shown below:

JSON Code :

{ "BookingSuccess": [{ "BookingMasterId": BookingMasterId, "BookingdetailId": BookingdetailId, "AgentVoucherNo": "AgentVoucherNo", "StartTime": StartTime, "ReferenceNo": "ReferenceNo" }, { "BookingMasterId": "BookingMasterId", "BarcodeImageData": "BarcodeImageData", "Barcode": "Barcode", "slot": "Slot", "TermsAndConditions": "TermsAndConditions", "FromDate": "FromDate", "ToDate": "ToDate", "Type": "Type" }] }

Parent Tag	Tag	Description
BookingSuccess	BookingSuccess	You will get the booking status.
	BookingMasterId	You will get BookingMasterId.
	BookingdetailId	You will get BookingdetailId.
	AgentVoucherNo	You will get Ticket number .
	ReferenceNo	You will get the unique booking Number.
Bookingtickets
	BarcodeImagedata	You will get Barcode image data
	BarCode	You will get unique Barcode
	Slot	You will get time slot
	TermsAndConditions	You will get Terms and conditions
	FromDate	Start date of tour
	ToDate	End date of tour
ERROR	Booking Fail	You will get ERROR message.

Booking Cancellation Request

The tourcancel request can be used to cancel a booking that is confirmed & booking that is saved.

Request URL

http://api.withinearth.com/api/TourData/GetTourData

This URL is for fetching dynamic data

JSON Code :

{ "apiname": "tourcancel", "payload": { "BookingMasterId": "BookingMasterId” }, "token": " YOUR TOKEN " }

Tag	Parent Tag	Description	Optionality
apiname	apiname	apiname is the key factor	Mandatory
	Payload
BookingMasterId	Payload	You have to put BookingMasterId to cancel vouchered booking	Mandatory
token		You have to put unique token which is provided by the system	Mandatory

Booking Cancellation Response

After you initiate the request of tourcancel, our system will process the request . and it will return status of the booking & Message The general format of the response is shown below:

JSON Response Format:

{ "Status": Status, "Message": " Message" }

Tag	Description
Status	You will return the status of booking Cancellation
Message	You will return the Message of booking Cancellation

Frequently Asked Questions

Q: Do you offer any REST/SOAP API in order to provide a communication channel to the withinearth 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

In order to start testing / Live please notify our support team via e-mail atsupportapi@technoheaven.net

Tour Api

Introduction

Connection properties

Go-Test/Live Process

Client Requirements

Development Phase

Implementation Approach

Documentation and Downloads

Status & Error Code

Image Path

Date Format

Getcitieswithhotel

The Request URL:

JSON Request Format:

Booking Status

Access Information

Ticketing tours

NonTicketing tours

Static Data Request

Country & City Static Data

Static Data Response

Static Data Response

Here you can get response of all Static data

JSON Response Format:

Price Request / Get tour price

JSON Request Format:

JSON Response Format:

Tours Option

JSON Request Format:

JSON Response Format:

Get Tour Time Slot

JSON Request Format:

JSON Response Format:

Tour Availability Request

JSON Response Format:

Response

Booking Request

JSON Code (Single Tours):

Multiple Tour :

Booking Response

JSON Code :

Booking Cancellation Request

JSON Code :

Booking Cancellation Response

JSON Response Format:

Frequently Asked Questions

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

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

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.

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

Contact Us

1. Pricing

2. Mode of Payment

3. Payment Confirmation

4. Disclaimer of Liability

5. No Show Policy

6. Cancellation Process

7. Guest Refund Policy

8. Cancellation Policy

9. Itinerary Amendments

10. Accommodation & Check-in & Check-out Policy

11. Travel Documents

12. Website Usage