AUTHENTICATION API, SEARCH API & WALLET

BALANCE CHECK API

VERSION 1.0

Titiksha Ganjoo
TBO.COM
 AUTHENTICATION API

• Authenticate method will return the Token ID that needs to be echoed back in
every subsequent request.
• In case of session expiry or log outs, the authenticate method needs to be
called again andthe updated Token ID needs to be passed in every subsequent
request.

ServiceURL: http://xmloutapi.tboair.com/api/v1/Authenticate/ValidateAgency

Authentication Request:

{
"UserName": "tboair",
"Password":"tboair@3421",
"BookingMode":"API",
"IPAddress":"192.16910. 22"
}

Authentication Response:
{
"Agency":
{
"TotalAailableLimit": 233279.53,
"Currency": "USD",
"LocalCurrency": "JOD",
"LocalCurrencyROE":0.709
},
"IsSuccess":true,

1
 "Errors”: [],
"Alerts": [],
"TokenId": "d1b5125e-8db1-4af6-95be-8db1-4af6-95be-b57c14591ab0",
"TrackingId": null
}
AUTHENTICATION REQUEST
Mandatory
or
Level Element Format Comments
Optional
Username provided to the
1 UserName String agency Mandatory

2 Password String Password provided to the Mandatory

agency
Always "API" as a mode of the
3 BookingMode String booking Mandatory

4 EndUserIp String Public Server IP Mandatory

AUTHENTICATION RESPONSE

Mandatory
or
Level Element Format Comments
Optional

1 Currency String Configured currency Mandatory

2 TotalAvailableLimit String TBOWallet Available Balance Mandatory

3 LocalCurrency String Agency Preference Currency Mandatory

RateofExchange with respect

4 LocalCurrencyROE String to USD Mandatory

Mandatory (True - Successful and

False - Failure)
5 IsSuccess Boolean Response status

