POST api/Insurance/Search
Search for an insurance product
Request Information
URI Parameters
None.
Body Parameters
Insurance search request object
InsuranceSearchRequestName | Description | Type | Additional information |
---|---|---|---|
OriginCountryCode |
The origin country code of the travelers(US/IL/UK/...) |
string |
Required Max length: 2 |
Travelers |
The list of travelers need an insurance |
Collection of InsuranceTraveler |
Required |
StartDate |
The start date of the insurance |
date |
None. |
EndDate |
The end date of the insurance |
date |
None. |
ProgramIdentifier |
The Program Identifier of the insurance |
string |
None. |
UserCurrencyCode |
The user pre-defined ISO 4217 currency code (USD/EUR/ILS/...) |
string |
Required Max length: 3 |
UserLanguageCode |
The user pre-defined ISO 639-1 language code(en/he/...) |
string |
Required Max length: 2 |
SourceReservationSystemIdentifier |
The source system identifier(WEB-IL/WEB-US/WEB-UK/...) |
string |
Max length: 20 |
UserName |
The provided user name. |
string |
Required |
Salt |
A random number(at least 9 digits) |
integer |
Required |
Digest |
A digest of the user credentials and the request |
string |
Required |
Request Formats
application/json, text/json
{ "OriginCountryCode": "IL", "Travelers": [ { "DateOfBirth": "1985-10-05T00:00:00", "Additions": [ { "ServiceCode": "LAPTOP", "ServiceName": "Laptop", "DatePicking": false, "StartDate": "2025-07-25T02:04:10.7867247Z", "EndDate": "2025-07-30T02:04:10.7867247Z", "Note1": "dell 3008", "Note2": "2015", "Note3": null, "PriceForPeriod": null, "PriceForDay": { "ClientPrice": 2.0, "PriceInDisplayCurrency": 8.0 } }, { "ServiceCode": "SKI", "ServiceName": "Winter Sport(SKI)", "DatePicking": true, "StartDate": "2025-07-25T02:04:10.7867247Z", "EndDate": "2025-07-30T02:04:10.7867247Z", "Note1": null, "Note2": null, "Note3": null, "PriceForPeriod": null, "PriceForDay": { "ClientPrice": 1.0, "PriceInDisplayCurrency": 4.0 } }, { "ServiceCode": "CHALANGE", "ServiceName": "Challanging Sport", "DatePicking": false, "StartDate": "2025-07-25T02:04:10.7867247Z", "EndDate": "2025-07-30T02:04:10.7867247Z", "Note1": null, "Note2": null, "Note3": null, "PriceForPeriod": { "ClientPrice": 15.0, "PriceInDisplayCurrency": 60.0 }, "PriceForDay": null }, { "ServiceCode": "COMPETITION", "ServiceName": "Competition Sport", "DatePicking": true, "StartDate": "2025-07-25T02:04:10.7867247Z", "EndDate": "2025-07-30T02:04:10.7867247Z", "Note1": null, "Note2": null, "Note3": null, "PriceForPeriod": null, "PriceForDay": { "ClientPrice": 2.2, "PriceInDisplayCurrency": 8.8 } }, { "ServiceCode": "DIVING", "ServiceName": "Diving", "DatePicking": true, "StartDate": "2025-07-25T02:04:10.7867247Z", "EndDate": "2025-07-30T02:04:10.7867247Z", "Note1": null, "Note2": null, "Note3": null, "PriceForPeriod": null, "PriceForDay": { "ClientPrice": 4.5, "PriceInDisplayCurrency": 18.0 } } ], "GovernmentID": "123456789", "LastName": "Amsalem", "FirstName": "Oren", "AmadeusLocator": null } ], "StartDate": "2025-07-25T02:04:10.7867247Z", "EndDate": "2025-07-30T02:04:10.7867247Z", "ProgramIdentifier": "594", "UserCurrencyCode": "ILS", "UserLanguageCode": "he", "SourceReservationSystemIdentifier": "AmsalemWebIL", "UserName": "GTP", "Salt": 629612090, "Digest": "TJb8kaELmEaivW87xwIV4MC3nRs2HPvPyzjsDjKuekAue4UtRMd7rzkqaE1pNrNXF0AtWkAIzulkFrejBvZJ6Q==" }
application/xml, text/xml
<InsuranceSearchRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" UserName="GTP" Salt="629612090" Digest="TJb8kaELmEaivW87xwIV4MC3nRs2HPvPyzjsDjKuekAue4UtRMd7rzkqaE1pNrNXF0AtWkAIzulkFrejBvZJ6Q=="> <UserCurrencyCode>ILS</UserCurrencyCode> <UserLanguageCode>he</UserLanguageCode> <SourceReservationSystemIdentifier>AmsalemWebIL</SourceReservationSystemIdentifier> <OriginCountryCode>IL</OriginCountryCode> <Travelers> <InsuranceTraveler> <GovernmentID>123456789</GovernmentID> <LastName>Amsalem</LastName> <FirstName>Oren</FirstName> <DateOfBirth>1985-10-05T00:00:00</DateOfBirth> <Additions> <InsuranceAddition> <ServiceCode>LAPTOP</ServiceCode> <ServiceName>Laptop</ServiceName> <ServiceNameLocalized>מחשב נישא</ServiceNameLocalized> <DatePicking>false</DatePicking> <StartDate>2025-07-25T02:04:10.7867247Z</StartDate> <EndDate>2025-07-30T02:04:10.7867247Z</EndDate> <Note1>dell 3008</Note1> <Note2>2015</Note2> <PriceForDay> <ClientPrice>2</ClientPrice> <PriceInDisplayCurrency>8</PriceInDisplayCurrency> </PriceForDay> </InsuranceAddition> <InsuranceAddition> <ServiceCode>SKI</ServiceCode> <ServiceName>Winter Sport(SKI)</ServiceName> <ServiceNameLocalized>ספורט חורף(סקי)</ServiceNameLocalized> <DatePicking>true</DatePicking> <StartDate>2025-07-25T02:04:10.7867247Z</StartDate> <EndDate>2025-07-30T02:04:10.7867247Z</EndDate> <PriceForDay> <ClientPrice>1</ClientPrice> <PriceInDisplayCurrency>4</PriceInDisplayCurrency> </PriceForDay> </InsuranceAddition> <InsuranceAddition> <ServiceCode>CHALANGE</ServiceCode> <ServiceName>Challanging Sport</ServiceName> <ServiceNameLocalized>ספורט אתגרי</ServiceNameLocalized> <DatePicking>false</DatePicking> <StartDate>2025-07-25T02:04:10.7867247Z</StartDate> <EndDate>2025-07-30T02:04:10.7867247Z</EndDate> <PriceForPeriod> <ClientPrice>15</ClientPrice> <PriceInDisplayCurrency>60</PriceInDisplayCurrency> </PriceForPeriod> </InsuranceAddition> <InsuranceAddition> <ServiceCode>COMPETITION</ServiceCode> <ServiceName>Competition Sport</ServiceName> <ServiceNameLocalized>ספורט תחרותי</ServiceNameLocalized> <DatePicking>true</DatePicking> <StartDate>2025-07-25T02:04:10.7867247Z</StartDate> <EndDate>2025-07-30T02:04:10.7867247Z</EndDate> <PriceForDay> <ClientPrice>2.2</ClientPrice> <PriceInDisplayCurrency>8.8</PriceInDisplayCurrency> </PriceForDay> </InsuranceAddition> <InsuranceAddition> <ServiceCode>DIVING</ServiceCode> <ServiceName>Diving</ServiceName> <ServiceNameLocalized>צלילה</ServiceNameLocalized> <DatePicking>true</DatePicking> <StartDate>2025-07-25T02:04:10.7867247Z</StartDate> <EndDate>2025-07-30T02:04:10.7867247Z</EndDate> <PriceForDay> <ClientPrice>4.5</ClientPrice> <PriceInDisplayCurrency>18</PriceInDisplayCurrency> </PriceForDay> </InsuranceAddition> </Additions> </InsuranceTraveler> </Travelers> <StartDate>2025-07-25T02:04:10.7867247Z</StartDate> <EndDate>2025-07-30T02:04:10.7867247Z</EndDate> <ProgramIdentifier>594</ProgramIdentifier> </InsuranceSearchRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Insurance search response object
InsuranceSearchResponseName | Description | Type | Additional information |
---|---|---|---|
Insurances |
The available insurances collection |
Collection of Insurance |
None. |
Success |
Indicate if the operation was success |
boolean |
None. |
Message |
Return of errors or indicated return message/data |
string |
None. |
Extra1 |
Additional info 1 to return |
string |
None. |
Extra2 |
Additional info 2 to return |
string |
None. |
Extra3 |
Additional info 3 to return |
string |
None. |
Response Formats
application/json, text/json
{ "Insurances": [ { "InsuranceProgramIdentifier": "594", "Travelers": [ { "DateOfBirth": "1985-10-05T00:00:00", "Additions": [ { "ServiceCode": "LAPTOP", "ServiceName": "Laptop", "DatePicking": false, "StartDate": "2025-07-25T02:04:10.7867247Z", "EndDate": "2025-07-30T02:04:10.7867247Z", "Note1": "dell 3008", "Note2": "2015", "Note3": null, "PriceForPeriod": null, "PriceForDay": { "ClientPrice": 2.0, "PriceInDisplayCurrency": 8.0 } }, { "ServiceCode": "SKI", "ServiceName": "Winter Sport(SKI)", "DatePicking": true, "StartDate": "2025-07-25T02:04:10.7867247Z", "EndDate": "2025-07-30T02:04:10.7867247Z", "Note1": null, "Note2": null, "Note3": null, "PriceForPeriod": null, "PriceForDay": { "ClientPrice": 1.0, "PriceInDisplayCurrency": 4.0 } }, { "ServiceCode": "CHALANGE", "ServiceName": "Challanging Sport", "DatePicking": false, "StartDate": "2025-07-25T02:04:10.7867247Z", "EndDate": "2025-07-30T02:04:10.7867247Z", "Note1": null, "Note2": null, "Note3": null, "PriceForPeriod": { "ClientPrice": 15.0, "PriceInDisplayCurrency": 60.0 }, "PriceForDay": null }, { "ServiceCode": "COMPETITION", "ServiceName": "Competition Sport", "DatePicking": true, "StartDate": "2025-07-25T02:04:10.7867247Z", "EndDate": "2025-07-30T02:04:10.7867247Z", "Note1": null, "Note2": null, "Note3": null, "PriceForPeriod": null, "PriceForDay": { "ClientPrice": 2.2, "PriceInDisplayCurrency": 8.8 } }, { "ServiceCode": "DIVING", "ServiceName": "Diving", "DatePicking": true, "StartDate": "2025-07-25T02:04:10.7867247Z", "EndDate": "2025-07-30T02:04:10.7867247Z", "Note1": null, "Note2": null, "Note3": null, "PriceForPeriod": null, "PriceForDay": { "ClientPrice": 4.5, "PriceInDisplayCurrency": 18.0 } } ], "GovernmentID": "123456789", "LastName": "Amsalem", "FirstName": "Oren", "AmadeusLocator": null } ], "Supplier": "Shirbit", "ClientTotal": 25.0, "CurrencyCode": "USD", "ProductIdentifier": null, "StartDate": "2025-07-25T02:04:10.7867247Z", "EndDate": "2025-07-30T02:04:10.7867247Z", "Status": 0 } ], "Success": true, "Message": null, "Extra1": null, "Extra2": null, "Extra3": null }
application/xml, text/xml
<InsuranceSearchResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Success>true</Success> <Insurances> <Insurance> <Supplier>Shirbit</Supplier> <ClientTotal>25</ClientTotal> <CurrencyCode>USD</CurrencyCode> <StartDate>2025-07-25T02:04:10.7867247Z</StartDate> <EndDate>2025-07-30T02:04:10.7867247Z</EndDate> <Status>Quote</Status> <InsuranceProgramIdentifier>594</InsuranceProgramIdentifier> <Travelers> <InsuranceTraveler> <GovernmentID>123456789</GovernmentID> <LastName>Amsalem</LastName> <FirstName>Oren</FirstName> <DateOfBirth>1985-10-05T00:00:00</DateOfBirth> <Additions> <InsuranceAddition> <ServiceCode>LAPTOP</ServiceCode> <ServiceName>Laptop</ServiceName> <ServiceNameLocalized>מחשב נישא</ServiceNameLocalized> <DatePicking>false</DatePicking> <StartDate>2025-07-25T02:04:10.7867247Z</StartDate> <EndDate>2025-07-30T02:04:10.7867247Z</EndDate> <Note1>dell 3008</Note1> <Note2>2015</Note2> <PriceForDay> <ClientPrice>2</ClientPrice> <PriceInDisplayCurrency>8</PriceInDisplayCurrency> </PriceForDay> </InsuranceAddition> <InsuranceAddition> <ServiceCode>SKI</ServiceCode> <ServiceName>Winter Sport(SKI)</ServiceName> <ServiceNameLocalized>ספורט חורף(סקי)</ServiceNameLocalized> <DatePicking>true</DatePicking> <StartDate>2025-07-25T02:04:10.7867247Z</StartDate> <EndDate>2025-07-30T02:04:10.7867247Z</EndDate> <PriceForDay> <ClientPrice>1</ClientPrice> <PriceInDisplayCurrency>4</PriceInDisplayCurrency> </PriceForDay> </InsuranceAddition> <InsuranceAddition> <ServiceCode>CHALANGE</ServiceCode> <ServiceName>Challanging Sport</ServiceName> <ServiceNameLocalized>ספורט אתגרי</ServiceNameLocalized> <DatePicking>false</DatePicking> <StartDate>2025-07-25T02:04:10.7867247Z</StartDate> <EndDate>2025-07-30T02:04:10.7867247Z</EndDate> <PriceForPeriod> <ClientPrice>15</ClientPrice> <PriceInDisplayCurrency>60</PriceInDisplayCurrency> </PriceForPeriod> </InsuranceAddition> <InsuranceAddition> <ServiceCode>COMPETITION</ServiceCode> <ServiceName>Competition Sport</ServiceName> <ServiceNameLocalized>ספורט תחרותי</ServiceNameLocalized> <DatePicking>true</DatePicking> <StartDate>2025-07-25T02:04:10.7867247Z</StartDate> <EndDate>2025-07-30T02:04:10.7867247Z</EndDate> <PriceForDay> <ClientPrice>2.2</ClientPrice> <PriceInDisplayCurrency>8.8</PriceInDisplayCurrency> </PriceForDay> </InsuranceAddition> <InsuranceAddition> <ServiceCode>DIVING</ServiceCode> <ServiceName>Diving</ServiceName> <ServiceNameLocalized>צלילה</ServiceNameLocalized> <DatePicking>true</DatePicking> <StartDate>2025-07-25T02:04:10.7867247Z</StartDate> <EndDate>2025-07-30T02:04:10.7867247Z</EndDate> <PriceForDay> <ClientPrice>4.5</ClientPrice> <PriceInDisplayCurrency>18</PriceInDisplayCurrency> </PriceForDay> </InsuranceAddition> </Additions> </InsuranceTraveler> </Travelers> </Insurance> </Insurances> </InsuranceSearchResponse>