segmentLocation Data Type

Segment locations are for tracking the location of the passengers of an itinerary at a certain point in time. To query this, you will probably want to get the highest time that is less than the time you search by.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs constraints description
address string element 0/1   The human readable address of the location
airline airVendor element 0/1   The airline the user is using, if applicable.
city city element 0/1   The city that the location resides in.
confirmation string element 0/1   The confirmation number of the segment that this location is associated with.
firstOrLast boolean element 0/1   Flag to determine if this is the first or last location in the set of locations for the itinerary. 0 - first 1 - last null - neither
flight string element 0/1   The flight that the user is on, if applicable.
itinerary itinerary element 1/1 required The itinerary ID that this time/location belongs to.
latitude double element 0/1   The latitude that this location resides on the map.
longitude double element 0/1   The longitude that this location resides on the map.
name string element 0/1   The name of the location. Like Hilton Inn.
timestamp dateTime element 0/1   The time that the passengers arrive on the location.
type string element 0/1   A short description of the type of segment.
utcTimestamp dateTime element 0/1   The time in UTC of the segment occurrence.
utcTimestampEnd dateTime element 0/1    
Properties inherited from baseHibernateEntity
id long element 0/1   The unique internal ID of the object.
version long element 0/1   For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions.
Properties inherited from baseEntity
violations list of simpleViolation element 0/unbounded   A list of constraint violations, if any, that this object has.

Example

<segmentLocation>
  <itinerary>
    <recordLocator>...</recordLocator>
    <agentName>...</agentName>
    <client>
      <status/>
      <parentClient/>
      <accountNumber>...</accountNumber>
      <name>...</name>
      <type/>
    </client>
    <office>
      <pcc>...</pcc>
      <name>...</name>
      <address1>...</address1>
      <address2>...</address2>
      <address3>...</address3>
      <city>...</city>
      <state>...</state>
      <zip>...</zip>
      <parentCompany/>
      <active>...</active>
      <branch>...</branch>
      <clientPrefix>...</clientPrefix>
      <profileSettings/>
      <afterHoursNumber>...</afterHoursNumber>
      <collectVoidLogs>...</collectVoidLogs>
      <gds/>
      <arcNumber>...</arcNumber>
      <logo>...</logo>
      <logoLink>...</logoLink>
      <afterHoursInternationalNumber>...</afterHoursInternationalNumber>
      <tollFreeNumber>...</tollFreeNumber>
      <phoneNumber>...</phoneNumber>
      <onlineOffice/>
      <showTmcAppLinks>...</showTmcAppLinks>
      <vipTollFree>...</vipTollFree>
      <vipAfterHours>...</vipAfterHours>
      <cityCode/>
      <tmcHeadQuarters>...</tmcHeadQuarters>
    </office>
    <departureDate>...</departureDate>
    <completionDate>...</completionDate>
    <importDate>...</importDate>
    <gds>
      <code>...</code>
      <name>...</name>
      <enabled>...</enabled>
    </gds>
    <hide>...</hide>
    <citySummary>...</citySummary>
    <departureCity>
      <code>...</code>
      <countryCode>...</countryCode>
      <latitude>...</latitude>
      <longitude>...</longitude>
      <name>...</name>
      <stateOrCountry>...</stateOrCountry>
      <airportName>...</airportName>
      <region/>
      <timeZone/>
      <retentionOnly>...</retentionOnly>
      <position>...</position>
      <unique>...</unique>
      <alias>...</alias>
    </departureCity>
    <arrivalCity>
      <code>...</code>
      <countryCode>...</countryCode>
      <latitude>...</latitude>
      <longitude>...</longitude>
      <name>...</name>
      <stateOrCountry>...</stateOrCountry>
      <airportName>...</airportName>
      <region/>
      <timeZone/>
      <retentionOnly>...</retentionOnly>
      <position>...</position>
      <unique>...</unique>
      <alias>...</alias>
    </arrivalCity>
    <arrivalDate>...</arrivalDate>
    <utcArrivalDate>...</utcArrivalDate>
    <startDate>...</startDate>
    <endDate>...</endDate>
    <purpose>...</purpose>
    <explanation>...</explanation>
    <authorizationCode>...</authorizationCode>
    <costCenterCode>...</costCenterCode>
    <departmentCode>...</departmentCode>
    <clientCode>...</clientCode>
    <regionCode>...</regionCode>
    <billable>...</billable>
    <travelerCode>...</travelerCode>
    <managerCode>...</managerCode>
    <projectCode>...</projectCode>
    <id>...</id>
    <version>...</version>
  </itinerary>
  <timestamp>...</timestamp>
  <address>...</address>
  <longitude>...</longitude>
  <latitude>...</latitude>
  <city>
    <code>...</code>
    <countryCode>...</countryCode>
    <latitude>...</latitude>
    <longitude>...</longitude>
    <name>...</name>
    <stateOrCountry>...</stateOrCountry>
    <airportName>...</airportName>
    <region>
      <name>...</name>
      <code>...</code>
      <country/>
      <position>...</position>
    </region>
    <timeZone>
      <name>...</name>
      <offset>...</offset>
      <daylightSavingsOffset>...</daylightSavingsOffset>
    </timeZone>
    <retentionOnly>...</retentionOnly>
    <position>...</position>
    <unique>...</unique>
    <alias>...</alias>
    <id>...</id>
    <version>...</version>
  </city>
  <type>...</type>
  <name>...</name>
  <flight>...</flight>
  <airline>
    <airlineNumber>...</airlineNumber>
    <checkinLink>...</checkinLink>
    <baggageLink>...</baggageLink>
    <alliance>
      <sharesFrequentFlyerNumbers>...</sharesFrequentFlyerNumbers>
      <name>...</name>
      <code>...</code>
    </alliance>
    <lowCostCarrier>...</lowCostCarrier>
    <longCode>...</longCode>
    <manualTicketingOnly>...</manualTicketingOnly>
    <airTicketsUseOrigIssueDate>...</airTicketsUseOrigIssueDate>
    <mcoTicketsUseOrigIssueDate>...</mcoTicketsUseOrigIssueDate>
    <minDomesticValue>...</minDomesticValue>
    <minIntlValue>...</minIntlValue>
    <position>...</position>
    <imageUrl>...</imageUrl>
    <code>...</code>
    <name>...</name>
  </airline>
  <utcTimestamp>...</utcTimestamp>
  <utcTimestampEnd>...</utcTimestampEnd>
  <firstOrLast>...</firstOrLast>
  <confirmation>...</confirmation>
  <id>...</id>
  <version>...</version>
  <violations/>
</segmentLocation>