Almost all APIs will require the following input parameter. The meaning is same for all APIs. 


•APIKEY are mandatory parameters with every API call. 

•Along with APIKEY parameters TenantCode and SearchType are mandatory with every FORM POST request. 

•AffiliateCode is only mandatory for Affiliate Search Request. 

•Parameters mentioned in bold are mandatory and have to be sent for that API.


Parameter

Type

Description

Example

APIKEY

String

Key that you need to pass with every call to our API to establish your identity. 

8UhfXavJYy

TENANTCODE

string

Tenant Code Provided

ETST

SearchType 

string

For Package Booking - ‘HotelPark’ 

For Park Pass Booking – ‘ParkPass’ 

HotelPark 

AFFILIATECODE 

string

Code Provided to You After Registration 

CLICK100 



All APIS will return these four parameters. The meaning is same for all APIs. 

These four parameters are not mentioned in individual API documentation though it will be returned with every API call.


Parameter

Data type

Description

Example Data

Result 

Boolean

True means success false means error has occurred; you will need to see message/ErrorCode to understand why the error has occurred.

true

Message

String

Contains Error Message for required parameters or if exceptions occurred.

APIKEY is Invalid.

Object

Object

Contains Return Object Useful For Listing and Calculation Purpose 

Object

ExtraObject

Object

Extra information if needed


ErrorCode

String

Contains Error Code For Exception, Invalid Data or Required Parameter etc. Meaning and Resolution is Mentioned in Table

Err_General

IsTimeout

boolean

return true if transaction timeout 

true/false

HttpResponseCode

int

HttpStatusCode Enum 

Reference - https://learn.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=net-7.0




These are common error codes. That can come from any API and they aren’t listed for individual API separately.


Sr. No.

Possible common Error Code

1

Err_General

2

Err_PageError

3

Err_InvalidData

4

Err_APIKEY_Not_found

5

Err_APIKEY_Mismatch

6

Err_BookingMaxParkPass

7

Err_Package_Booking_DateRange



Created with the Personal Edition of HelpNDoc: Easily create Web Help sites