agentNote Data Type

A class representing extra information that should be added to airtineraries, and the conditions on when they should be sent.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs constraints description
agent employeeInfo element 0/1    
attachment boolean element 1/1 required boolean Whether to send it as an attachment in emails
client client element 0/1    
email boolean element 1/1 required boolean Whether to send it as a separate email
hidden boolean element 1/1 required boolean Whether this note should NOT appear on the email.
internationalOnly boolean element 1/1 required boolean Whether to send it on domestic
notOnCountry country element 0/1   A visited country that we should NOT show the note for.
notOnRemark string element 0/1   A remark that flags when not to send this note.
obeOnly boolean element 1/1 required boolean Whether to send it on domestic
onAir boolean element 1/1 required boolean Flag to send the note if there is an air segment in the PNR.
onCar boolean element 1/1 required boolean Flag to send the note if a car reservation is present.
onCountry country element 0/1   A visited country that we should show the note for.
onDomestic boolean element 1/1 required boolean Whether to send it on domestic
onExchange boolean element 1/1 required boolean Flag on whether to send the note if an exchange is present.
onHotel boolean element 1/1 required boolean Flag to send if a hotel reservation is present.
onNoAdvSeat boolean element 1/1 required boolean Flag to send the note if there is a ticket with no advanced seat selection on the trip.
onNoChange boolean element 1/1 required boolean Flag to send the note if there is a no change ticket on the trip.
onNoChkBag boolean element 1/1 required boolean Flag to send the note if there is a ticket with no checked bag on the trip.
onNotRefundable boolean element 1/1 required boolean Flag to send the note if there is a non-refundable ticket on the trip.
onOfflineAgent boolean element 1/1 required boolean Whether to send it if it is a full service agent or not
onRail boolean element 1/1 required boolean Flag to send the note if there is a rail segment on the record.
onRemark string element 0/1   The remark to look for to send it on
subject string element 0/1   If a subject or filename is required, what to call it
ticketedOnly boolean element 1/1 required boolean Whether to show it on ticketed
toGds boolean element 1/1 required boolean Flag on whether to send the agent note to the GDS or not. This makes it so that the agent can see it. This will get persisted when the agent adds it to the GDS.
topNote boolean element 1/1 required boolean Whether to send it on domestic
travelAgency officeInfo element 0/1    
travelManagementCorp travelManagementCompany element 0/1   The TMC that wants this note added to every PNR of theirs.
traveler user element 0/1   The traveler that requires this agent note.
Properties inherited from airportalNote
text string 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