2
 Mandatory (Token Id to be echoed
back in further requests valid for
20
6 TokenId String Token ID
hrs.

7 TrackingId String TrackingId should be null in the Mandatory

authentication response

Code corresponding to the

8 ErrorCode Integer Error Non-Mandatory

Mandatory (User Message,

Timestamp, Resolution,
corresponding to ErrorCode. Error
Message would beblank in case
ErrorCode=0)

9 ErrorMessage String Contains error message

SEARCH – One-way, Return and Multi-Stops

➢ This method provides availability of the results with the cheapest fare options.

➢ The request includes single query which requires all mandatory parameters for
search initiation.

➢ The search request containsoptional field of return/arrival date.

➢ In case of round trip, this field should be filled with the return date
and submitted for thesearch response including all the available
options.
➢ In case of multi-stop, the segment and departure date would require for the search
process.
➢ Once the requested query is parsed and validated, the TBO Air API start
searching for the best optionin all possible sources.
➢ If the search is successful, it will return Result object otherwise will share the error
response.

3
 Service URL: - http://xmloutapi.tboair.com/api/v1/Search/Search

Search Request for a One-Way Trip

"IPAddress": "192.168.11.92

"TokenId":"d1b5125e-8db1-4af6-95be-b57c14591ab0",

"EndUserBrowserAgent":"Mozilla/5.0(Windows NT 6.1; Win64; x64) AppleWebKit/537.36

(KHTML, likeGecko) Chrome/70.0.3538.110 Safari/537.36",

"PointOfSale":"ID",

"RequestOrigin":"Indonesia",

"UserData”: null,

"JourneyType": 1,

"AdultCount": 1,

"ChildCount": 0,

"InfantCount": 0,

"FlightCabinClass": 1,

"Segment":

[
{

"Origin": "DEL",

"Destination": "BOM",

"PreferredDepartureTime": "2020-05-15T00:00:00",

"PreferredArrivalTime": "2020-05-15T00:00:00",

"PreferredAirlines": []

4
 Search Response for a One-way Trip

"Results":

[[

"ResultId": "a63b3257-d9bd-45fa-b80d-00ca477aad9f",

"Origin": "DEL",

"Destination": "BOM",

"IsLcc”: false,

"NonRefundable": true,

"AirlineRemark": "GDS result. ",

"Fare": {

"TotalFare": 210.051735872,

"FareType": "RP",
"AgentMarkup": 0,

"OtherCharges": 0,

"AgentPreferredCurrency": "USD",

"ServiceFee": 4,

"BaseFare": 163.37644656,

"Tax": 42.675289312

},

"FareBreakdown": [

"Currency": "USD",

"PassengerType": 1,
"PassengerCount": 2,

"TotalFare": 210.051735872,

5
 "OtherCharges": 0,

"AgentMarkup": 0,

"ServiceFee": 4,

"BaseFare": 163.37644656,

"Tax": 42.675289312

}
],

"LastTicketDate": "09MAR20",

"TicketAdvisory": "TICKETS ARE NON-REFUNDABLE \nLAST TKT DTE 09MAR20 - SEE ADV PURCHASE
\n",

"Segments": [

"NoOfSeatAvailable": 9,

"OperatingCarrier": "UK",

"SegmentIndicator": 1,

"Airline": "UK",

"Origin": {

"AirportCode": "DEL",

"AirportName": "Indira Gandhi Airport",

"CityCode": "DEL",
"CityName": "Delhi",

"CountryCode": "IN",

"CountryName": "India",

"Terminal": "3"

},

"Destination": {

"AirportCode": "BOM",

6
 "AirportName": "Mumbai",

"CityCode": "BOM",

"CityName": "Mumbai",

"CountryCode": "IN",

"CountryName": "India",

"Terminal": "2"
},

"FlightNumber": "975",

"DepartureTime": "2020-05- 15T06:00:00",

"ArrivalTime": "2020-05- 15T08:00:00",

"BookingClass": "V",

"FlightStatus": 0,

"Status": null,

"MealType": null,

"ETicketEligible": true,

"AirlinePNR": null,

"Craft": "320",

"StopOver": false,
"Stops": 0,

"Mile": 0,

"Duration": "00:00:00",

"GroundTime": "00:00:00",

"AccumulatedDuration": "02:00:00",

"StopPoint": null,

"StopPointArrivalTime": "0001-01-01T00:00:00",

"StopPointDepartureTime": "0001-01- 01T00:00:00",

"IncludedBaggage": "15 KG",

"CabinBaggage": null,

7
 "CabinClass": "Economy",

"AdditionalBaggage": null,

"AirlineDetails": {

"AirlineCode": "UK",

"FlightNumber": "975",

"Craft": "320",
"AirlineName": "Air Vistara",

"OperatingCarrier": "UK"

},

"AirlineName": "Air Vistara",

"DepartureDateTime": null,

"DepartureDate": null,

"ArrivalDateTime": null,

"ArrivalDate": null,

"LayoverText": null,

"InFlightServices": null

]
],

"FareRules": [

"Origin": "DEL",

"Destination": "BOM",

"Airline": "UK",

"FareRestriction": "Y",

"FareBasisCode": "VH8PYS",

"FareRuleDetail": null,

"DepartureDate": "0001-01-01T00:00:00",

8
 "FlightNumber": null

],

"ValidatingAirline": "UK",

"TripIndicator": 1,

"ResponseTime": "2020-03-09T15:46:41",
"JourneyType": 1

},}

]],

"IsDomestic": false,

"LocalCurrency": "JOD",

"LocalCurrencyROE": 0.709,

"IsSuccess": true,

"Errors": [

],

"Alerts": [],

"TokenId": "d1b5125e-8db1-4af6-95be- b57c14591ab0",

"TrackingId": "37e7277e-5d61-47bd- 974f-938c6d6a0ba0"

}

Search Request for a Return Trip

"IPAddress": "192.168.11.92",

"TokenId": "d1b5125e-8db1-4af6-95be-b57c14591ab0",

"EndUserBrowserAgent": "Mozilla/5.0(Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like

Gecko) Chrome/70.0.3538.110 Safari/537.36",

"PointOfSale": "ID",

"RequestOrigin": "Indones ia",

"UserData": null"JourneyType": 2,

9
 "AdultCount": 1,

"ChildCount": 0,

"InfantCount": 0,

"FlightCabinClass": 1,

"Segment": [

"Origin": "DXB",

"Destination": "DEL",

"PreferredDepartureTime": "2020-05- 11T00:00:00",

"PreferredArrivalTime": "2020-05- 11T00:00:00",

},

"Origin": "DEL",

"Destination": "DXB",

"PreferredDepartureTime": "2020-05- 15T00:00:00",

"PreferredArrivalTime": "2020-05- 15T00:00:00",

],

