SEARCH

This method provides availability of Insurance option with the insurance cover details on the behalf of PlanType, PlanCoverage and dates selected. Client need to pass the PlanType, PlanCoverage, TravelStartDate and passenger details in request in response will get the available Insurance option with the insurance cover details.

Service URL (REST) to be used:
Search
Insurance Search Request
Level Element Format Comments Mandatory
1 EndUserIp String IP Address of the end Mandatory
2 ClientId String Client ID provided to the agency at registration Mandatory
3 UserName String Username provided to the agency at registration Mandatory
4 Password String Password provided to the agency at registration Mandatory
5 PlanCategory Enumeration Define the category of plan whether its Domestic, Overseas and studentoversea plan.
Possible values can be
DomesticTravelPolicy = 1,
OverseasTravelInsurance = 2,
StudentOverseasInsurance = 3,
SchengenOverseasInsurance = 4,
InboundTravelPolicy = 5,
CancellationInsurance = 6 		Mandatory
6 PlanType Enumeration Define insurance PlanType is single trip or AnnualMultiTrip
(Ex: SingleTrip = 1, AMT = 2)		 Mandatory
7 PlanCoverage Enumeration Define whether plan coverage area is US, NON us and India
(Ex: US = 1
Non_US = 2,
WorldWide = 3,
India = 4,
Asia = 5,
Canada = 6,
Australia = 7,
SchenegenCountries = 8) 		Mandatory
8 TravelStartDate Date Time Start Date of the requested Insurance
Format: (yyyy-mm-dd)		 Mandatory
9 NoOfPax Integer Number of passenger for which insurance requested Mandatory
10 PaxAge[] Array List of Passengers' Age Mandatory
Insurance Search Response
Level Element Format Comments Mandatory
1 Error{} Object Error Mandatory
1.1 ErrorCode String ErrorCode Mandatory
1.2 ErrorMessage String Error Message Mandatory
2 TraceId Integer Trace ID Mandatory
3 APIType String Simple result data version Mandatory
4 Results[] Array Result Array Of Search Request Mandatory
4.1 PlanCode String Response Plan Code Mandatory
4.2 ResultIndex Integer Result index Mandatory
4.3 PlanType Enumeration Define insurance PlanType is Single trip or AnnualMultiTrip
(Ex: SingleTrip = 1, AMT = 2)		 Mandatory
4.4 PlanName String Name of Insurance plan Mandatory
4.5 PlanDescription String Describe the coverage amount and other details Mandatory
4.6 PlanCoverage Enumeration Define whether plan coverage area is US, NON us and India
(Ex: US = 1
Non_US = 2,
WorldWide = 3,
India = 4,
Asia = 5,
Canada = 6,
Australia = 7,
SchenegenCountries = 8) 		Mandatory
4.7 CoverageDetails[] Array Coverage Detials Mandatory
4.7.1 Coverage String Define the Insurance cover area ( Ex: 24/7 Worldwide Medical Assistance, Travel Assistance, Travel Insurance, Dental Cover Mandatory
4.7.2 SumInsured Decimal Define the service wise cover amount
(Ex Dental Cover -$250,
Personal Accident-$10000)		 Mandatory
4.7.3 Excess Enumeration Mandatory
4.8 PlanCategory Integer Define the category of plan whether its Domestic, Overseas and studentoversea plan. Possible values can be
DomesticTravelPolicy = 1,
OverseasTravelInsurance = 2,
StudentOverseasInsurance = 3,
SchengenOverseasInsurance = 4,
InboundTravelPolicy = 5,
CancellationInsurance = 6		 Mandatory
4.9 PremiumList[] Array PremiumList Array Mandatory
4.9.1 PassengerCount Integer Define no of passenger in policy Mandatory
4.9.2 MinAge Integer Define minimum age of passenger for which policy is valid Mandatory
4.9.3 MaxAge Integer Define max age of passenger passenger for which policy is valid Mandatory
4.9.4 Price[] Array Insurance Price Array Mandatory
4.9.4.1 Currency String Currency in which minimum Insurance price is returned Mandatory
4.9.4.2 GrossFare Decimal Gross fare of the policy Mandatory
4.9.4.3 PublishedPrice Decimal (Publish price is the price that has to charge from customer it inclusive of all the taxes ) Mandatory
4.9.4.4 PublishedPriceRoundedOff Decimal Publish Price (rounded off) of Insurance policy (This price is for display purpose only) Mandatory
4.9.4.5 OfferedPrice Decimal Offered Price of Insurance policy Mandatory
4.9.4.6 OfferedPriceRoundedOff Decimal Offered Price (rounded off) of Insurance policy This price is for display purpose only) Mandatory
4.9.4.7 CommissionEarned Decimal Commission applicable on policy that is the actual earning of agency on the policy Mandatory
4.9.4.8 TdsOnCommission Decimal TDS applicable on Commission Earned on policy Mandatory
4.9.4.9 ServiceTax Decimal Service tax applicable on the Policy Mandatory
4.9.4.10 SwachhBharatTax Decimal SwachhBharatTax applicable on the Policy Mandatory
4.9.4.11 KrishiKalyanTax Decimal KrishiKalyanTax aplicable on the Policy Mandatory
4.9.5 CancellationCharge Decimal CancellationCharges applicable on the Policy Mandatory
4.10 Price[] Array Insurance Price Array Mandatory
4.10.1 Currency String Currency in which minimum Insurance price is returned Mandatory
4.10.2 GrossFare Decimal Gross fare of the policy Mandatory
4.10.3 PublishedPrice Decimal (Publish price is the price that has to charge from customer it inclusive of all the taxes ) Mandatory
4.10.4 PublishedPriceRoundedOff Decimal Publish Price (rounded off) of Insurance policy (This price is for display purpose only) Mandatory
4.10.5 OfferedPrice Decimal Offered Price of Insurance policy Mandatory
4.10.6 OfferedPriceRoundedOff Decimal Offered Price (rounded off) of Insurance policy This price is for display purpose only) Mandatory
4.10.7 CommissionEarned Decimal Commission applicable on policy that is the actual earning of agency on the policy Mandatory
4.10.8 TdsOnCommission Decimal TDS applicable on Commission Earned on policy Mandatory
4.10.9 ServiceTax Decimal Service tax applicable on the Policy Mandatory
4.10.10 SwachhBharatTax Decimal SwachhBharatTax applicable on the Policy Mandatory
4.10.11 KrishiKalyanTax Decimal KrishiKalyanTax aplicable on the Policy Mandatory
4.11 PolicyStartDate Date Time Insurance start date
Format: (yyyy-mm-ddddT00:00:00)		 Mandatory
4.12 PolicyEndDate Date Time Insurance end date
Format: (yyyy-mm-ddddT00:00:00)		 Mandatory