Documentation
ITS API Documentation - Created by ITS
Access Token
API used to get the access to all the API using access token.
Sample Response:
{
"access_token": "eRnIrit83Svr42G9kbxtYBXoZWsq1x9LbySNN0Ry79oCCu-4klvy3-bL1Qj6Tmz0cfsK-uqUh7JHTBHSno-ovOV1932bMMabSp96IyDslUk8U0zLVOxuGkk6VGlYHUkt0HU2IuUgelJoI3OJtz7Hq_lrBAHRsIYer9rnpYckCF53kHgLR_1PF8QYmx2EO3nFh86QLZsY0gHiJovMdUT8SX5NFw3qxZhabm1J3TiJ5YMcZO4536mVj6pl9cL3tTvcvYHTQxNYujaY-SztwW6fGoX60J2tbSdCorZnuZoG-A2qpkfLWdr1e8o6E59y111I",
"token_type": "bearer",
"expires_in": 1209599,
"userName": "SteveEdgerton"
}
Response Description
| Parameter | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| clientId | String | 1 | Id of the registered user | |
| clientSecret | String | 1 | Password of the registered user | |
| siteUrl | String | 1 | Url of the site |
Response Description
| Parameter | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| access_token | String | 1 | Access token for the registered user | |
| token_type | String | 1 | token type of the registered user | |
| expires_in | ticks | 1 | token expiry info | |
| userName | string | 1 | User name of the registered user |
Trip
API used to get the information of the trip.
Sample Response:
{
"trip": {
"id": 36808,
"agencyId": 1,
"clientId": 4919,
"dk": "AAC1001111",
"callbackUrl": "https://api.its-qa.com/v3",
"siteUrl": "tripeasy.its-qa.com",
"siteKey": 70,
"referenceId": "123456",
"tripName": "Las Vegas Trip",
"pnr": "NDOYNT",
"startDate": "2018-01-17T09:15:00",
"endDate": "2018-01-19T01:20:00",
"tripStatus": "Purchased",
"tripTotalBaseCost": "451.49",
"tripTotalTaxCost": "178.36",
"totalAmount": "629.85",
"bookingCharges": "5",
"currencyCode": "USD",
"bookingDate": "2017-11-04T13:24:58",
"passengers": [
{
"passengerId": 1,
"title": "Mr",
"firstName": "Brian",
"middleName": "",
"lastName": "Tanis"
}
],
"air": {
"responseId": "5D77A14F-C198-44B7-A11F-4E5225339F13",
"airRequestType": "RoundTrip",
"totalBaseCost": "133.96",
"totalTaxCost": "47.04",
"totalAmount": "181",
"airLegs": [
{
"legNumber": 1,
"noOfStops": 1,
"ticketInfo": {
"ticketNumber": "0167015787733",
"passengerId": 1,
"invoiceNumber": "0565178",
"issuedDate": "2017-11-04T03:57:00",
"baseFare": "25.12",
"taxFare": "24.68",
"totalFare": "49.8"
},
"isRefundable": "false",
"duration": "PT04:35:00",
"fareRules": "Penalties Information is described below",
"airSegments": [
{
"legNumber": 1,
"segmentOrder": 1,
"marketingAirlineCode": "UA",
"marketingAirlineName": "United Airlines",
"marketingflightNumber": "1822",
"operatingAirlineCode": "",
"duration": "PT02:10:00",
"miles": 650,
"departureDate": "2018-01-17T09:15:00",
"arrivalDate": "2018-02-17T09:15:00",
"departureAirportCode": "DFW",
"arrivalAirportCode": "DEN",
"airBookingClass": "N",
"brandName": "BASIC ECONOMY",
"airCabin": "Economy",
"departureOffset": -6,
"arrivalOffset": -7,
"carrierDetails": "AIRBUS INDUSTRIE A319",
"airlineLocator": "LTEBTJ",
"operatedAirlineName": "",
"departAirportName": "Dallas Fort Worth Intl Airpt",
"departAirportCityCode": "DFW",
"departAirportCityName": "Dallas",
"departAirportStateCode": "TX",
"departAirportCountryCode": "US",
"arrivalAirportName": "Denver International Airport",
"arrivalAirportCityCode": "DEN",
"arrivalAirportCityName": "Denver",
"arrivalAirportStateCode": "CO",
"arrivalAirportCountryCode": "US",
"seatNumber": "11A",
"arrivalTerminal": "",
"departureTerminal": "TERMINAL E",
"operatingflightNumber": ""
},
{
"legNumber": 1,
"segmentOrder": 2,
"marketingAirlineCode": "UA",
"marketingAirlineName": "United Airlines",
"marketingflightNumber": "301",
"operatingAirlineCode": "",
"duration": "PT01:58:00",
"miles": 609,
"departureDate": "2018-01-17T11:35:00",
"arrivalDate": "2018-01-17T12:33:00",
"departureAirportCode": "DEN",
"arrivalAirportCode": "LAS",
"airBookingClass": "N",
"brandName": "BASIC ECONOMY",
"airCabin": "Economy",
"departureOffset": -7,
"arrivalOffset": -8,
"carrierDetails": "BOEING 737-800",
"airlineLocator": "LTEBTJ",
"operatedAirlineName": "",
"departAirportName": "Denver International Airport",
"departAirportCityCode": "DEN",
"departAirportCityName": "Denver",
"departAirportStateCode": "CO",
"departAirportCountryCode": "US",
"arrivalAirportName": "McCarran International Airport",
"arrivalAirportCityCode": "LAS",
"arrivalAirportCityName": "Las Vegas",
"arrivalAirportStateCode": "NV",
"arrivalAirportCountryCode": "US",
"seatNumber": "15A",
"arrivalTerminal": "TERMINAL 3",
"departureTerminal": "",
"operatingflightNumber": ""
}
]
},
{
"legNumber": 2,
"noOfStops": 0,
"ticketInfo": {
"ticketNumber": "0017015787734",
"passengerId": 1,
"invoiceNumber": "0565179",
"issuedDate": "2017-11-04T03:57:00",
"baseFare": "108.84",
"taxFare": "22.36",
"totalFare": "131.2"
},
"isRefundable": "false",
"duration": "",
"fareRules": "Penalties Information is described below",
"airSegments": [
{
"legNumber": 2,
"segmentOrder": 1,
"marketingAirlineCode": "AA",
"marketingAirlineName": "American Airlines",
"marketingflightNumber": "402",
"operatingAirlineCode": "",
"duration": "PT02:35:00",
"miles": 1050,
"departureDate": "2018-01-19T01:20:00",
"arrivalDate": "2018-01-19T05:55:00",
"departureAirportCode": "LAS",
"arrivalAirportCode": "DFW",
"airBookingClass": "B",
"brandName": "BASIC ECONOMY",
"airCabin": "Economy",
"departureOffset": -8,
"arrivalOffset": -6,
"carrierDetails": "AIRBUS INDUSTRIE A319",
"airlineLocator": "NDOYNT",
"operatedAirlineName": "",
"departAirportName": "McCarran International Airport",
"departAirportCityCode": "LAS",
"departAirportCityName": "Las Vegas",
"departAirportStateCode": "NV",
"departAirportCountryCode": "US",
"arrivalAirportName": "Dallas Fort Worth Intl Airpt",
"arrivalAirportCityCode": "DFW",
"arrivalAirportCityName": "Dallas",
"arrivalAirportStateCode": "TX",
"arrivalAirportCountryCode": "US",
"seatNumber": "15B",
"arrivalTerminal": "",
"departureTerminal": "TERMINAL 1",
"operatingflightNumber": ""
}
]
}
]
},
"lodging": {
"totalBaseCost": "169",
"totaltaxCost": "40",
"totalAmount": "209",
"hotel": [
{
"responseId": "5D77A14F-C198-44B7-A11F-4E5225339F13",
"hotelName": "Ballys Las Vegas - Hotel & Casino",
"checkInDate": "2018-01-17T00:00:00",
"checkOutDate": "2018-01-19T00:00:00",
"checkInTime": "T11:00:00",
"checkOutTime": "T15:00:00",
"totalBasePrice": "169",
"taxCost": "40",
"totalAmount": "209",
"cancellationPolicy": "",
"depositAmount": "",
"guestCount": "",
"additionalInfo": {
"latitude": "36.11358",
"longitude": "-115.17279",
"line1": "3645 Las Vegas Blvd S",
"cityName": "Las Vegas",
"stateCode": "LA",
"countryCode": "US",
"zipCode": "89109",
"phoneNumber": "1-352-3768873",
"cityCode": "LAS",
"chainCode": "",
"chainName": "",
"rating": "3.5",
"tripAdvisorRating": "",
"HotelImageUrl": ""
},
"invoiceInfo": {
"passengerId": 1,
"confirmationNumber": 97195543,
"invoiceNumber": "0570463"
}
}
]
},
"ground": {
"totalBaseCost": "148.53",
"totaltaxCost": "91.32",
"totalAmount": "239.85",
"car": [
{
"responseId": "CDB1C297-CC8C-4967-9472-E6B78269DF2C",
"carPickUpLocationCode": "LAS",
"carDropOffLocationCode": "LAS",
"startDate": "2018-01-17T08:51:00",
"endDate": "2018-01-19T07:40:00",
"vehicleName": "FORD FUSION OR SIMILAR",
"carCompanyName": "National",
"mileageAllowance": "UNL",
"baseCost": "148.53",
"taxCost": "91.32",
"totalAmount": "239.85",
"cancellationPolicy": "",
"locationInfo": {
"carPickUpLocationCategoryCode": "LAS",
"pickUpCity": "LAS VEGAS",
"pickUpState": "LA",
"pickupCountry": "US",
"pickUpLocationName": "LASO01 LAS VEGAS MC CARRAN",
"pickUpLocationAddress": "220 E WARM SPRINGS RD",
"pickUpLatitude": "36.05694",
"pickUpLongitude": "-115.16307",
"dropOffLocationName": "LASO01 LAS VEGAS MC CARRAN",
"dropOffLocationAddress": "220 E WARM SPRINGS RD",
"dropOffLatitude": "36.05694",
"dropOffLongitude": "-115.16307",
"dropOffCity": "LAS VEGAS",
"dropOffState": "LA",
"dropOffCountry": "US",
"carDropOffLocationCategoryCode": "LAS",
"carCodeDescription": "2/4 Door",
"carCodeTransmission": "Automatic",
"carCodeAC": "1",
"carCodeClass": "Fullsize"
},
"invoiceInfo": {
"confirmationNumber": "1035524327COUNT",
"invoiceNumber": ""
}
}
]
}
}
}
Response Description
| Parameter | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| accessToken | String | 1 | Token recieved from the authentication API | |
| tripKey | String | 1 | The key for which the information is required | |
| targetClient | String | 1 | The value will be standard for all API and mobile to consume for mobile client |
Response Description
| Parameter | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| id | long | 1 | ITS itinerary unique ID | |
| agencyId | long | 1 | Agency Id user belongs to. | |
| clientId | long | 1 | Client Id user belongs to. | |
| dk | string | 1 | DK Number user belongs to. | |
| callbackUrl | string | 1 | endpoint api to be called. | |
| siteUrl | string | 1 | url of the site to be passed while getting the access token. | |
| siteKey | long | 1 | site key for the pnr. | |
| referenceId | string | 1 | Reference Id of the vendor. | |
| tripName | string | 1 | 100 | Itinerary Display Name |
| pnr | string | 1 | 50 | GDS Record Locator |
| startDate | datetime | 1 | Start date of Itinerary | |
| endDate | datetime | 1 | End date of Itinerary | |
| tripStatus | datetime | 1 | Itinerary statuses- Pending, Purchased,PendingCancel,Canceled,Exchanged,Held | |
| tripTotalBaseCost | double | 1 | The grand total of all trip element’s base cost in the itinerary. | |
| tripTotalTaxCost | double | 1 | The grand total of all trip element’s tax cost in the itinerary. | |
| bookingCharges | double | 0 or 1 | Booking Charges incurred for Purchasing. | |
| totalAmount | double | 1 | The grand total of all trip element’s base with tax cost in the itinerary. | |
| currencyCode | string | 1 | 3 | Currency of Trip Element’s Cost. |
| bookingDate | datetime | 1 | The date and time that the itinerary was booked. | |
| passengers | array | 1 to many | A list of all passenger booked in the itinerary. | |
| air | object | 0 or 1 | Description of Air Data contained in the Itinerary. | |
| lodging | double | 0 or many | List of lodging Data contained in the Itinerary | |
| ground | double | 0 or many | List of ground Data contained in the Itinerary. |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| passengerId | long | 1 | Passenger Unique ITS ID | |
| title | string | 200 | Passenger Title | |
| firstName | string | 400 | Passenger first name | |
| middleName | string | 400 | Passenger middle name | |
| lastName | string | 400 | Passenger last name |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| responseId | long | 1 | ITS itinerary unique air Element ID | |
| airRequestType | string | 1 | Type of Air Element. OneWay, RoundTrip or MultiCity | |
| totalBaseCost | double | 1 | Total Base Cost of All Air Element’s Fares | |
| totalTaxCost | double | 1 | Total Tax Cost of All Air Element’s Fares | |
| totalAmount | double | 1 | Total of Base and Tax Cost of All Air Element’s Fares | |
| airLegs | array | 1 or many | Legs Information of the Air element present in the itinerary. |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| legNumber | int | 1 | Number of the leg | |
| noOfStops | int | 1 | No of Stops for the leg | |
| ticketInfo | object | 1 | Ticket Information of the leg | |
| isRefundable | boolean | 1 | The leg is refundable or not | |
| duration | ISO standard format | 1 | The total duration of the leg | |
| fareRules | string | 0 or 1 | Maximum | The rules of fare selected for the leg. |
| airSegments | array | 1 or many | Segments Information contained in the leg. |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| ticketNumber | string | 1 | Ticket Number issued for the leg. | |
| passengerId | long | 1 | Passenger ID on which the Ticket got Issued | |
| invoiceNumber | string | 1 | Invoice Number linked to the ticket. | |
| issuedDate | datetime | 1 | Issued Date of the Ticket. | |
| baseFare | double | 0 or 1 | The base Fare of the Ticket. | |
| taxFare | double | 0 or 1 | The tax Fare of the Ticket. | |
| totalfare | double | 0 or 1 | The total Fare of the Ticket. |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| legNumber | int | 1 | Segment belonging to the Leg’s Number. | |
| segmentOrder | int | 1 | The number of the Segment in the particular Leg. | |
| marketingAirlineCode | string | 1 | Marketing Airline Code of the Segment. | |
| marketingAirlineName | string | 1 | Marketing Airline Name of the Segment. | |
| marketingflightNumber | string | 1 | Marketing Airline Flight Number for the Segment. | |
| operatingAirlineCode | string | 0 or 1 | Operating Airline Code of the Segment. | |
| duration | ISO Standard format | 1 | Duration taken by the Segment. | |
| miles | string | 0 or 1 | Distance traveled in miles by the Segment. | |
| departureDate | datetime | 1 | Departure Date of the Segment | |
| arrivalDate | datetime | 1 | Arrival Date of the Segment. | |
| departureAirportCode | string | 1 | Departure Code of the Segment. | |
| arrivalAirportCode | string | 1 | Arrival Code of the Segment. | |
| airBookingClass | string | 1 | Booking Class of the Segment | |
| brandName | string | 0 or 1 | Brand Name of the Segment | |
| airCabin | string | 1 | Cabin of the Segment.Economy,Premium Economy, Business, First. | |
| departureOffset | signed int | 1 | Departure Offset of the Segment. | |
| arrivalOffset | signed int | 1 | Arrival Offset of the Segment. | |
| carrierDetails | string | 1 | Carrier Details of the Segment. | |
| airlineLocator | long | 1 | Airline Locator on the Segment Level. | |
| operatedAirlineName | string | 0 or 1 | Operating Airline Name of the Segment.. | |
| departAirportName | string | 1 | Name of the Departure Airport. | |
| departAirportCityCode | string | 1 | City Code of the Departure Airport. | |
| departAirportCityName | string | 1 | City Name of the Departure Airport. | |
| departAirportStateCode | string | 1 | State Code of the Departure Airport. | |
| departAirportCountryCode | string | 1 | Country Code of the Departure Airport. | |
| arrivalAirportName | string | 1 | Name of the Arrival Airport. | |
| arrivalAirportCityCode | string | 1 | City Code of the Arrival Airport. | |
| arrivalAirportCityName | string | 1 | City Name of the Arrival Airport. | |
| arrivalAirportStateCode | string | 1 | State Code of the Arrival Airport. | |
| arrivalAirportCountryCode | string | 1 | Country Code of the Arrival Airport. | |
| seatNumber | string | 0 or 1 | Seat Number Booked for the Segment. | |
| arrivalTerminal | string | 0 or 1 | Terminal Name at the Arrival Airport. | |
| departureTerminal | string | 0 or 1 | Terminal Name at the Departure Airport. | |
| operatingflightNumber | string | 0 or 1 | Operating Airline Flight Number for the Segment. |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| totalBaseCost | double | 1 | Total Base Cost of all the lodgings Booked in the itinerary. | |
| totalTaxCost | double | 1 | Total Tax Cost of all the Hotels Booked in the itinerary | |
| totalAmount | double | 1 | Total Cost of all the Hotels Booked in the itinerary | |
| hotel | array | 1 or many | list of booked hotels. |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| responseId | string | 1 | ITS itinerary unique hotel Element ID. | |
| hotelName | string | 1 | Name of the Hotel Booked. | |
| checkInDate | datetime | 1 | Checkin Date of the Hotel Booked. | |
| checkOutDate | datetime | 1 | Checkout Date of the Hotel Booked. | |
| checkInTime | ISO Standard Time | 1 | Expected time for checkin in the Hotel Booked. | |
| checkOutTime | ISO Standard Time | 1 | Expected time for checkout in the Hotel Booked. | |
| totalBasePrice | double | 1 | Base Price of the Hotel booked. | |
| taxCost | double | 1 | Tax Cost of the Hotel booked. | |
| totalAmount | double | 1 | Total of Base Price and Tax Cost of the Hotel booked. | |
| cancellationPolicy | string | 0 or 1 | Cancellation Policy Related to the Hotel. | |
| depositAmount | double | 0 or 1 | Amount paid for the Hotel Booked. | |
| guestCount | int | 0 or many | No of Guests booked for the Room in the Hotel. | |
| additionalInfo | Object | 1 | Additional Info related to the Hotel Booked. | |
| invoiceInfo | Object | 1 | Invoice Info related to the Hotel Booked. |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| latitude | double | 0 or 1 | Latitude of the Hotel | |
| longitude | double | 0 or 1 | Longitude of the Hotel | |
| line1 | string | 1 | Address of the Hotel Booked. | |
| cityName | string | 1 | City Name where the hotel is situated. | |
| stateCode | string | 1 | State Code where the hotel is situated. | |
| countryCode | string | 1 | Country Code where the hotel is situated. | |
| zipCode | string | 1 | Zip Code where the hotel is situated. | |
| phoneNumber | string | 0 or 1 | Contact Number of the Hotel. | |
| cityCode | string | 1 | City Code where the hotel is situated. | |
| chainCode | string | 0 or 1 | Chain Code if the Hotel belongs to it. | |
| chainName | string | 0 or 1 | Chain Name if the Hotel belongs to it. | |
| rating | double | 0 or 1 | Additional Info related to the Hotel Booked. | |
| tripAdvisorRating | double | 0 or 1 | Rating of the Hotel. | |
| HotelImageUrl | string | 0 or 1 | Image url for the hotel. |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| passengerId | long | 1 | Passenger ID on which the Ticket got Issued | |
| invoiceNumber | string | 1 | Invoice Number linked to the ticket. | |
| confirmationNumber | string | 1 | Confirmation Number for the Hotel Booking Done. |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| totalBaseCost | double | 1 | Total Base Cost of all the Grounds Booked in the itinerary. | |
| totalTaxCost | double | Total Tax Cost of all the Grounds Booked in the itinerary | ||
| totalAmount | double | Total Cost of all the Grounds Booked in the itinerary | ||
| car | array | list of booked cars. |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| responseId | string | 1 | ITS itinerary unique car Element ID. | |
| carPickUpLocationCode | string | 1 | PickUp Location of the Car Booked. | |
| carDropOffLocationCode | string | 1 | DropOff Location of the Car Booked. | |
| startDate | datetime | 1 | Start Date of the Car Booked. | |
| endDate | datetime | 1 | End Date of the Car Booked. | |
| VehicleName | datetime | 1 | Vehicle Name of the Car Booked. | |
| carCompanyName | datetime | 1 | Company Name of the Car Booked | |
| mileageAllowance | ISO Standard Time | 1 | mileage allowed for the car booked. | |
| baseCost | double | 1 | Base Price of the car booked. | |
| taxCost | double | 1 | Tax Cost of the car booked. | |
| totalAmount | double | 1 | Total of Base Price and Tax Cost of the car booked. | |
| cancellationPolicy | string | 0 or 1 | Cancellation Policy Related to the car. | |
| locationInfo | Object | 1 | Additional Info related to the car Booked. | |
| invoiceInfo | Object | 1 | Invoice Info related to the car Booked. |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| carPickUpLocationCategoryCode | double | 1 | PickUp Location category Code for the Car Booked. | |
| pickUpCity | double | 1 | PickUp City of the Car Booked. | |
| pickUpState | string | 1 | PickUp State of the Car Booked. | |
| pickUpCountry | string | 1 | PickUp Country of the Car Booked. | |
| pickUpLocationName | string | 1 | PickUp Location Name of the Car Booked. | |
| pickUpLocationAddress | string | 1 | PickUp Location Address of the Car Booked. | |
| pickUpLatitude | string | 1 | PickUp Latitude of the Car Booked. | |
| pickUpLongitude | string | 1 | PickUp Longitude of the Car Booked. | |
| dropOffLocationName | string | 1 | DropOff Location Name of the Car Booked. | |
| dropOffLocationAddress | string | 1 | DropOff Location Address of the Car Booked. | |
| dropOffLatitude | string | 1 | DropOff Latitude of the Car Booked. | |
| dropOffLongitude | double | 1 | DropOff Longitude of the Car Booked. | |
| dropOffCity | double | 1 | DropOff City of the Car Booked. | |
| dropOffState | string | 1 | DropOff State of the Car Booked. | |
| dropOffCountry | string | 1 | DropOff Country of the Car Booked. | |
| carDropOffLocationCategoryCode | string | 1 | DropOff Location category Code for the Car Booked. | |
| carCodeDescription | string | 1 | Description of the Car Booked. | |
| carCodeTransmission | string | 1 | Transmission Description of the Car Booked. | |
| carCodeAC | string | 1 | Air Conditioner Availability in the Car Booked. | |
| carCodeClass | string | 1 | Class of the Car Booked. |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| passengerId | long | 1 | Passenger ID on which the Ticket got Issued for car | |
| invoiceNumber | string | 1 | Invoice Number linked to the ticket for car. | |
| confirmationNumber | string | 1 | Confirmation Number for the car Booking Done. |
API used to approve/deny the trip.
Sample Response:
{
"isSuccess": false,
"error": {
"errorCode": "401.5",
"errorMessage": "Sabre coonection failure"
}
}
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| tripKey | long | 1 | The key for the trip | |
| pnr | string | 1 | The pnr for the trip | |
| approvalStatus | string | 1 | The values can be Approved or Denied | |
| approver | string | 1 | The person who denied/approved the trip | |
| approvalReason | string | 1 | the reason for approve/deny |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| isSuccess | bool | 1 | Trip purchased succesfully or not | |
| error | objecct | null or 1 | in case of failure, error object is received |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| errorCode | string | 1 | Different error codes to determine the issue | |
| errorMessage | string | Error Message for the error occured |
API used to get the policy for the trip.
Sample Response:
{
"PNR": "DLKBPT",
"ApprovalReasons": [
"Trip To DFW needs approval",
"Air - Trip more than $320.4",
"Hotel - Trip more than $129",
"Car - Trip more than $50"
],
"ApproverAddresses": [
"abc@xyz.com"
],
"ReceiptAddresses": [
"jkl@xyz.com",
"pqr@xyz.com"
],
"BackupApproverAddresses": [
"abc@xyz.com",
"lmn@xyz.com",
"def@xyz.com"
],
"ApprovalDeadline": "2018-05-23T11:03:20",
"AirPolicy": {
"Reason": "OOP",
"PolicyFare": 320.4,
"ActualFare": 731.01
},
"HotelPolicy": {
"Reason": "OOP",
"PolicyFare": 129,
"ActualFare": 231.99
},
"CarPolicy": {
"Reason": "High",
"PolicyFare": 50,
"ActualFare": 51.11
}
}
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| tripKey | long | 1 | The key for the trip |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| PNR | string | one | GDS Record Locator for the trip. | |
| ApprovalReasons | list of string | one or many | List of Approval Reasons. | |
| ApproverAddresses | list of string | one or many | List of Approver’s email addresses. | |
| ReceiptAddresses | list of string | one or many | List of Receiver’s email addresses. | |
| BackupApproverAddresses | list of string | one or many | List of backup Approver’s email addresses. | |
| ApprovalDeadline | datetime | one | Approval Deadline. | |
| AirPolicy | object | one or many | Air Policy Breached | |
| HotelPolicy | object | one or many | Hotel Policy Breached. | |
| CarPolicy | object | one or many | Car Policy Breached |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| Reason | string | one | Air – Reason for policy breached | |
| PolicyFare | double | one | Air – Max policy fare allowed | |
| ActualFare | double | one | Air – Actual fare booked for this trip |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| Reason | string | one | Hotel – Reason for policy breached | |
| PolicyFare | double | one | Hotel – Max policy fare allowed | |
| ActualFare | double | one | Hotel – Actual fare booked for this trip |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| Reason | string | one | Car – Reason for policy breached | |
| PolicyFare | double | one | Car – Max policy fare allowed | |
| ActualFare | double | one | Car – Actual fare booked for this trip |
Policy
API used to evaluate the policy for specific itinerary.
Sample Response:
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| UserKey | long | 1 | The key for the User | |
| CompanyKey | long | 1 | The key for the Company | |
| UserGroupKey | long | 1 | The key for the group user belongs to | |
| TravelType | string | 1 | TravelType (Corporate or Personal) | |
| IsInterNationalAir | boolean | 1 | Indicated whether Air trip is International or not | |
| IsInterNationalHotel | boolean | 1 | Indicated whether Hotel trip is International or not | |
| AirActualAmt | double | 1 | Actual Amount for Air | |
| HotelActualAmt | double | 1 | Actual Amount for Hotel | |
| HotelActualAmt2 | double | 1 | Actual Amount for Hotel II | |
| HotelActualAmt3 | double | 1 | Actual Amount for Hotel III | |
| HotelActualAmt4 | double | 1 | Actual Amount for Hotel IV | |
| HotelActualAmt5 | double | 1 | Actual Amount for Hotel V | |
| HotelActualAmt6 | double | 1 | Actual Amount for Hotel VI | |
| CarActualAmt | double | 1 | Actual Amount for Car | |
| CarActualAmt2 | double | 1 | Actual Amount for Car II | |
| CarActualAmt3 | double | 1 | Actual Amount for Car III | |
| CarActualAmt4 | double | 1 | Actual Amount for Car IV | |
| CarActualAmt5 | double | 1 | Actual Amount for Car V | |
| CarActualAmt6 | double | 1 | Actual Amount for Car VI | |
| LowestPriceAir | double | 1 | Lowest Search Price for Air | |
| LowestPriceHotel | double | 1 | Lowest Search Price for Hotel | |
| LowestPriceHotel2 | double | 1 | Lowest Search Price for Hotel II | |
| LowestPriceHotel3 | double | 1 | Lowest Search Price for Hotel III | |
| LowestPriceHotel4 | double | 1 | Lowest Search Price for Hotel IV | |
| LowestPriceHotel5 | double | 1 | Lowest Search Price for Hotel V | |
| LowestPriceHotel6 | double | 1 | Lowest Search Price for Hotel VI | |
| LowestPriceCar | double | 1 | Lowest Search Price for Car | |
| IsBasic | boolean | 1 | Indicator of Basic Cabin for Air | |
| CityID | int | 1 | City Id for Selected Hotel | |
| CityID2 | int | 1 | City Id for Selected Hotel II | |
| CityID3 | int | 1 | City Id for Selected Hotel III | |
| CityID4 | int | 1 | City Id for Selected Hotel IV | |
| CityID5 | int | 1 | City Id for Selected Hotel V | |
| CityID6 | int | 1 | City Id for Selected Hotel VI | |
| CheckInDate | datetime | 1 | Checkin Date for Selected Hotel | |
| CheckInDate2 | datetime | 1 | Checkin Date for Selected Hotel II | |
| CheckInDate3 | datetime | 1 | Checkin Date for Selected Hotel III | |
| CheckInDate4 | datetime | 1 | Checkin Date for Selected Hotel IV | |
| CheckInDate5 | datetime | 1 | Checkin Date for Selected Hotel V | |
| CheckInDate6 | datetime | 1 | Checkin Date for Selected Hotel VI | |
| CheckoutDate | datetime | 1 | Checkout Date for Selected Hotel | |
| CheckoutDate2 | datetime | 1 | Checkout Date for Selected Hotel II | |
| CheckoutDate3 | datetime | 1 | Checkout Date for Selected Hotel III | |
| CheckoutDate4 | datetime | 1 | Checkout Date for Selected Hotel IV | |
| CheckoutDate5 | datetime | 1 | Checkout Date for Selected Hotel V | |
| CheckoutDate6 | datetime | 1 | Checkout Date for Selected Hotel VI | |
| Airlines | string | 1 | Airlines for Selected Air | |
| ChainCodes | string | 1 | ChainCodes for Selected Hotel | |
| CarVendors | string | 1 | Vendors for Selected Car | |
| HotelStarRating | string | 1 | Star rating for Selected Hotel | |
| IsPayLaterSelected | boolean | 1 | Indicator of pay later hotel | |
| IsPayNowSelected | boolean | 1 | Indicator of pay now hotel | |
| TripStartDate | datetime | 1 | Trip start date for air | |
| ServiceClassSelected | string | 1 | Service class for each segment of Selected Air | |
| NoofHoursPerSegmentLeg1 | string | 1 | No of Hours for each segment of Selected Air Leg1 | |
| NoofHoursPerSegmentLeg2 | string | 1 | No of Hours for each segment of Selected Air Leg2 | |
| NoofHoursPerSegmentLeg3 | string | 1 | No of Hours for each segment of Selected Air Leg3 | |
| NoofHoursPerSegmentLeg4 | string | 1 | No of Hours for each segment of Selected Air Leg4 | |
| NoofHoursPerSegmentLeg5 | string | 1 | No of Hours for each segment of Selected Air Leg5 | |
| NoofHoursPerSegmentLeg6 | string | 1 | No of Hours for each segment of Selected Air Leg6 | |
| airLegBrandNameLeg1 | string | 1 | BrandName for Air Leg1 | |
| airLegBrandNameLeg2 | string | 1 | BrandName for Air Leg2 | |
| airLegBrandNameLeg3 | string | 1 | BrandName for Air Leg3 | |
| airLegBrandNameLeg4 | string | 1 | BrandName for Air Leg4 | |
| airLegBrandNameLeg5 | string | 1 | BrandName for Air Leg5 | |
| airLegBrandNameLeg6 | string | 1 | BrandName for Air Leg6 | |
| NoofTraveler | int | 1 | No of Traveler | |
| airPriceSurgeAmount | double | 1 | Surge Amount after Reprice |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| PNR | string | one | GDS Record Locator for the trip. | |
| ApprovalReasons | list of string | one or many | List of Approval Reasons. | |
| ApproverAddresses | list of string | one or many | List of Approver’s email addresses. | |
| ReceiptAddresses | list of string | one or many | List of Receiver’s email addresses. | |
| BackupApproverAddresses | list of string | one or many | List of backup Approver’s email addresses. | |
| ApprovalDeadline | datetime | one | Approval Deadline. | |
| AirPolicy | object | one or many | Air Policy Breached | |
| HotelPolicy | object | one or many | Hotel Policy Breached. | |
| CarPolicy | object | one or many | Car Policy Breached |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| Reason | string | one | Hotel – Reason for policy breached | |
| PolicyFare | double | one | Hotel – Max policy fare allowed | |
| ActualFare | double | one | Hotel – Actual fare booked for this trip |
Response Description
| Field Name | Data Type | Max Quantity | Max Length | Description |
|---|---|---|---|---|
| Reason | string | one | Car – Reason for policy breached | |
| PolicyFare | double | one | Car – Max policy fare allowed | |
| ActualFare | double | one | Car – Actual fare booked for this trip |
