A display itinerary has all of the details in an itinerary that a traveler would want to see. This should contain specifics like notes from our system (but not from the GDS) and should have all of the parts a traveler would not care about removed.
| name | data type | constraints | description |
|---|---|---|---|
| passengers | array of DisplayPassenger | ||
| segments | array of DisplaySegment | The segments, in chronological order. | |
| invoices | array of DisplayInvoice | The invoices for this itinerary. | |
| notes | array of DisplayNotes | Any notes added to this itinerary. | |
| recordLocator | string | The agency locator for this itinerary. | |
| id | number | This itinerary's internal airportal id. | |
| citySummary | string | Get the summary of the start and end locations for the PNR. | |
| bookingAgent | string | The name of the agent that booked this trip. | |
| bookingAgentEmail | string | The email of the agent that booked this trip. | |
| afterHoursNumber | string | The phone number that the passenger should call after normal business hours for travel support. | |
| endDate | string | ||
| startDate | string | The start date of the trip, in local time. | |
| client | string | The name of the account. | |
| pcc | string | The name of the account. | |
| topNotes | array of DisplayNotes | Notes to display at the top of the trip document. | |
| customLinks | array of DisplayLink | Custom links that should be displayed on the trip document. | |
| agencyLogoLink | string | The URL of the travel agency's webpage. | |
| clientLogoLink | string | The URL of the client's home webpage. | |
| clientLogo | string | The logo of the client that bought this trip. | |
| promotionalLinks | array of DisplayLink | A list of promotional links to display on this trip's travel document. | |
| showPdf | boolean | required boolean | Whether or not to allow the traveler to download a PDF version of this trip. |
| showCalendar | boolean | required boolean | Whether or not to allow the traveler to download a calendar version of this trip. |
| agencyLogo | string | The URL to the Travel Agency's logo. | |
| clientId | number | The internal ID of the account this trip is booked under. | |
| totalCharged | string | The total amount that this trip will cost. | |
| boolean | required boolean | Whether or not this trip is ready for traveler viewing. | |
| tmcName | string | Get the name of the Travel Management Company. | |
| tmcAddress | string | Get the Travel Management Company's first line of their address. | |
| tmcCityStateZip | string | Get the Travel Management Company's second line of their address. | |
| estimatedTotalAmount | string | An estimated total amount that it will cost for this trip. | |
| estimatedTaxes | string | An estimate of the total taxes accumulated for this trip. | |
| estimatedBaseAmount | string | An estimate of the base cost of the given trip (without taxes). | |
| contactNumber | string | A phone number that the traveler can use to contact their agent. | |
| string | A URL to a banner ad that should be shown on the trip's travel document. | ||
| string | |||
| showTravelPolicy | boolean | required boolean | Whether or not to show the travel policy on this trip's travel document. |
| tollFreeNumber | string | The toll free number the traveler can contact the agent by. | |
| onlineSupportNumber | string | The online support number a traveler can get help with online bookings from | |
| invoiceFirst | boolean | required boolean | Whether or not to show the invoice at the top of a trip document or the bottom. |
| quotes | array of DisplayQuote | A list of quotes that the agent gave to the traveler as options to book. | |
| showText | boolean | required boolean | |
| importDate | number | The import date of this trip. | |
| startDateUTC | string | The start date of this trip, in UTC. | |
| endDateUTC | string | The end date of this trip, in UTC. | |
| startTimeZone | string | The time zone of the first departure of this trip. | |
| endTimeZone | string | The time zone of the last stop of this trip. | |
| approval | DisplayApproval | ||
| hotelAttachment | DisplayHotelAttachment | ||
| destinationCity | string | The name of the destination city of the trip. | |
| covidCountries | string | ||
| covidStates | string | ||
| departureCity | string | The name of the departure city of the trip. | |
| udids | array of DisplayOption | Get all UDIDs that should be displayed. | |
Properties inherited from BaseEntity |
|||
| violations | array of SimpleViolation | A list of constraint violations, if any, that this object has. | |
Example
{
"passengers" : [ {
"name" : "...",
"customName" : "...",
"id" : "...",
"userId" : "...",
"userName" : "...",
"email" : "...",
"passportNumber" : "...",
"knownTravelerNumber" : "..."
}, {
"name" : "...",
"customName" : "...",
"id" : "...",
"userId" : "...",
"userName" : "...",
"email" : "...",
"passportNumber" : "...",
"knownTravelerNumber" : "..."
} ],
"segments" : [ {
"checkOutPenalty" : "...",
"number" : 12345,
"notes" : [ {
"number" : 12345,
"text" : "..."
}, {
"number" : 12345,
"text" : "..."
} ],
"type" : "...",
"startLocationName" : "...",
"endLocationName" : "...",
"vendorName" : "...",
"startTime" : "...",
"endTime" : "...",
"startLocationHours" : "...",
"endLocationHours" : "...",
"startLocationAddress1" : "...",
"startLocationAddress2" : "...",
"startLocationPhoneNumber" : "...",
"startLocationCity" : "...",
"guaranteeRequirements" : "...",
"startLocationZip" : "...",
"dropOffCharges" : "...",
"numberOfStops" : 12345,
"cancellationNumber" : "...",
"cancellationPolicy" : "...",
"numberOfChildren" : 12345,
"startLocationCountryCode" : "...",
"startLocationStateOrRegionCode" : "...",
"endLocationCountryCode" : "...",
"endLocationStateOrRegionCode" : "...",
"startLocationStateCountry" : "...",
"endLocationAddress1" : "...",
"startTerminal" : "...",
"endTerminal" : "...",
"endLocationAddress2" : "...",
"endLocationPhoneNumber" : "...",
"endLocationCity" : "...",
"endLocationZip" : "...",
"endLocationStateCountry" : "...",
"status" : "...",
"confirmationNumber" : "...",
"renterName" : "...",
"frequentTravelerNumber" : "...",
"corpDiscountNumber" : "...",
"customerId" : "...",
"carTransmission" : "...",
"carType" : "...",
"carAirConditioning" : true,
"carClass" : "...",
"deliveryNotes" : "...",
"totalTime" : "...",
"totalMiles" : 12345,
"baggageLink" : "...",
"checkinLink" : "...",
"startLocationFaxNumber" : "...",
"endLocationFaxNumber" : "...",
"vendorNotes" : "...",
"rateInfo" : "...",
"grandTotal" : "...",
"roomDescription" : "...",
"stopOvers" : [ {
"code" : "...",
"arrivalDate" : "...",
"departureDate" : "...",
"locationName" : "...",
"cityName" : "...",
"stateCountry" : "..."
}, {
"code" : "...",
"arrivalDate" : "...",
"departureDate" : "...",
"locationName" : "...",
"cityName" : "...",
"stateCountry" : "..."
} ],
"flightNumber" : "...",
"classOfService" : "...",
"seats" : [ {
"name" : "...",
"status" : "...",
"seat" : "...",
"seatClass" : "...",
"meal" : "...",
"frequentFlyerNumber" : "...",
"position" : 12345
}, {
"name" : "...",
"status" : "...",
"seat" : "...",
"seatClass" : "...",
"meal" : "...",
"frequentFlyerNumber" : "...",
"position" : 12345
} ],
"carNumber" : "...",
"roomNumber" : "...",
"accomodationCode" : "...",
"numberOfRooms" : 12345,
"numberOfGuests" : 12345,
"additionalRoomTax" : "...",
"hplRequeueUrl" : "...",
"travelOptions" : [ {
"name" : "...",
"value" : "...",
"position" : 12345
}, {
"name" : "...",
"value" : "...",
"position" : 12345
} ],
"startCityCode" : "...",
"endCityCode" : "...",
"startLatitude" : 12345.0,
"startLongitude" : 12345.0,
"endLatitude" : 12345.0,
"endLongitude" : 12345.0,
"flightTime" : "...",
"codeShareNumber" : "...",
"codeShareInformation" : "...",
"vehicleInfo" : "...",
"legMileage" : 12345,
"groundTime" : "...",
"percentageOnTime" : 12345,
"rateDetails" : [ {
"type" : "...",
"amount" : "...",
"limit" : "...",
"extra" : "...",
"effectiveDate" : "...",
"endDate" : "..."
}, {
"type" : "...",
"amount" : "...",
"limit" : "...",
"extra" : "...",
"effectiveDate" : "...",
"endDate" : "..."
} ],
"trainNumber" : "...",
"startTimeUTC" : "...",
"endTimeUTC" : "...",
"startTimeZone" : "...",
"endTimeZone" : "...",
"voucher" : "...",
"officialStatus" : true
}, {
"checkOutPenalty" : "...",
"number" : 12345,
"notes" : [ {
"number" : 12345,
"text" : "..."
}, {
"number" : 12345,
"text" : "..."
} ],
"type" : "...",
"startLocationName" : "...",
"endLocationName" : "...",
"vendorName" : "...",
"startTime" : "...",
"endTime" : "...",
"startLocationHours" : "...",
"endLocationHours" : "...",
"startLocationAddress1" : "...",
"startLocationAddress2" : "...",
"startLocationPhoneNumber" : "...",
"startLocationCity" : "...",
"guaranteeRequirements" : "...",
"startLocationZip" : "...",
"dropOffCharges" : "...",
"numberOfStops" : 12345,
"cancellationNumber" : "...",
"cancellationPolicy" : "...",
"numberOfChildren" : 12345,
"startLocationCountryCode" : "...",
"startLocationStateOrRegionCode" : "...",
"endLocationCountryCode" : "...",
"endLocationStateOrRegionCode" : "...",
"startLocationStateCountry" : "...",
"endLocationAddress1" : "...",
"startTerminal" : "...",
"endTerminal" : "...",
"endLocationAddress2" : "...",
"endLocationPhoneNumber" : "...",
"endLocationCity" : "...",
"endLocationZip" : "...",
"endLocationStateCountry" : "...",
"status" : "...",
"confirmationNumber" : "...",
"renterName" : "...",
"frequentTravelerNumber" : "...",
"corpDiscountNumber" : "...",
"customerId" : "...",
"carTransmission" : "...",
"carType" : "...",
"carAirConditioning" : true,
"carClass" : "...",
"deliveryNotes" : "...",
"totalTime" : "...",
"totalMiles" : 12345,
"baggageLink" : "...",
"checkinLink" : "...",
"startLocationFaxNumber" : "...",
"endLocationFaxNumber" : "...",
"vendorNotes" : "...",
"rateInfo" : "...",
"grandTotal" : "...",
"roomDescription" : "...",
"stopOvers" : [ {
"code" : "...",
"arrivalDate" : "...",
"departureDate" : "...",
"locationName" : "...",
"cityName" : "...",
"stateCountry" : "..."
}, {
"code" : "...",
"arrivalDate" : "...",
"departureDate" : "...",
"locationName" : "...",
"cityName" : "...",
"stateCountry" : "..."
} ],
"flightNumber" : "...",
"classOfService" : "...",
"seats" : [ {
"name" : "...",
"status" : "...",
"seat" : "...",
"seatClass" : "...",
"meal" : "...",
"frequentFlyerNumber" : "...",
"position" : 12345
}, {
"name" : "...",
"status" : "...",
"seat" : "...",
"seatClass" : "...",
"meal" : "...",
"frequentFlyerNumber" : "...",
"position" : 12345
} ],
"carNumber" : "...",
"roomNumber" : "...",
"accomodationCode" : "...",
"numberOfRooms" : 12345,
"numberOfGuests" : 12345,
"additionalRoomTax" : "...",
"hplRequeueUrl" : "...",
"travelOptions" : [ {
"name" : "...",
"value" : "...",
"position" : 12345
}, {
"name" : "...",
"value" : "...",
"position" : 12345
} ],
"startCityCode" : "...",
"endCityCode" : "...",
"startLatitude" : 12345.0,
"startLongitude" : 12345.0,
"endLatitude" : 12345.0,
"endLongitude" : 12345.0,
"flightTime" : "...",
"codeShareNumber" : "...",
"codeShareInformation" : "...",
"vehicleInfo" : "...",
"legMileage" : 12345,
"groundTime" : "...",
"percentageOnTime" : 12345,
"rateDetails" : [ {
"type" : "...",
"amount" : "...",
"limit" : "...",
"extra" : "...",
"effectiveDate" : "...",
"endDate" : "..."
}, {
"type" : "...",
"amount" : "...",
"limit" : "...",
"extra" : "...",
"effectiveDate" : "...",
"endDate" : "..."
} ],
"trainNumber" : "...",
"startTimeUTC" : "...",
"endTimeUTC" : "...",
"startTimeZone" : "...",
"endTimeZone" : "...",
"voucher" : "...",
"officialStatus" : true
} ],
"invoices" : [ {
"number" : "...",
"tickets" : [ {
"ticketNumber" : "...",
"issueDate" : 12345,
"type" : "...",
"passengerName" : "...",
"baseAmount" : "...",
"totalAmount" : "...",
"totalTax" : "...",
"payment" : "...",
"vendor" : "...",
"invoiceNumber" : "..."
}, {
"ticketNumber" : "...",
"issueDate" : 12345,
"type" : "...",
"passengerName" : "...",
"baseAmount" : "...",
"totalAmount" : "...",
"totalTax" : "...",
"payment" : "...",
"vendor" : "...",
"invoiceNumber" : "..."
} ],
"totalCharged" : "...",
"totalTax" : "...",
"taxes" : [ {
"code" : "...",
"value" : "..."
}, {
"code" : "...",
"value" : "..."
} ],
"totalAirfare" : "...",
"totalServicefee" : "...",
"totalCredit" : "...",
"name" : "...",
"totalRefunded" : "...",
"totalMisc" : "..."
}, {
"number" : "...",
"tickets" : [ {
"ticketNumber" : "...",
"issueDate" : 12345,
"type" : "...",
"passengerName" : "...",
"baseAmount" : "...",
"totalAmount" : "...",
"totalTax" : "...",
"payment" : "...",
"vendor" : "...",
"invoiceNumber" : "..."
}, {
"ticketNumber" : "...",
"issueDate" : 12345,
"type" : "...",
"passengerName" : "...",
"baseAmount" : "...",
"totalAmount" : "...",
"totalTax" : "...",
"payment" : "...",
"vendor" : "...",
"invoiceNumber" : "..."
} ],
"totalCharged" : "...",
"totalTax" : "...",
"taxes" : [ {
"code" : "...",
"value" : "..."
}, {
"code" : "...",
"value" : "..."
} ],
"totalAirfare" : "...",
"totalServicefee" : "...",
"totalCredit" : "...",
"name" : "...",
"totalRefunded" : "...",
"totalMisc" : "..."
} ],
"notes" : [ {
"number" : 12345,
"text" : "..."
}, {
"number" : 12345,
"text" : "..."
} ],
"recordLocator" : "...",
"id" : 12345,
"citySummary" : "...",
"bookingAgent" : "...",
"bookingAgentEmail" : "...",
"afterHoursNumber" : "...",
"endDate" : "...",
"startDate" : "...",
"client" : "...",
"pcc" : "...",
"topNotes" : [ {
"number" : 12345,
"text" : "..."
}, {
"number" : 12345,
"text" : "..."
} ],
"customLinks" : [ {
"text" : "...",
"url" : "..."
}, {
"text" : "...",
"url" : "..."
} ],
"agencyLogoLink" : "...",
"clientLogoLink" : "...",
"clientLogo" : "...",
"promotionalLinks" : [ {
"text" : "...",
"url" : "..."
}, {
"text" : "...",
"url" : "..."
} ],
"showPdf" : true,
"showCalendar" : true,
"agencyLogo" : "...",
"clientId" : 12345,
"totalCharged" : "...",
"hidden" : true,
"tmcName" : "...",
"tmcAddress" : "...",
"tmcCityStateZip" : "...",
"estimatedTotalAmount" : "...",
"estimatedTaxes" : "...",
"estimatedBaseAmount" : "...",
"contactNumber" : "...",
"bannerAdImageUrl" : "...",
"bannerAdLink" : "...",
"showTravelPolicy" : true,
"tollFreeNumber" : "...",
"onlineSupportNumber" : "...",
"invoiceFirst" : true,
"quotes" : [ {
"baseAmount" : "...",
"taxAmount" : "...",
"totalAmount" : "...",
"segments" : "..."
}, {
"baseAmount" : "...",
"taxAmount" : "...",
"totalAmount" : "...",
"segments" : "..."
} ],
"showText" : true,
"importDate" : 12345,
"startDateUTC" : "...",
"endDateUTC" : "...",
"startTimeZone" : "...",
"endTimeZone" : "...",
"approval" : {
"approvalUrl" : "...",
"rejectionUrl" : "...",
"modificationUrl" : "...",
"messages" : [ {
"name" : "...",
"value" : "...",
"position" : 12345
}, {
"name" : "...",
"value" : "...",
"position" : 12345
} ],
"showButtons" : true,
"history" : [ {
"name" : "...",
"value" : "...",
"position" : 12345
}, {
"name" : "...",
"value" : "...",
"position" : 12345
} ],
"header" : "...",
"title" : "...",
"actionRequired" : true,
"subjectPrefix" : "...",
"approved" : true,
"approvalUdids" : [ {
"id" : "...",
"name" : "..."
}, {
"id" : "...",
"name" : "..."
} ],
"udidUrl" : "...",
"agentName" : "...",
"showTimeLine" : true,
"reminder" : true
},
"hotelAttachment" : {
"itineraryToken" : "...",
"bookHotelUrl" : "...",
"noHotelNeededUrl" : "...",
"remindMeUrl" : "...",
"addHotelSegmentUrl" : "...",
"online" : true,
"overnightSegments" : [ 12345, 12345 ],
"agentAssistance" : true,
"obe" : "...",
"requested" : true,
"obeName" : "...",
"confirmation" : true
},
"destinationCity" : "...",
"covidCountries" : "...",
"covidStates" : "...",
"departureCity" : "...",
"udids" : [ {
"name" : "...",
"value" : "...",
"position" : 12345
}, {
"name" : "...",
"value" : "...",
"position" : 12345
} ],
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
}