AirSegment Data Type

An element that represents a segment of air travel in an itinerary.

Properties
name data type constraints description
classOfService ClassOfService   The class of service code for this segment.
arrivalAirport City   Arrival Airport Code.
arrivalDate number required Arrival date for the air segment
arrivalTerminal string max size: 50, min size: 0 Arrival terminal for the segment.
departureAirport City   Departure Airport Code.
departureDate number required Departure date for the air segment
departureTerminal string max size: 50, min size: 0 Departure terminal for the segment.
flightTime number   The accumulated flight time of the flight
flightMiles number   Miles that the flight covers.
flightNumber string max size: 5, min size: 0 The flight number.
flightStopNumber number   Number of stops the flight makes.
airVendor AirVendor   The airline that provides the flight.
responseLocator string max size: 11, min size: 0 Response locator string.
vendorName string  
seats array of Seat   The seats bought for this flight.
reservation Reservation   The reservation / ticket this segment was bought with.
stopOvers array of StopOver   The stop overs that this flight will have.
inGds boolean   Whether or not the segment is stored in the GDS.
legMileage number   The mileage for this flight.
percentageOnTime number   The percentage that this trip is on time.
codeShareInformation string max size: 100, min size: 0 Code share information.
codeShareFlightNumber string max size: 20, min size: 0 The code share flight number.
groundTime number   The time elapsed on the ground. Timezones are taken into account.
meal Meal   The meal plan that the traveler will enjoy on the flight.
elapsedFlightTime number   The time that elapsed during the flight.
aircraft AircraftType   The aircraft that is used on the flight.
Properties inherited from AirportalSegment
number number   The ordering number of the segment.
status SegmentStatus   The status of the segment, like if it is confirmed or on wait list.
startDate string   The start date of the segment.
endDate string   The end date of the segment
UTCStartDate number   The start date of the segment in UTC.
UTCEndDate number   The end date of the segment in UTC.
startTimeZoneName string  
endTimeZoneName string  
startCity City   Get the starting city of the segment.
endCity City   The ending city of the segment.
domestic boolean   Whether this segment is domestic or not.
postTravel boolean   Whether this segment is in the past or not.
inGds boolean   Whether or not the segment is stored in the GDS.
itinerary Itinerary   Get the itinerary that this segment is connected to.
Properties inherited from BaseHibernateEntity
id number   The unique internal ID of the object.
version number   For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions.
Properties inherited from BaseEntity
violations array of SimpleViolation   A list of constraint violations, if any, that this object has.

Example

