A class representing extra information that should be added to airtineraries, and the conditions on when they should be sent.
| name | data type | constraints | description |
|---|---|---|---|
| attachment | boolean | required boolean | Whether to send it as an attachment in emails |
| boolean | required boolean | Whether to send it as a separate email | |
| onDomestic | boolean | required boolean | Whether to send it on domestic |
| subject | string | If a subject or filename is required, what to call it | |
| ticketedOnly | boolean | required boolean | Whether to show it on ticketed |
| onRemark | string | The remark to look for to send it on | |
| onOfflineAgent | boolean | required boolean | Whether to send it if it is a full service agent or not |
| client | Client | ||
| travelAgency | OfficeInfo | ||
| travelManagementCorp | TravelManagementCompany | The TMC that wants this note added to every PNR of theirs. | |
| agent | EmployeeInfo | ||
| internationalOnly | boolean | required boolean | Whether to send it on domestic |
| topNote | boolean | required boolean | Whether to send it on domestic |
| obeOnly | boolean | required boolean | Whether to send it on domestic |
| onHotel | boolean | required boolean | Flag to send if a hotel reservation is present. |
| onCar | boolean | required boolean | Flag to send the note if a car reservation is present. |
| toGds | boolean | 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. |
| traveler | User | The traveler that requires this agent note. | |
| onExchange | boolean | required boolean | Flag on whether to send the note if an exchange is present. |
| onCountry | Country | A visited country that we should show the note for. | |
| boolean | required boolean | Whether this note should NOT appear on the email. | |
| onAir | boolean | required boolean | Flag to send the note if there is an air segment in the PNR. |
| notOnRemark | string | A remark that flags when not to send this note. | |
| notOnCountry | Country | A visited country that we should NOT show the note for. | |
| onNotRefundable | boolean | required boolean | Flag to send the note if there is a non-refundable ticket on the trip. |
| onNoChange | boolean | required boolean | Flag to send the note if there is a no change ticket on the trip. |
| onNoChkBag | boolean | required boolean | Flag to send the note if there is a ticket with no checked bag on the trip. |
| onNoAdvSeat | boolean | required boolean | Flag to send the note if there is a ticket with no advanced seat selection on the trip. |
| onRail | boolean | required boolean | Flag to send the note if there is a rail segment on the record. |
Properties inherited from AirportalNote |
|||
| text | string | ||
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
{
"attachment" : true,
"email" : true,
"onDomestic" : true,
"subject" : "...",
"ticketedOnly" : true,
"onRemark" : "...",
"onOfflineAgent" : true,
"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" : "..."
} ]
},
"travelAgency" : {
"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" : "..."
} ]
},
"travelManagementCorp" : {
"name" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"agent" : {
"user" : {
"answer" : "...",
"emailed" : true,
"newUser" : true,
"temporaryPassword" : "...",
"question" : "...",
"obeUserName" : "...",
"obePassword" : "...",
"obeSyncId" : "...",
"created" : 12345,
"modifiedDate" : 12345,
"emailedWhen" : 12345,
"travelgpaLogin" : "...",
"groups" : [ { }, { } ],
"active" : true,
"prefix" : "...",
"firstName" : "...",
"lastName" : "...",
"middleName" : "...",
"suffix" : "...",
"email" : "...",
"tripitAuthorized" : true,
"supportTitle" : "...",
"automatedNotifications" : true,
"enableHotelAttachment" : true,
"atHomeNotificationMethod" : { },
"inTravelNotificationMethod" : { },
"cellPhoneNumber" : "...",
"userCurrentClient" : { },
"defaultClient" : { },
"defaultPlannerGroup" : { },
"showWelcomeDialog" : true,
"siteTour" : true,
"unusedTicketEmail" : true,
"surveyEmail" : true,
"wt0EmailEnabled" : true,
"wt0EmailDaily" : true,
"wt0EmailDay" : 12345,
"wt0EmailHour" : 12345,
"marketingSubscribed" : true,
"responsive" : true,
"businessPhoneNumber" : "...",
"homePhoneNumber" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"agentCode" : "...",
"office" : {
"pcc" : "...",
"name" : "...",
"address1" : "...",
"address2" : "...",
"address3" : "...",
"city" : "...",
"state" : "...",
"zip" : "...",
"parentCompany" : { },
"active" : "...",
"branch" : "...",
"clientPrefix" : "...",
"profileSettings" : { },
"afterHoursNumber" : "...",
"collectVoidLogs" : true,
"gds" : { },
"arcNumber" : "...",
"logo" : "...",
"logoLink" : "...",
"afterHoursInternationalNumber" : "...",
"tollFreeNumber" : "...",
"phoneNumber" : "...",
"onlineOffice" : { },
"showTmcAppLinks" : true,
"vipTollFree" : "...",
"vipAfterHours" : "...",
"cityCode" : { },
"tmcHeadQuarters" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"workEmail" : "...",
"active" : "...",
"type" : "...",
"emailList" : "...",
"category" : "...",
"directLine" : "...",
"hours" : "...",
"onlineAgent" : true,
"recheckEmails" : true,
"serviceFeesPct" : 12345.0,
"otherServiceFeesPct" : 12345.0,
"internationalAirCommissionPct" : 12345.0,
"miscCommissionPct" : 12345.0,
"airCommissionPct" : 12345.0,
"hotelCommissionPct" : 12345.0,
"carCommissionPct" : 12345.0,
"employeeType" : {
"code" : "...",
"name" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"ticketingAgent" : true,
"supportAgent" : true,
"onsiteAgent" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"internationalOnly" : true,
"topNote" : true,
"obeOnly" : true,
"onHotel" : true,
"onCar" : true,
"toGds" : true,
"traveler" : {
"answer" : "...",
"emailed" : true,
"newUser" : true,
"temporaryPassword" : "...",
"question" : "...",
"obeUserName" : "...",
"obePassword" : "...",
"obeSyncId" : "...",
"created" : 12345,
"modifiedDate" : 12345,
"emailedWhen" : 12345,
"travelgpaLogin" : "...",
"groups" : [ {
"name" : "...",
"permissions" : [ { }, { } ],
"description" : "...",
"role" : { },
"type" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
}, {
"name" : "...",
"permissions" : [ { }, { } ],
"description" : "...",
"role" : { },
"type" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
} ],
"active" : true,
"prefix" : "...",
"firstName" : "...",
"lastName" : "...",
"middleName" : "...",
"suffix" : "...",
"email" : "...",
"tripitAuthorized" : true,
"supportTitle" : "...",
"automatedNotifications" : true,
"enableHotelAttachment" : true,
"atHomeNotificationMethod" : {
"name" : "...",
"code" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"inTravelNotificationMethod" : {
"name" : "...",
"code" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"cellPhoneNumber" : "...",
"userCurrentClient" : {
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"defaultClient" : {
"status" : { },
"parentClient" : { },
"accountNumber" : "...",
"name" : "...",
"type" : { },
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"defaultPlannerGroup" : {
"status" : { },
"parentClient" : { },
"accountNumber" : "...",
"name" : "...",
"type" : { },
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"showWelcomeDialog" : true,
"siteTour" : true,
"unusedTicketEmail" : true,
"surveyEmail" : true,
"wt0EmailEnabled" : true,
"wt0EmailDaily" : true,
"wt0EmailDay" : 12345,
"wt0EmailHour" : 12345,
"marketingSubscribed" : true,
"responsive" : true,
"businessPhoneNumber" : "...",
"homePhoneNumber" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"onExchange" : true,
"onCountry" : {
"name" : "...",
"code" : "...",
"codeAlt" : "...",
"phoneCode" : 12345,
"position" : 12345,
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"hidden" : true,
"onAir" : true,
"notOnRemark" : "...",
"notOnCountry" : {
"name" : "...",
"code" : "...",
"codeAlt" : "...",
"phoneCode" : 12345,
"position" : 12345,
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"onNotRefundable" : true,
"onNoChange" : true,
"onNoChkBag" : true,
"onNoAdvSeat" : true,
"onRail" : true,
"text" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
}