"PreferredAirlines": [

Search Response for a Return Trip

"Results": [

[{

10
 "ResultId": "e3d403cd-e879-41ae-b0ec- a25bd145f6d2",

"Origin": "DXB",

"Destination": "DEL",

"IsLcc": false,

"NonRefundable": true,

"AirlineRemark": null,

"Fare": {

"TotalFare": 257.8484990132,

"FareType": "PUB",

"AgentMarkup": 0.0,

"OtherCharges": 0.0,

"AgentPreferredCurrency": "USD",

"ServiceFee": 2.0000,

"BaseFare": 250.8484990132,

"Tax": 5.00000000

},

"FareBreakdown": [

"Currency": "USD",

"PassengerType": 1,

"PassengerCount": 1,

"TotalFare": 257.8484990132,

"OtherCharges": 0.0,

"AgentMarkup": 0.0,

"ServiceFee": 2.0000,

"BaseFare": 250.848499013200,

"Tax": 5.00000000

],

11
 "LastTicketDate": null,

"TicketAdvisory": null,

"Segments": [

"NoOfSeatAvailable": 1,

"AllianceInfo": null,

"OperatingCarrier": "IX",

"SegmentIndicator": 1,

"Airline": "IX",

"Origin": {

"AirportCode": "DXB",

"AirportName": "Dubai",

"CityCode": "DXB",

"CityName": "Dubai",

"CountryCode": "AE",

"CountryName": "United Arab Emirates",

"Terminal": null

},

"Destination": {

"AirportCode": "DEL",

"AirportName": "Indira Gandhi Airport",

"CityCode": "DEL",

"CityName": "Delhi",

"CountryCode": "IN",

"CountryName": "India",

"Terminal": null

},

"FlightNumber": "142",

12
 "DepartureTime": "2020-05- 11T12:50:00",

"ArrivalTime": "2020-05- 11T18:00:00",

"BookingClass": "Y",

"FlightStatus": 0,

"Status": null,

"MealType": null,

"ETicketEligible": true,

"AirlinePNR": null,

"Craft": "Boeing 737",

"StopOver": false,

"Stops": 0,

"Mile": 0,

"Duration": "03:40:00",

"GroundTime": "00:00:00",

"AccumulatedDuration": "03:40:00",

"StopPoint": null,

"StopPointArrivalTime": "0001-01-01T00:00:00",

"StopPointDepartureTime": "0001-01- 01T00:00:00",

"IncludedBaggage": "1-Pieces",

"CabinBaggage": null,

"CabinClass": "Econom",

"AdditionalBaggage": null,

"AirlineDetails": {

"AirlineCode": "IX",

"FlightNumber": "142",

"Craft": "Boeing 737",

"AirlineName": "Air India Express (IX)",

"OperatingCarrier": "IX",

"AllianceInfo": null

13
 },

"AirlineName": "Air India Express (IX)",

"DepartureDateTime": null,

"DepartureDate": null,

"ArrivalDateTime": null,

"ArrivalDate": null,

"LayoverText": null,

"InFlightServices": null

],

"NoOfSeatAvailable": 1,

"AllianceInfo": null,

"OperatingCarrier": "6E",

"SegmentIndicator": 2,

"Airline": "6E",

"Origin": {

"AirportCode": "DEL",

"AirportName": "Indira Gandhi Airport",

"CityCode": "DEL",

"CityName": "Delhi",

"CountryCode": "IN",

"CountryName": "India",

"Terminal": null

},

"Destination": {

"AirportCode": "DXB",

"AirportName": "Dubai",

14
 "CityCode": "DXB",

"CityName": "Dubai",

"CountryCode": "AE",

"CountryName": "United Arab Emirates",

"Terminal": null

},

"FlightNumber": "21",

"DepartureTime": "2020-05- 15T17:25:00",

"ArrivalTime": "2020-05- 15T19:50:00",

"BookingClass": "Y",

"FlightStatus": 0,

"Status": null,

"MealType": null,

"ETicketEligible": true,

"AirlinePNR": null,

"Craft": "Boeing 737",

"StopOver": false,

"Stops": 0,

"Mile": 0,

"Duration": "03:55:00",

"GroundTime": "00:00:00",

"AccumulatedDuration": "03:55:00",

"StopPoint": null,

"StopPointArrivalTime": "0001-01-01T00:00:00",

"StopPointDepartureTime": "0001-01- 01T00:00:00",

"IncludedBaggage": "1-Pieces",

"CabinBaggage": null,

"CabinClass": "Econom",

"AdditionalBaggage": null,

15
 "AirlineDetails": {

"AirlineCode": "6E",

"FlightNumber": "21",

"Craft": "Boeing 737",

"AirlineName": "IndiGo (6E)",

"OperatingCarrier": "6E",

"AllianceInfo": null

},

"AirlineName": "IndiGo (6E)",

"DepartureDateTime": null,

"DepartureDate": null,

"ArrivalDateTime": null,

"ArrivalDate": null,

"LayoverText": null,

"InFlightServices": null

],

"FareRules": [

"Origin": "DXB",

"Destination": "DEL",

"Airline": "IX",

"FareRestriction": null,

"FareBasisCode": "Y",

"FareRuleDetail": null,

"DepartureDate": "0001-01-01T00:00:00",

"FlightNumber": null

},

16
 {

"Origin": "DEL",

"Destination": "DXB",

"Airline": "6E",

"FareRestriction": null,

"FareBasisCode": "Y",

"FareRuleDetail": null,

"DepartureDate": "0001-01-01T00:00:00",

"FlightNumber": null

],

"ValidatingAirline": "IX",

"TripIndicator": 1,

"ResponseTime": "0001-01-01T00:00:00",

"JourneyType": 2

],

"IsDomestic": false,

"LocalCurrency": "JOD",

"LocalCurrencyROE": 0.709,

"IsSuccess": true,

"Errors": [

],

"Alerts": [

],

"TokenId": "d1b5125e-8db1-4af6-95be- b57c14591ab0",

"TrackingId": "68de0828-9437-441b- bbfc-756ffdb750c8"

17
Search Request for Multi-Stop Trip

"IPAddress": "192.168.10.145",

"TokenId": "89a5a94a-07ac-4918-94be-863d67c67188",

"JourneyType": 3,

"AdultCount": 1,

"ChildCount": 0,

"InfantCount": 0,

"FlightCabinClass ": 1"Segment": [

"Origin": "DXB",

"Destination": "DEL",

"PreferredDepartureTime": "2020-05-11T00:00:00",

"PreferredArrivalTime": "2020-05-11T00:00:00",

},

"Origin": "DEL",

"Destination": "BOM",

"PreferredDepartureTime": "2020-05- 13T00:00:00",

"PreferredArrivalTime": "2020-05- 13T00:00:00",

},

"Origin": "BOM",

"Destination": "MAA",

"PreferredDepartureTime": "2020-05- 15T00:00:00",

"PreferredArrivalTime": "2020-05- 15T00:00:00",

} ], "PreferredAirlines": [ ]}