{
  "classOfService" : {
    "vendor" : {
      "airlineNumber" : 12345,
      "checkinLink" : "...",
      "baggageLink" : "...",
      "alliance" : { },
      "lowCostCarrier" : true,
      "longCode" : "...",
      "manualTicketingOnly" : true,
      "airTicketsUseOrigIssueDate" : true,
      "mcoTicketsUseOrigIssueDate" : true,
      "minDomesticValue" : 12345,
      "minIntlValue" : 12345,
      "position" : 12345,
      "code" : "...",
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "code" : "...",
    "description" : "...",
    "serviceLevel" : {
      "name" : "...",
      "code" : "...",
      "value" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "basic" : true,
    "transAtlantic" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "arrivalAirport" : {
    "code" : "...",
    "countryCode" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "name" : "...",
    "stateOrCountry" : "...",
    "airportName" : "...",
    "region" : {
      "name" : "...",
      "code" : "...",
      "country" : { },
      "position" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "timeZone" : {
      "name" : "...",
      "offset" : 12345.0,
      "daylightSavingsOffset" : 12345.0,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "retentionOnly" : true,
    "position" : 12345,
    "unique" : true,
    "alias" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "arrivalDate" : 12345,
  "arrivalTerminal" : "...",
  "departureAirport" : {
    "code" : "...",
    "countryCode" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "name" : "...",
    "stateOrCountry" : "...",
    "airportName" : "...",
    "region" : {
      "name" : "...",
      "code" : "...",
      "country" : { },
      "position" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "timeZone" : {
      "name" : "...",
      "offset" : 12345.0,
      "daylightSavingsOffset" : 12345.0,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "retentionOnly" : true,
    "position" : 12345,
    "unique" : true,
    "alias" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "departureDate" : 12345,
  "departureTerminal" : "...",
  "flightTime" : 12345,
  "flightMiles" : 12345,
  "flightNumber" : "...",
  "flightStopNumber" : 12345,
  "airVendor" : {
    "airlineNumber" : 12345,
    "checkinLink" : "...",
    "baggageLink" : "...",
    "alliance" : {
      "sharesFrequentFlyerNumbers" : true,
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "lowCostCarrier" : true,
    "longCode" : "...",
    "manualTicketingOnly" : true,
    "airTicketsUseOrigIssueDate" : true,
    "mcoTicketsUseOrigIssueDate" : true,
    "minDomesticValue" : 12345,
    "minIntlValue" : 12345,
    "position" : 12345,
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "responseLocator" : "...",
  "vendorName" : "...",
  "seats" : [ {
    "seatNumber" : "...",
    "passenger" : {
      "age" : "...",
      "customNameData" : "...",
      "prefix" : "...",
      "firstName" : "...",
      "middleName" : "...",
      "lastName" : "...",
      "suffix" : "...",
      "worldspanName" : "...",
      "itinerary" : { },
      "user" : { },
      "email" : "...",
      "position" : 12345,
      "passportLastDigits" : "...",
      "knownTravelerNumberLastDigits" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "status" : {
      "code" : "...",
      "description" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "seatNumber" : "...",
    "passenger" : {
      "age" : "...",
      "customNameData" : "...",
      "prefix" : "...",
      "firstName" : "...",
      "middleName" : "...",
      "lastName" : "...",
      "suffix" : "...",
      "worldspanName" : "...",
      "itinerary" : { },
      "user" : { },
      "email" : "...",
      "position" : 12345,
      "passportLastDigits" : "...",
      "knownTravelerNumberLastDigits" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "status" : {
      "code" : "...",
      "description" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "reservation" : {
    "ticketNumber" : "...",
    "issueDate" : 12345,
    "electronic" : true,
    "type" : {
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "status" : {
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "payments" : [ {
      "amount" : 12345.0,
      "currency" : "...",
      "paymentCode" : "...",
      "creditCardType" : "...",
      "notes" : "...",
      "lastDigits" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "amount" : 12345.0,
      "currency" : "...",
      "paymentCode" : "...",
      "creditCardType" : "...",
      "notes" : "...",
      "lastDigits" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "hidden" : true,
    "passengerName" : "...",
    "totalAmount" : 12345.0,
    "baseAmount" : 12345.0,
    "taxes" : [ {
      "amount" : 12345.0,
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "amount" : 12345.0,
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "vendor" : "...",
    "addCollect" : 12345.0,
    "commissionAmount" : 12345.0,
    "refundable" : true,
    "exchangedTicketNumber" : "...",
    "fareCalculation" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "stopOvers" : [ {
    "arrivalDate" : 12345,
    "departureDate" : 12345,
    "segment" : {
      "classOfService" : { },
      "arrivalAirport" : { },
      "arrivalDate" : 12345,
      "arrivalTerminal" : "...",
      "departureAirport" : { },
      "departureDate" : 12345,
      "departureTerminal" : "...",
      "flightTime" : 12345,
      "flightMiles" : 12345,
      "flightNumber" : "...",
      "flightStopNumber" : 12345,
      "airVendor" : { },
      "responseLocator" : "...",
      "vendorName" : "...",
      "seats" : [ { }, { } ],
      "reservation" : { },
      "stopOvers" : [ { }, { } ],
      "inGds" : true,
      "legMileage" : 12345,
      "percentageOnTime" : 12345,
      "codeShareInformation" : "...",
      "codeShareFlightNumber" : "...",
      "groundTime" : 12345,
      "meal" : { },
      "elapsedFlightTime" : 12345,
      "aircraft" : { },
      "number" : 12345,
      "status" : { },
      "startDate" : "...",
      "endDate" : "...",
      "UTCStartDate" : 12345,
      "UTCEndDate" : 12345,
      "startTimeZoneName" : "...",
      "endTimeZoneName" : "...",
      "startCity" : { },
      "endCity" : { },
      "domestic" : true,
      "postTravel" : true,
      "itinerary" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "city" : {
      "code" : "...",
      "countryCode" : "...",
      "latitude" : 12345.0,
      "longitude" : 12345.0,
      "name" : "...",
      "stateOrCountry" : "...",
      "airportName" : "...",
      "region" : { },
      "timeZone" : { },
      "retentionOnly" : true,
      "position" : 12345,
      "unique" : true,
      "alias" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "arrivalDate" : 12345,
    "departureDate" : 12345,
    "segment" : {
      "classOfService" : { },
      "arrivalAirport" : { },
      "arrivalDate" : 12345,
      "arrivalTerminal" : "...",
      "departureAirport" : { },
      "departureDate" : 12345,
      "departureTerminal" : "...",
      "flightTime" : 12345,
      "flightMiles" : 12345,
      "flightNumber" : "...",
      "flightStopNumber" : 12345,
      "airVendor" : { },
      "responseLocator" : "...",
      "vendorName" : "...",
      "seats" : [ { }, { } ],
      "reservation" : { },
      "stopOvers" : [ { }, { } ],
      "inGds" : true,
      "legMileage" : 12345,
      "percentageOnTime" : 12345,
      "codeShareInformation" : "...",
      "codeShareFlightNumber" : "...",
      "groundTime" : 12345,
      "meal" : { },
      "elapsedFlightTime" : 12345,
      "aircraft" : { },
      "number" : 12345,
      "status" : { },
      "startDate" : "...",
      "endDate" : "...",
      "UTCStartDate" : 12345,
      "UTCEndDate" : 12345,
      "startTimeZoneName" : "...",
      "endTimeZoneName" : "...",
      "startCity" : { },
      "endCity" : { },
      "domestic" : true,
      "postTravel" : true,
      "itinerary" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "city" : {
      "code" : "...",
      "countryCode" : "...",
      "latitude" : 12345.0,
      "longitude" : 12345.0,
      "name" : "...",
      "stateOrCountry" : "...",
      "airportName" : "...",
      "region" : { },
      "timeZone" : { },
      "retentionOnly" : true,
      "position" : 12345,
      "unique" : true,
      "alias" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "inGds" : true,
  "legMileage" : 12345,
  "percentageOnTime" : 12345,
  "codeShareInformation" : "...",
  "codeShareFlightNumber" : "...",
  "groundTime" : 12345,
  "meal" : {
    "mealCode" : "...",
    "description" : "...",
    "position" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "elapsedFlightTime" : 12345,
  "aircraft" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "number" : 12345,
  "status" : {
    "code" : "...",
    "description" : "...",
    "accepted" : true,
    "confirmed" : true,
    "virtual" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "startDate" : "...",
  "endDate" : "...",
  "UTCStartDate" : 12345,
  "UTCEndDate" : 12345,
  "startTimeZoneName" : "...",
  "endTimeZoneName" : "...",
  "startCity" : {
    "code" : "...",
    "countryCode" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "name" : "...",
    "stateOrCountry" : "...",
    "airportName" : "...",
    "region" : {
      "name" : "...",
      "code" : "...",
      "country" : { },
      "position" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "timeZone" : {
      "name" : "...",
      "offset" : 12345.0,
      "daylightSavingsOffset" : 12345.0,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "retentionOnly" : true,
    "position" : 12345,
    "unique" : true,
    "alias" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "endCity" : {
    "code" : "...",
    "countryCode" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "name" : "...",
    "stateOrCountry" : "...",
    "airportName" : "...",
    "region" : {
      "name" : "...",
      "code" : "...",
      "country" : { },
      "position" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "timeZone" : {
      "name" : "...",
      "offset" : 12345.0,
      "daylightSavingsOffset" : 12345.0,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "retentionOnly" : true,
    "position" : 12345,
    "unique" : true,
    "alias" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "domestic" : true,
  "postTravel" : true,
  "itinerary" : {
    "recordLocator" : "...",
    "agentName" : "...",
    "client" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "office" : {
      "pcc" : "...",
      "name" : "...",
      "address1" : "...",
      "address2" : "...",
      "address3" : "...",
      "city" : "...",
      "state" : "...",
      "zip" : "...",
      "parentCompany" : { },
      "active" : "...",
      "branch" : "...",
      "clientPrefix" : "...",
      "profileSettings" : { },
      "afterHoursNumber" : "...",
      "collectVoidLogs" : true,
      "gds" : { },
      "arcNumber" : "...",
      "logo" : "...",
      "logoLink" : "...",
      "afterHoursInternationalNumber" : "...",
      "tollFreeNumber" : "...",
      "phoneNumber" : "...",
      "onlineOffice" : { },
      "showTmcAppLinks" : true,
      "vipTollFree" : "...",
      "vipAfterHours" : "...",
      "cityCode" : { },
      "tmcHeadQuarters" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "departureDate" : 12345,
    "completionDate" : 12345,
    "importDate" : 12345,
    "gds" : {
      "code" : "...",
      "oldCode" : "...",
      "name" : "...",
      "agressoCode" : "...",
      "enabled" : true,
      "profileSyncEnabled" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "hide" : true,
    "citySummary" : "...",
    "departureCity" : {
      "code" : "...",
      "countryCode" : "...",
      "latitude" : 12345.0,
      "longitude" : 12345.0,
      "name" : "...",
      "stateOrCountry" : "...",
      "airportName" : "...",
      "region" : { },
      "timeZone" : { },
      "retentionOnly" : true,
      "position" : 12345,
      "unique" : true,
      "alias" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "arrivalCity" : {
      "code" : "...",
      "countryCode" : "...",
      "latitude" : 12345.0,
      "longitude" : 12345.0,
      "name" : "...",
      "stateOrCountry" : "...",
      "airportName" : "...",
      "region" : { },
      "timeZone" : { },
      "retentionOnly" : true,
      "position" : 12345,
      "unique" : true,
      "alias" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "arrivalDate" : 12345,
    "utcArrivalDate" : 12345,
    "startDate" : 12345,
    "endDate" : 12345,
    "purpose" : "...",
    "explanation" : "...",
    "authorizationCode" : "...",
    "costCenterCode" : "...",
    "departmentCode" : "...",
    "clientCode" : "...",
    "regionCode" : "...",
    "billable" : "...",
    "travelerCode" : "...",
    "managerCode" : "...",
    "projectCode" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}