<agentNote>
  <attachment>...</attachment>
  <email>...</email>
  <onDomestic>...</onDomestic>
  <subject>...</subject>
  <ticketedOnly>...</ticketedOnly>
  <onRemark>...</onRemark>
  <onOfflineAgent>...</onOfflineAgent>
  <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>
  <travelAgency>
    <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>
  </travelAgency>
  <travelManagementCorp>
    <name>...</name>
    <id>...</id>
    <version>...</version>
  </travelManagementCorp>
  <agent>
    <user>
      <answer>...</answer>
      <emailed>...</emailed>
      <newUser>...</newUser>
      <temporaryPassword>...</temporaryPassword>
      <question>...</question>
      <obeUserName>...</obeUserName>
      <obePassword>...</obePassword>
      <obeSyncId>...</obeSyncId>
      <created>...</created>
      <modifiedDate>...</modifiedDate>
      <emailedWhen>...</emailedWhen>
      <travelgpaLogin>...</travelgpaLogin>
      <groups/>
      <active>...</active>
      <prefix>...</prefix>
      <firstName>...</firstName>
      <lastName>...</lastName>
      <middleName>...</middleName>
      <suffix>...</suffix>
      <email>...</email>
      <tripitAuthorized>...</tripitAuthorized>
      <supportTitle>...</supportTitle>
      <automatedNotifications>...</automatedNotifications>
      <enableHotelAttachment>...</enableHotelAttachment>
      <atHomeNotificationMethod/>
      <inTravelNotificationMethod/>
      <cellPhoneNumber>...</cellPhoneNumber>
      <userCurrentClient/>
      <defaultClient/>
      <defaultPlannerGroup/>
      <showWelcomeDialog>...</showWelcomeDialog>
      <siteTour>...</siteTour>
      <unusedTicketEmail>...</unusedTicketEmail>
      <surveyEmail>...</surveyEmail>
      <wt0EmailEnabled>...</wt0EmailEnabled>
      <wt0EmailDaily>...</wt0EmailDaily>
      <wt0EmailDay>...</wt0EmailDay>
      <wt0EmailHour>...</wt0EmailHour>
      <marketingSubscribed>...</marketingSubscribed>
      <responsive>...</responsive>
      <businessPhoneNumber>...</businessPhoneNumber>
      <homePhoneNumber>...</homePhoneNumber>
    </user>
    <agentCode>...</agentCode>
    <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>
    <workEmail>...</workEmail>
    <active>...</active>
    <type>...</type>
    <emailList>...</emailList>
    <category>...</category>
    <directLine>...</directLine>
    <hours>...</hours>
    <onlineAgent>...</onlineAgent>
    <recheckEmails>...</recheckEmails>
    <serviceFeesPct>...</serviceFeesPct>
    <otherServiceFeesPct>...</otherServiceFeesPct>
    <internationalAirCommissionPct>...</internationalAirCommissionPct>
    <miscCommissionPct>...</miscCommissionPct>
    <airCommissionPct>...</airCommissionPct>
    <hotelCommissionPct>...</hotelCommissionPct>
    <carCommissionPct>...</carCommissionPct>
    <employeeType>
      <code>...</code>
      <name>...</name>
    </employeeType>
    <ticketingAgent>...</ticketingAgent>
    <supportAgent>...</supportAgent>
    <onsiteAgent>...</onsiteAgent>
    <id>...</id>
    <version>...</version>
  </agent>
  <internationalOnly>...</internationalOnly>
  <topNote>...</topNote>
  <obeOnly>...</obeOnly>
  <onHotel>...</onHotel>
  <onCar>...</onCar>
  <toGds>...</toGds>
  <traveler>
    <answer>...</answer>
    <emailed>...</emailed>
    <newUser>...</newUser>
    <temporaryPassword>...</temporaryPassword>
    <question>...</question>
    <obeUserName>...</obeUserName>
    <obePassword>...</obePassword>
    <obeSyncId>...</obeSyncId>
    <created>...</created>
    <modifiedDate>...</modifiedDate>
    <emailedWhen>...</emailedWhen>
    <travelgpaLogin>...</travelgpaLogin>
    <groups>
      <name>...</name>
      <permissions/>
      <description>...</description>
      <role/>
      <type>...</type>
    </groups>
    <active>...</active>
    <prefix>...</prefix>
    <firstName>...</firstName>
    <lastName>...</lastName>
    <middleName>...</middleName>
    <suffix>...</suffix>
    <email>...</email>
    <tripitAuthorized>...</tripitAuthorized>
    <supportTitle>...</supportTitle>
    <automatedNotifications>...</automatedNotifications>
    <enableHotelAttachment>...</enableHotelAttachment>
    <atHomeNotificationMethod>
      <name>...</name>
      <code>...</code>
    </atHomeNotificationMethod>
    <inTravelNotificationMethod>
      <name>...</name>
      <code>...</code>
    </inTravelNotificationMethod>
    <cellPhoneNumber>...</cellPhoneNumber>
    <userCurrentClient/>
    <defaultClient>
      <status/>
      <parentClient/>
      <accountNumber>...</accountNumber>
      <name>...</name>
      <type/>
    </defaultClient>
    <defaultPlannerGroup>
      <status/>
      <parentClient/>
      <accountNumber>...</accountNumber>
      <name>...</name>
      <type/>
    </defaultPlannerGroup>
    <showWelcomeDialog>...</showWelcomeDialog>
    <siteTour>...</siteTour>
    <unusedTicketEmail>...</unusedTicketEmail>
    <surveyEmail>...</surveyEmail>
    <wt0EmailEnabled>...</wt0EmailEnabled>
    <wt0EmailDaily>...</wt0EmailDaily>
    <wt0EmailDay>...</wt0EmailDay>
    <wt0EmailHour>...</wt0EmailHour>
    <marketingSubscribed>...</marketingSubscribed>
    <responsive>...</responsive>
    <businessPhoneNumber>...</businessPhoneNumber>
    <homePhoneNumber>...</homePhoneNumber>
    <id>...</id>
    <version>...</version>
  </traveler>
  <onExchange>...</onExchange>
  <onCountry>
    <name>...</name>
    <code>...</code>
    <codeAlt>...</codeAlt>
    <phoneCode>...</phoneCode>
    <position>...</position>
    <id>...</id>
    <version>...</version>
  </onCountry>
  <hidden>...</hidden>
  <onAir>...</onAir>
  <notOnRemark>...</notOnRemark>
  <notOnCountry>
    <name>...</name>
    <code>...</code>
    <codeAlt>...</codeAlt>
    <phoneCode>...</phoneCode>
    <position>...</position>
    <id>...</id>
    <version>...</version>
  </notOnCountry>
  <onNotRefundable>...</onNotRefundable>
  <onNoChange>...</onNoChange>
  <onNoChkBag>...</onNoChkBag>
  <onNoAdvSeat>...</onNoAdvSeat>
  <onRail>...</onRail>
  <text>...</text>
  <id>...</id>
  <version>...</version>
</agentNote>