| name | data type | constraints | description |
|---|---|---|---|
| checkOutPenalty | string | ||
| number | number | The number to order this segment by. | |
| notes | array of DisplayNotes | Custom notes for this segment. | |
| type | string | The type of segment. | |
| startLocationName | string | The name of the starting location. | |
| endLocationName | string | The name of the ending location | |
| vendorName | string | The name of the vendor supplying the segment | |
| startTime | string | The time that the segment will begin. | |
| endTime | string | The time that the segment will end. | |
| startLocationHours | string | The daily hours of the start location of this segment. | |
| endLocationHours | string | The daily hours of the end location of this segment. | |
| startLocationAddress1 | string | The start location address of this segment. | |
| startLocationAddress2 | string | The second line of the start location address of this segment. | |
| startLocationPhoneNumber | string | The phone number for the start location. | |
| startLocationCity | string | The city that the start location resides in. | |
| guaranteeRequirements | string | The requirements to meet to qualify for a guarantee for the reservation. | |
| startLocationZip | string | The zip code for the start location. | |
| dropOffCharges | string | Any additional charges that will occur when the equipment is dropped off. | |
| numberOfStops | number | Get the number of stops that will happen during the segment. | |
| cancellationNumber | string | The cancellation number for this reservation. | |
| cancellationPolicy | string | The cancellation policy for this reservation. | |
| numberOfChildren | number | The number of children included in the reservation. | |
| startLocationCountryCode | string | The country code the reservation starts in. | |
| startLocationStateOrRegionCode | string | The state or region code the reservation starts in. | |
| endLocationCountryCode | string | The country code the reservation ends in. | |
| endLocationStateOrRegionCode | string | The state or region code the reservation ends in. | |
| startLocationStateCountry | string | The country the reservation starts in. | |
| endLocationAddress1 | string | The end location address for this segment. | |
| startTerminal | string | The departure (or starting) terminal for this segment. | |
| endTerminal | string | The arrival (or ending) terminal for this segment. | |
| endLocationAddress2 | string | The second line of the ending address of this segment. | |
| endLocationPhoneNumber | string | The phone number to contact the ending location for this segment. | |
| endLocationCity | string | The city that this segment ends in. | |
| endLocationZip | string | The zip code that this segment ends in. | |
| endLocationStateCountry | string | The country that this segment ends in. | |
| status | string | The status of this reservation. | |
| confirmationNumber | string | The confirmation number for this reservation. | |
| renterName | string | The name of the renter for this reservation. | |
| frequentTravelerNumber | string | The frequent traveler / guest number for this reservation. | |
| corpDiscountNumber | string | The corporate discount number used for this reservation. | |
| customerId | string | The customer or membership ID used for this reservation. | |
| carTransmission | string | The type of transmission the rented equipment has. | |
| carType | string | The type of car the rented equipment has. | |
| carAirConditioning | boolean | The type of air conditioning the rented equipment has. | |
| carClass | string | The class of vehicle the rented equipment is. | |
| deliveryNotes | string | Any delivery notes about the delivery of the rented equipment. | |
| totalTime | string | The total amount of time that will pass during this segment. | |
| totalMiles | number | The total amount of miles that will be traveled during this segment. | |
| baggageLink | string | A link to any baggage information from an airline. The DoT requires this to be displayed on all electronic confirmations. | |
| checkinLink | string | A link to the airline's early checkin webpage. | |
| startLocationFaxNumber | string | The fax number for the starting location. | |
| endLocationFaxNumber | string | The fax number for the ending location. | |
| vendorNotes | string | Notes from the vendor about the reservation. | |
| rateInfo | string | A plain english representation of the total approximate rate. | |
| grandTotal | string | A number representation of the expected total amount of the reservation. | |
| roomDescription | string | A plain english description of the room reserved. | |
| stopOvers | array of DisplayStopOver | A list of cities that a segment will be stopping at during the voyage. | |
| flightNumber | string | The flight number for the segment. | |
| classOfService | string | The class of service that the traveler will receive during the segment. | |
| seats | array of DisplaySeat | A list of seats reserved during the segment. | |
| carNumber | string | The car number the seats are located in. | |
| roomNumber | string | The room number that the beds / seats are located in. | |
| accomodationCode | string | The accomodation code that the traveler reserved. This is similar to a class of service. | |
| numberOfRooms | number | The number of rooms reserved. | |
| numberOfGuests | number | The number of guests expected to reside in the reserved equipment. | |
| additionalRoomTax | string | Additional tax that is applied to a hotel room stay. | |
| hplRequeueUrl | string | A shortcut URL to activate HotelPrePayLogic services. | |
| travelOptions | array of DisplayOption | An array of name value pairs that convey other information about the segment. | |
| startCityCode | string | The IATA city code of the starting location. | |
| endCityCode | string | The IATA city code of the ending location. | |
| startLatitude | number | The latitude of the starting location. | |
| startLongitude | number | The longitude of the starting location. | |
| endLatitude | number | The latitude of the ending location. | |
| endLongitude | number | The longitude of the ending location. | |
| flightTime | string | The expected time that will pass according to the perspective of the traveler. | |
| string | The confirmation code for the operating airline when a codeshare is applied. | ||
| string | The name of the operating airline when a codeshare is applied. This is required by the DoT to be on all electronic confirmation documents. | ||
| vehicleInfo | string | Information about the vehicle used for the segment. | |
| legMileage | number | The mileage that is counted for this leg/segment of the trip. | |
| groundTime | string | The amount of time that will pass per the perspective of an observer on the ground. | |
| percentageOnTime | number | The percentage that this flight is considered on time for arrival. | |
| rateDetails | array of DisplayRate | A breakdown of the rates, organized by cost types. | |
| trainNumber | string | The number of the train the seat is reserved on. | |
| startTimeUTC | string | The start time of the segment, in UTC. | |
| endTimeUTC | string | The end time of the segment, in UTC. | |
| startTimeZone | string | The time zone that the start location is in. | |
| endTimeZone | string | The time zone that the segment ends in. | |
| voucher | string | A voucher number used to reduce the price. | |
| officialStatus | boolean | required boolean | Whether or not this status is officially recognized by the travel vendor. |
Example
{
"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
}