18
Search Response for Multi-Stop Trip

"Results": [

"ResultId": "45552ca8-a491-4250-a0d3- f5f258d6ab29",

"Origin": "DXB",

"Destination": "DEL",

"IsLcc": true,

"NonRefundable": false,

"AirlineRemark": "",

"Fare": {

"TotalFare": 225.9560439359,

"FareType": "PUB",

"AgentMarkup": 0.0,

"OtherCharges": 0.0000000000,

"AgentPreferredCurrency": "USD",

"ServiceFee": 2.0000,

"BaseFare": 151.6483516344,

"Tax": 72.3076923015,

},

"FareBreakdown": [

"Currency": "USD",

"PassengerType": 1,

"PassengerCount": 1,

"TotalFare": 225.9560439359,

"OtherCharges": 0.0000000000,

19
 "AgentMarkup": 0.0,

"ServiceFee": 2.0000,

"BaseFare": 151.6483516344,

"Tax": 72.3076923015

],

"LastTicketDate": null,

"TicketAdvisory": null,

"Segments": [

"NoOfSeatAvailable": 3,

"AllianceInfo": null,

"OperatingCarrier": null,

"SegmentIndicator": 1,

"Airline": "6E",

"Origin": {

"AirportCode": "DXB",

"AirportName": "Dubai",

"CityCode": "DXB",

"CityName": "Dubai",

"CountryCode": "AE",

"CountryName": "United Arab Emirates",

"Terminal": "1"

},

"Destination": {

"AirportCode": "DEL",

"AirportName": "Indira Gandhi Airport",

"CityCode": "DEL",

20
 "CityName": "Delhi",

"CountryCode": "IN",

"CountryName": "India",

"Terminal": "3"

},

"FlightNumber": "22",

"DepartureTime": "2020-05-11T22:10:00",

"ArrivalTime": "2020-05-12T03:00:00",

"BookingClass": "L",

"FlightStatus": 0,

"Status": null,

"MealType": null,

"ETicketEligible": true,

"AirlinePNR": null,

"Craft": "320",

"StopOver": false,

"Stops": 0,

"Mile": 0,

"Duration": "03:20:00",

"GroundTime": "00:00:00",

"AccumulatedDuration": "03:20:00",

"StopPoint": null,

"StopPointArrivalTime": "0001-01-01T00:00:00",

"StopPointDepartureTime": "0001-01- 01T00:00:00",

"IncludedBaggage": "50 Kg",

"CabinBaggage": " 7 KG",

"CabinClass": "",

"AdditionalBaggage": null,

"AirlineDetails": {

21
 "AirlineCode": "6E",

"FlightNumber": "22",

"Craft": "320",

"AirlineName": "Indigo",

"OperatingCarrier": null,

"AllianceInfo": null

},

"AirlineName": "Indigo",

"DepartureDateTime": null,

"DepartureDate": null,

"ArrivalDateTime": null,

"ArrivalDate": null,

"LayoverText": null,

"InFlightServices": null

],

"NoOfSeatAvailable": 1,

"AllianceInfo": null,

"OperatingCarrier": null,

"SegmentIndicator": 2,

"Airline": "6E",

"Origin": {

"AirportCode": "DEL",

"AirportName": "Indira Gandhi Airport",

"CityCode": "DEL",

"CityName": "Delhi",

"CountryCode": "IN",

22
 "CountryName": "India",

"Terminal": ""

},

"Destination": {

"AirportCode": "BOM",

"AirportName": "Mumbai",

"CityCode": "BOM",

"CityName": "Mumbai",

"CountryCode": "IN",

"CountryName": "India",

"Terminal": "1"

},

"FlightNumber": "167",

"DepartureTime": "2020-05- 13T07:30:00",

"ArrivalTime": "2020-05- 13T09:40:00",

"BookingClass": "L",

"FlightStatus": 0,

"Status": null,

"MealType": null,

"ETicketEligible": true,

"AirlinePNR": null,

"Craft": "320",

"StopOver": false,

"Stops": 0,

"Mile": 0,

"Duration": "02:10:00",

"GroundTime": "00:00:00",

"AccumulatedDuration": "02:10:00",

"StopPoint": null,

23
 "StopPointArrivalTime": "0001-01-01T00:00:00",

"StopPointDepartureTime": "0001-01- 01T00:00:00",

"IncludedBaggage": "15 KG",

"CabinBaggage": " 7 KG",

"CabinClass": "",

"AdditionalBaggage": null,

"AirlineDetails": {

"AirlineCode": "6E",

"FlightNumber": "167",

"Craft": "320",

"AirlineName": "Indigo",

"OperatingCarrier": null,

"AllianceInfo": null

},

"AirlineName": "Indigo",

"DepartureDateTime": null,

"DepartureDate": null,

"ArrivalDateTime": null,

"ArrivalDate": null,

"LayoverText": null,

"InFlightServices": null

],

