clientUdid Data Type

UDID stands for User Defined Field. A UDID is a text-only field in a trip that someone (a user) wants to use for advanced reporting. There can be up to 98 UDIDs in each trip, identified by their number (1-99). This object describes what we expect to be contained in each UDID.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs constraints description
approver boolean element 1/1 required boolean Indicates if this UDID will contain an approver's email to be used by approval
client client element 1/1 required The client that requested this UDID.
code udidReportCode element 0/1    
complex boolean element 1/1 required boolean Whether this UDID is complex and relies on other UDIDs for information.
complexNotes string element 0/1   Notes related to Reporting Field Linkage
datatype int element 1/1 required int The type of data that will go into this field. 0=Any,1=Number,2=Alphanumeric
enabled boolean element 1/1 required boolean Whether this UDID is enabled. This is specifically used to disable a UDID if it is inherited by a parent client or an office/TMC.
example string element 0/1   A representation of what is typically placed in this UDID.
guest boolean element 1/1 required boolean Whether or not this UDID is only used for guest travelers.
guestInstructions string element 0/1   guest instructions relating to udid being required for ticketing
inApproval boolean element 1/1 required boolean Whether this UDID is displayed and editable on approval emails.
linkageType int element 1/1 required int int representing type describing the complex linkage
list boolean element 1/1 required boolean Only allow the values given in the udid rules.
maximum int element 0/1   The maximum number of characters for this field.
minimum int element 0/1   The minimum number of characters for this field.
name string element 0/1   String that represents the name of this udid
notes string element 0/1   Notes about this udid
number int element 1/1 required int The number of the UDID in the trip record.
office officeInfo element 0/1   The office that expects this UDID in the PNR.
policyRules list of clientTravelPolicyUdid element 0/unbounded    
priority int element 1/1 required int The order in which to display the UDID on Approvals, Airtineraries, etc. Ascending order.
profiled boolean element 1/1 required boolean Whether or not this UDID is expected to be placed into the profile of the traveler (and automatically on every trip for that traveler).
reportField int element 0/1   The reporting field name that helps the end user as they create the UDID
required boolean element 1/1 required boolean Whether or not this UDID is required for ticketing.
tmc client element 0/1   The TMC that expects this UDID in their PNRs.
traveler boolean element 1/1 required boolean Whether or not this UDID is only used for profiled travelers.
trip boolean element 1/1 required boolean Whether or not this UDID is expected to be placed on the trip by the agent when it is being booked/created.
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

<clientUdid>
  <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>
  <name>...</name>
  <number>...</number>
  <example>...</example>
  <notes>...</notes>
  <complexNotes>...</complexNotes>
  <linkageType>...</linkageType>
  <code>
    <name>...</name>
    <code>...</code>
    <id>...</id>
    <version>...</version>
  </code>
  <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>
  <tmc>
    <status>
      <name>...</name>
      <active>...</active>
    </status>
    <parentClient/>
    <accountNumber>...</accountNumber>
    <name>...</name>
    <type>
      <name>...</name>
      <hide>...</hide>
      <level>...</level>
    </type>
    <id>...</id>
    <version>...</version>
  </tmc>
  <policyRules>
    <value>...</value>
    <moveToClient>
      <status/>
      <parentClient/>
      <accountNumber>...</accountNumber>
      <name>...</name>
      <type/>
    </moveToClient>
    <description>...</description>
    <id>...</id>
    <version>...</version>
  </policyRules>
  <required>...</required>
  <guestInstructions>...</guestInstructions>
  <list>...</list>
  <maximum>...</maximum>
  <minimum>...</minimum>
  <reportField>...</reportField>
  <datatype>...</datatype>
  <complex>...</complex>
  <inApproval>...</inApproval>
  <priority>...</priority>
  <enabled>...</enabled>
  <guest>...</guest>
  <profiled>...</profiled>
  <traveler>...</traveler>
  <trip>...</trip>
  <approver>...</approver>
  <id>...</id>
  <version>...</version>
  <violations/>
</clientUdid>