itinerary Data Type

An object that describes a trip as a summary.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs constraints description
agentName string element 0/1 max size: 255, min size: 0 The name of the booking agent.
arrivalCity city element 0/1   The destination city.
arrivalDate dateTime element 0/1   The date of arrival to destination city
authorizationCode string element 0/1 max size: 64, min size: 0 The authorization code for this itinerary. Configurable by the client via udid.
billable string element 0/1 max size: 64, min size: 0 The billable ID for this itinerary. Configurable by the client via udid.
citySummary string element 0/1   A quick summary of the cities visited in this trip.
client client element 1/1 required The client that paid for this trip.
clientCode string element 0/1 max size: 64, min size: 0 The client code for this itinerary. Configurable by the client via udid.
completionDate dateTime element 0/1   The date that this trip ends.
costCenterCode string element 0/1 max size: 64, min size: 0 The cost center code for this itinerary. configurable by the client via udid.
departmentCode string element 0/1 max size: 64, min size: 0 The department code for this itinerary. configurable by the client via udid.
departureCity city element 0/1   The city the passenger(s) are leaving.
departureDate dateTime element 0/1   The date that this trip starts.
endDate dateTime element 0/1   When the trip will end in UTC.
explanation string element 0/1   A short note as to what the purpose of the trip is.
gds globalDistributionSystem element 1/1 required The GDS that this trip was booked in.
hide boolean element 1/1   Whether or not this trip is hidden from view.
importDate dateTime element 0/1   The date that this trip was imported into Airportal.
managerCode string element 0/1 max size: 64, min size: 0 The manager id for this itinerary. Configurable by the client via udid.
office officeInfo element 1/1 required The travel agency that the trip was booked under.
projectCode string element 0/1 max size: 64, min size: 0 The project id for this itinerary. Configurable by the client via udid.
purpose string element 0/1   A short note as to what the purpose of the trip is.
recordLocator string element 1/1 required, max size: 6, min size: 0 The agency locator for the trip.
regionCode string element 0/1 max size: 64, min size: 0 The region code for this itinerary. Configurable by the client via udid.
startDate dateTime element 0/1   When the trip will begin in UTC.
travelerCode string element 0/1 max size: 64, min size: 0 The traveler id for this itinerary. Configurable by the client via udid.
utcArrivalDate dateTime element 0/1   The date of arrival to destination city in UTC
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

<itinerary>
  <recordLocator>...</recordLocator>
  <agentName>...</agentName>
  <client>
    <status>
      <name>...</name>
      <active>...</active>
    </status>
    <parentClient/>
    <accountNumber>...</accountNumber>
    <name>...</name>
    <type>
      <name>...</name>
      <hide>...</hide>
      <level>...</level>
    </type>
    <id>...</id>
    <version>...</version>
  </client>
  <office>
    <pcc>...</pcc>
    <name>...</name>
    <address1>...</address1>
    <address2>...</address2>
    <address3>...</address3>
    <city>...</city>
    <state>...</state>
    <zip>...</zip>
    <parentCompany>
      <name>...</name>
    </parentCompany>
    <active>...</active>
    <branch>...</branch>
    <clientPrefix>...</clientPrefix>
    <profileSettings>
      <profileNameFormat>...</profileNameFormat>
    </profileSettings>
    <afterHoursNumber>...</afterHoursNumber>
    <collectVoidLogs>...</collectVoidLogs>
    <gds>
      <code>...</code>
      <name>...</name>
      <enabled>...</enabled>
    </gds>
    <arcNumber>...</arcNumber>
    <logo>...</logo>
    <logoLink>...</logoLink>
    <afterHoursInternationalNumber>...</afterHoursInternationalNumber>
    <tollFreeNumber>...</tollFreeNumber>
    <phoneNumber>...</phoneNumber>
    <onlineOffice>
      <name>...</name>
      <hours>...</hours>
      <phone>...</phone>
      <tollFree>...</tollFree>
      <email>...</email>
    </onlineOffice>
    <showTmcAppLinks>...</showTmcAppLinks>
    <vipTollFree>...</vipTollFree>
    <vipAfterHours>...</vipAfterHours>
    <cityCode>
      <code>...</code>
      <countryCode>...</countryCode>
      <latitude>...</latitude>
      <longitude>...</longitude>
      <name>...</name>
      <stateOrCountry>...</stateOrCountry>
      <airportName>...</airportName>
      <region/>
      <timeZone/>
      <retentionOnly>...</retentionOnly>
      <position>...</position>
      <unique>...</unique>
      <alias>...</alias>
    </cityCode>
    <tmcHeadQuarters>...</tmcHeadQuarters>
    <id>...</id>
    <version>...</version>
  </office>
  <departureDate>...</departureDate>
  <completionDate>...</completionDate>
  <importDate>...</importDate>
  <gds>
    <code>...</code>
    <name>...</name>
    <enabled>...</enabled>
    <id>...</id>
    <version>...</version>
  </gds>
  <hide>...</hide>
  <citySummary>...</citySummary>
  <departureCity>
    <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>
  </departureCity>
  <arrivalCity>
    <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>
  </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>
  <violations/>
</itinerary>