"NoOfSeatAvailable": 2,

"AllianceInfo": null,

"OperatingCarrier": null,

"SegmentIndicator": 3,

24
 "Airline": "6E",

"Origin": {

"AirportCode": "BO M",

"AirportName": "Mumbai",

"CityCode": "BOM",

"CityName": "Mumbai",

"CountryCode": "IN",

"CountryName": "India",

"Terminal": "1"

},

"Destination": {

"AirportCode": "BLR",

"AirportName": "Bengaluru Intl",

"CityCode": "BLR",

"CityName": "Bangalore",

"CountryCode": "IN",

"CountryName": "India",

"Terminal": "1"

},

"FlightNumber": "715",

"DepartureTime": "2020-05- 15T07:35:00",

"ArrivalTime": "2020-05- 15T09:30:00",

"BookingClass": "L",

"FlightStatus": 0,

"Status": null,

"MealType": null,

"ETicketEligible": true,

"AirlinePNR": null,

"Craft": "320",

25
 "StopOver": false,

"Stops": 0,

"Mile": 0,

"Duration": "01:55:00",

"GroundTime": "00:00:00",

"AccumulatedDuration": "00:00:00",

"StopPoint": null,

"StopPointArrivalTime": "0001-01-01T00:00:00",

"StopPointDepartureTime": "0001-01- 01T00:00:00",

"IncludedBaggage": "15 KG",

