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.

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

{
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "name" : "...",
  "number" : 12345,
  "example" : "...",
  "notes" : "...",
  "complexNotes" : "...",
  "linkageType" : 12345,
  "code" : {
    "name" : "...",
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "office" : {
    "pcc" : "...",
    "name" : "...",
    "address1" : "...",
    "address2" : "...",
    "address3" : "...",
    "city" : "...",
    "state" : "...",
    "zip" : "...",
    "parentCompany" : {
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "active" : "...",
    "branch" : "...",
    "clientPrefix" : "...",
    "profileSettings" : {
      "profileNameFormat" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "afterHoursNumber" : "...",
    "collectVoidLogs" : true,
    "gds" : {
      "code" : "...",
      "name" : "...",
      "enabled" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "arcNumber" : "...",
    "logo" : "...",
    "logoLink" : "...",
    "afterHoursInternationalNumber" : "...",
    "tollFreeNumber" : "...",
    "phoneNumber" : "...",
    "onlineOffice" : {
      "name" : "...",
      "hours" : "...",
      "phone" : "...",
      "tollFree" : "...",
      "email" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showTmcAppLinks" : true,
    "vipTollFree" : "...",
    "vipAfterHours" : "...",
    "cityCode" : {
      "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" : [ { }, { } ]
    },
    "tmcHeadQuarters" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "tmc" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "policyRules" : [ {
    "value" : "...",
    "moveToClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "description" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "value" : "...",
    "moveToClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "description" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "required" : true,
  "guestInstructions" : "...",
  "list" : true,
  "maximum" : 12345,
  "minimum" : 12345,
  "reportField" : 12345,
  "datatype" : 12345,
  "complex" : true,
  "inApproval" : true,
  "priority" : 12345,
  "enabled" : true,
  "guest" : true,
  "profiled" : true,
  "traveler" : true,
  "trip" : true,
  "approver" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}