"CabinBaggage": " 7 KG",

"CabinClass": "",

"AdditionalBaggage": null,

"AirlineDetails": {

"AirlineCode": "6E",

"FlightNumber": "715",

"Craft": "320",

"AirlineName": "Indigo",

"OperatingCarrier": null,

"AllianceInfo": null

},

"AirlineName": "Indigo",

"DepartureDateTime": null,

"DepartureDate": null,

"ArrivalDateTime": null,

"ArrivalDate": null,

"LayoverText": null,

"InFlightServices": null

},

26
 {

"NoOfSeatAvailable": 2,

"AllianceInfo": null,

"OperatingCarrier": null,

"SegmentIndicator": 3,

"Airline": "6E",

"Origin": {

"AirportCode": "BLR",

"AirportName": "Bengaluru Intl",

"CityCode": "BLR",

"CityName": "Bangalore",

"CountryCode": "IN",

"CountryName": "India",

"Terminal": "1"

},

"Destination": {

"AirportCode": "MAA",

"AirportName": "Chennai",

"CityCode": "MAA",

"CityName": "Chennai",

"CountryCode": "IN",

"CountryName": "India",

"Terminal": "1"

},

"FlightNumber": "6212",

"DepartureTime": "2020-05- 15T11:00:00",

"ArrivalTime": "2020- 05-15T12:05:00",

"BookingClass": "L",

"FlightStatus": 0,

27
 "Status": null,

"MealType": null,

"ETicketEligible": true,

"AirlinePNR": null,

"Craft": "320",

"StopOver": false,

"Stops": 0,

"Mile": 0,

"Duration": "01:05:00",

"GroundTime": "01:30:00",

"AccumulatedDuration": "04:30:00",

"StopPoint": null,

"StopPointArrivalTime": "0001-01-01T00:00:00",

"StopPointDepartureTime": "0001-01- 01T00:00:00",

"IncludedBaggage": "15 KG",

"CabinBaggage": " 7 KG",

"CabinClass": "",

"AdditionalBaggage": null,

"AirlineDetails": {

"AirlineCode": "6E",

"FlightNumber": "6212",

"Craft": "320",

"AirlineName": "Indigo",

"OperatingCarrier": null,

"AllianceInfo": null

},

"AirlineName": "Indigo",

"DepartureDateTime": null,

28
 "DepartureDate": null,

"ArrivalDateTime": null,

"ArrivalDate": null,

"LayoverText": null,

"InFlightServices": null

],

"FareRules": [

"Origin": "DXB",

"Destination": "DEL",

"Airline": "6E",

"FareRestriction": null,

"FareBasisCode": "LLOAE",

"FareRuleDetail": null,

"DepartureDate": "0001-01-01T00:00:00",

"FlightNumber": null

},

"Origin": "DEL",

"Destination": "BOM",

"Airline": "6E",

"FareRestriction": null,

"FareBasisCode": "L015AP",

"FareRuleDetail": null,

"DepartureDate": "0001-01-01T00:00:00",

"FlightNumber": null

},

29
{

"Origin": "BOM",

"Destination": "BLR",

"Airline": "6E",

"FareRestriction": null,

"FareBasisCode": "L0IP",

"FareRuleDetail": null,

"DepartureDate": "0001-01-01T00:00:00",

"FlightNumber": null

},

"Origin": "BLR",

"Destination": "MAA",

"Airline": "6E",

"FareRestriction": null,

"FareBasisCode": "L0IP",

"FareRuleDetail": null,

"DepartureDate": "0001-01-01T00:00:00",

"FlightNumber": null

],

"ValidatingAirline": "6E",

"TripIndicator": 1,

"ResponseTime": "2020-04-20T08:15:37",

"JourneyType": 3

],

"IsDomestic": false,

30
 "LocalCurrency": "JOD",

"LocalCurrencyROE": 0.709,

"IsSuccess": true,

"Errors": [],

"Alerts": [],

"TokenId": "89a5a94a-07ac-4918-94be-863d67c67188",

"TrackingId": "0fe8a2df-fa12-4218-9776-ba8e82e28168"

Search API Parameter Definition -

31
 Search REQUEST

Mandatory/
Optional
Level Element Format Comments

1 Ipaddress String IP Address of the end Mandatory

Mandatory (Token Id to
be echoed back from
2 TokenId String Token ID
Authenticate response)

Browser Information
like
3 Mozilla/5.0(Windows

NT 6.1)
EndUserBrowserAgent String Mandatory

Departure Country
4
PointOfSale String code Mandatory

5 Departure Country
RequestOrigin String name Mandatory

6 AdultCount Integer Number of adults Mandatory

Mandatory (Minimum
7 ChildCount Integer Number of children(s) value should be 0)

Mandatory (Minimum
8 InfantCount Integer Number of infants value should be 0 )

Mandatory
1-
9 JourneyType Enumeration Specify journey type
OneWay

2 - Return

3 - MultiCity

32
 Mandatory 1 - All Class 2 -
Economy

3 - PremiumEconomy

4 - Business
10 FlightCabinClass Enumerator Cabin class 5 - PremiumBusiness

6 - First

11 PreferredAirlines Airline code Optional ["WY","EK"]

12 Segments [] List of segments

12.1 Origin String Origin city code Mandatory (e.g., DEL)

12.2 Destination String Destination city code Mandatory (e.g., DXB)

12.3 PreferredDepartureTime Date Time Preferred departure date Mandatory (e.g., -2020-
05- 29T00:00:00)

12.4 PreferredArrivalTime Date Time Preferred arrival date Mandatory (e.g. - 2020- 05-

29T00:00:00)

33
 Search RESPONSE

Mandatory/Optional

Level Element Format Comments

1 TrackingId String TrackingId Mandatory

Mandatory (Value - true orfalse)

2 IsDomestic Boolean LCC/Non LCC

Mandatory0 - Success

3 Status Response Status 1 - Failed

4 Result []

4.1 ResultId String ResultId Mandatory

4.2 Origin String Origin city code Mandatory

4.3 Destination String Destination city Mandatory

code

Mandatory (Value – true orfalse)

Is the result for
4.4 IsLCC Boolean LCCor Non
LCC

Mandatory (Value – true orfalse)

Fare refundable
4.5 NonRefundable Boolean ornot

4.6 AirlineRemarks String Airline remarks Optional

5 Fare

Total fare of
5.1 TotalFare Decimal Mandatory
the
booking
Type of the
5.2 FareType String Mandatory
fare
Agency
5.3 AgentMarkup Decimal Non Mandatory
markup
as per the
configura
ble

34
 Other Charge
5.4 OtherCharges Decimal Mandatory

Agency
5.5 AgentPreferredCurre String Mandatory
Preferred
ncy Currency
Service Fee
5.6 ServiceFee Decimal Mandatory

The total Base

5.7 BaseFare Decimal Mandatory
fare of
the
booking
The total tax
5.8 Tax Decimal Mandatory
of the
booking
Details of fare
breakup
into
several
6 FareBreakdown[] part. It
give fare
of Each
Passenger
Type.
Currency
6.1 Currency String Mandatory

Mandator y Adult – 1

Child – 2
Passenger
6.2 PassengerType String Type Infant – 3

Number of
6.3 PassengerCount Integer Mandatory
Passenger
Total Fare
6.4 TotalFare Decimal Mandatory

Other charges
6.5 Other Charges Decimal Mandatory

Agency
6.6 AgencyMarkup Decimal Mandatory
Markup
Transaction
6.7 Service Fee Decimal Mandatory
fee
The total Base
6.8 BaseFare Decimal Mandatory
fare of

35
 the
booking
The total tax
of the
6.9 Tax Decimal booking Mandatory
for
particular
pax type
Last ticket
6.1 LastTicketDate Date Time Mandatory
date
Ticket
6.11 TicketAdvisory String Optional
Advisory

7 Segments[]

Number of
7.1 NoOfSeatAvailable Integer Mandatory
Seats
Airline name
7.2 OperatingCarrier String Mandatory

Mandatory 1 - Outbound
Segment
7.3 SegmentIndicator Integer Indicator 2 - Inbound flights

Airline code
7.4 Airline String Mandatory

8 Origin

Airport code
8.1 AirportCode String Mandatory

Airport name
8.2 AirportName String Optional

Terminal
8.3 Terminal String Optional
number
City code
8.4 CityCode String Mandatory

City name
8.5 CityName String Mandatory

Country code
8.6 CountryCode String Mandatory

Country name
8.7 CountryName String Mandatory

9 Destination

36
 Airport code
9.1 AirportCode String Mandatory

Airport name
9.2 AirportName String Optional

Terminal
9.3 Terminal String Optional
number
City code
9.4 CityCode String Mandatory

City name
9.5 CityName String Mandatory

Country code
9.6 CountryCode String Mandatory

Country name
9.7 CountryName String Mandatory

Flight
10 FlightNumber String Mandatory
Number
Departure
11 DepartureTime Date Time Mandatory
time
Arrival time
12 ArrivalTime Date Time Mandatory

Flight status
13 FlightStatus String Mandatory

Status
14 Status String Mandatory

Mealtype
15 MealType String Null as value

Is E-Ticket
16 ETicketEligible Boolean Mandatory (Value –
eligible
true or false)

AirlinePNR
17 AirlinePNR String Null as value

Craft
18 Craft String Optional

Direct or Stop
19 StopOver Boolean Mandatory
flight
Number of
20 Stops String Mandatory
Stops
Miles
21 Mile String Optional

Optional (if in case duration is 0 refer

the node of Accumulated Duration)

37
 Duration

22 Duration Time

Ground time
23 GroundTime Time Optional

Accumulated
24 AccumulatedDuratio Time Optional
n duration

Stopover
25 StopPoint String Optional
point
Stopover
26 StopPointArrivalTime Date Time Optional
arrival
time
Stopover
27 StopPointDepartureTi Date Time Optional
departure
me time
Checkin
28 IncludedBaggage String Mandatory
Baggage

Mandatory Included or KG or

29 CabinBaggage PC
Cabin
String Baggage

Economy/Premium
Economy/Business/ First etc.
30 CabinClass
Class type
String

31 AdditionalBaggage Any Additional Baggage

Additional
String Baggage
Airline
32 AirlineDetails Mandatory
Informati
on
Airline code
33 AirlineCode String Mandatory

Flight number
34 FlightNumber String Mandatory

Craft craft
35 Craft String Mandatory

Airline name
36 AirlineName String Mandatory

38
 Operating
37 OperatingCarrier String Mandatory
Carrier
Alliance info
38 AllianceInfo String Mandatory

Airline name
39 AirlineName String Mandatory

Departure
40 DepartureDateTime String Mandatory
time
Depature
41 DepatureDate String Mandatory
date
Arrival time
42 ArrivalDateTime String Mandatory

Arrival time
43 ArrivalTime String Mandatory

Layover text
44 LayoverText String Mandatory

In service
45 InFlightService String Mandatory

Validating
46 ValidatingAirline String Mandatory
airline

Mandatory 1 - Outbound
Trip Indicator
TripIndicator Integer 2 - Inbound flights

47

Response
48 ResponseTime String
time

1- OneWay

JourneyType String 2- Retun

Journey type
49 3- Multi-Stop

Is success
50 IsSuccess Mandatory

This is the
fare rules
FareRules[] FareRules of the
flight fare
51 offered

Origin
51.1 Origin String Mandatory

39
 Destination
51.2 Destination String Mandatory

Airline
51.3 Airline String Mandatory

Fare basis
5.4 FareBasisCode String Mandatory
code
Fare rule
51.5 FareRuleDetail String List Mandatory
details
Fare
51.6 FareRestriction String Mandatory
restrictio
n
Departure
51.7 DepartureDate String Mandatory
date
Flight number
51.8 FlightNumber String Mandatory

Preferred
52 LocalCurrency String Mandatory
Currency
LocalCurrency
LocalCurrencyROE String Mandatory
ROE
53 w.r.t USD
Code
correspon
54 ErrorCode Integer ding to Mandatory
the Error

Mandatory (Will contain error

description corresponding to
ErrorCode. Error Message would be
blank in case ErrorCode=0)

Contains
error
message
55 ErrorMessage String

40
 Wallet Balance Check API –
Service URL -> 'https://xmloutapi.tboair.com/API/V1//Wallet/GetAvailableBalance'
Request Sample –
{
"TokenId": "7336c529-51b4-4636-8f2d-94f3f9b2c285" }'
Response Sample –
{
"Agency": {
"TotalAvailableLimit": 9999319780.24,
"Currency": "USD",
"LocalCurrency": "USD",
"LocalCurrencyROE": 0.0
},
"IsSuccess": true,
"Errors": [ ],
"Alerts": [],
"TokenId": "7336c529-51b4-4636-8f2d-94f3f9b2c285",
"TrackingId": "3675e6f6-1830-43ff-8a52-233b5b0199d2"
}

For all the updates on changes in API please follow this link – https://xmloutapi.tboair.com/Help

41