A queue sort setting is a definition of traits that a PNR must have to be sent to another queue.
| name | data type | constraints | description |
|---|---|---|---|
| push | Queue | required | The queue to push the PNR to if the criteria are met. If this is NULL we expect to send the PNR back to the pop_queue. |
| onRemark | string | The remark expression to flag the pnr for this sort. | |
| notOnRemark | string | The remark expression to flag the pnr NOT for this sort. | |
| onOffice | OfficeInfo | The office for this sort. | |
| onClient | Client | The client for this sort. | |
| onDepartureCity | City | The departure city for this sort. | |
| onArrivalCity | City | The arrival city for this sort. | |
| description | string | A description of the sort for future reference. | |
| onAirVendor | AirVendor | The vendor for this sort. | |
| notOnOffice | OfficeInfo | The office NOT for this sort. | |
| onInternational | boolean | required boolean | Whether to sort based on if it has an international flight. |
| onTicketed | boolean | required boolean | Whether to sort based on if it has an invoice. |
| notClient | Client | The client NOT for this sort. | |
| notTicketed | boolean | required boolean | Whether to sort based on if it does NOT have an invoice. |
| onToday | boolean | required boolean | Whether to sort based on today being the creation date. |
| notToday | boolean | required boolean | Whether to sort based on today NOT being the creation date. |
| onInvoice | boolean | required boolean | Whether to sort based on if this PNR has an invoice number. |
| notInvoice | boolean | required boolean | Whether to sort based on if this PNR does not have an invoice number. |
| onSegments | boolean | required boolean | Whether to sort based on if this PNR has segments in it. |
| notSegments | boolean | required boolean | Whether to sort based on if this PNR does not have segments in it. |
| onOpenJaw | boolean | required boolean | Whether to sort based on if this PNR is an open jaw. |
| onCircle | boolean | required boolean | Whether to sort based on if this PNR is a circle trip. |
| onOneWay | boolean | required boolean | Whether to sort based on if this PNR is considered a one way trip. |
| onRoundTrip | boolean | required boolean | Whether to sort based on if this PNR is considered a round trip. |
| notAir | boolean | required boolean | Whether to sort based on if this PNR has no air segments. |
| onUser | User | Whether to sort based on if this PNR has a particular passenger. | |
| onHotelChange | boolean | required boolean | Whether or not to sort based on if this PNR has a hotel that has been changed. |
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
{
"push" : {
"number" : 12345,
"category" : "...",
"pcc" : "...",
"description" : "...",
"gds" : {
"code" : "...",
"name" : "...",
"enabled" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"sorts" : [ {
"push" : { },
"onRemark" : "...",
"notOnRemark" : "...",
"onOffice" : { },
"onClient" : { },
"onDepartureCity" : { },
"onArrivalCity" : { },
"description" : "...",
"onAirVendor" : { },
"notOnOffice" : { },
"onInternational" : true,
"onTicketed" : true,
"notClient" : { },
"notTicketed" : true,
"onToday" : true,
"notToday" : true,
"onInvoice" : true,
"notInvoice" : true,
"onSegments" : true,
"notSegments" : true,
"onOpenJaw" : true,
"onCircle" : true,
"onOneWay" : true,
"onRoundTrip" : true,
"notAir" : true,
"onUser" : { },
"onHotelChange" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
}, {
"push" : { },
"onRemark" : "...",
"notOnRemark" : "...",
"onOffice" : { },
"onClient" : { },
"onDepartureCity" : { },
"onArrivalCity" : { },
"description" : "...",
"onAirVendor" : { },
"notOnOffice" : { },
"onInternational" : true,
"onTicketed" : true,
"notClient" : { },
"notTicketed" : true,
"onToday" : true,
"notToday" : true,
"onInvoice" : true,
"notInvoice" : true,
"onSegments" : true,
"notSegments" : true,
"onOpenJaw" : true,
"onCircle" : true,
"onOneWay" : true,
"onRoundTrip" : true,
"notAir" : true,
"onUser" : { },
"onHotelChange" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
} ],
"airtineraryQueue" : true,
"importQueue" : true,
"availableTimeRange" : "...",
"maximumPops" : 12345,
"overrideSortCategory" : "...",
"failureQueue" : 12345,
"failureCategory" : "...",
"agentQueue" : true,
"agent" : {
"user" : { },
"agentCode" : "...",
"office" : { },
"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" : { },
"ticketingAgent" : true,
"supportAgent" : true,
"onsiteAgent" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"failurePcc" : "...",
"agentExclusions" : [ {
"agent" : { },
"onClient" : { },
"onOffice" : { },
"onAgent" : { },
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
}, {
"agent" : { },
"onClient" : { },
"onOffice" : { },
"onAgent" : { },
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
} ],
"ticketingQueue" : true,
"validationQueue" : true,
"type" : {
"name" : "...",
"code" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"hplQueue" : true,
"logEnabled" : true,
"airselectQueue" : true,
"defaultQueue" : { },
"autoScheduleChange" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"onRemark" : "...",
"notOnRemark" : "...",
"onOffice" : {
"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" : "..."
} ]
},
"onClient" : {
"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" : "..."
} ]
},
"onDepartureCity" : {
"code" : "...",
"countryCode" : "...",
"latitude" : 12345.0,
"longitude" : 12345.0,
"name" : "...",
"stateOrCountry" : "...",
"airportName" : "...",
"region" : {
"name" : "...",
"code" : "...",
"country" : { },
"position" : 12345,
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"timeZone" : {
"name" : "...",
"offset" : 12345.0,
"daylightSavingsOffset" : 12345.0,
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"retentionOnly" : true,
"position" : 12345,
"unique" : true,
"alias" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"onArrivalCity" : {
"code" : "...",
"countryCode" : "...",
"latitude" : 12345.0,
"longitude" : 12345.0,
"name" : "...",
"stateOrCountry" : "...",
"airportName" : "...",
"region" : {
"name" : "...",
"code" : "...",
"country" : { },
"position" : 12345,
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"timeZone" : {
"name" : "...",
"offset" : 12345.0,
"daylightSavingsOffset" : 12345.0,
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"retentionOnly" : true,
"position" : 12345,
"unique" : true,
"alias" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"description" : "...",
"onAirVendor" : {
"airlineNumber" : 12345,
"checkinLink" : "...",
"baggageLink" : "...",
"alliance" : {
"sharesFrequentFlyerNumbers" : true,
"name" : "...",
"code" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"lowCostCarrier" : true,
"longCode" : "...",
"manualTicketingOnly" : true,
"airTicketsUseOrigIssueDate" : true,
"mcoTicketsUseOrigIssueDate" : true,
"minDomesticValue" : 12345,
"minIntlValue" : 12345,
"position" : 12345,
"imageUrl" : "...",
"code" : "...",
"name" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"notOnOffice" : {
"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" : "..."
} ]
},
"onInternational" : true,
"onTicketed" : true,
"notClient" : {
"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" : "..."
} ]
},
"notTicketed" : true,
"onToday" : true,
"notToday" : true,
"onInvoice" : true,
"notInvoice" : true,
"onSegments" : true,
"notSegments" : true,
"onOpenJaw" : true,
"onCircle" : true,
"onOneWay" : true,
"onRoundTrip" : true,
"notAir" : true,
"onUser" : {
"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" : "..."
} ]
},
"onHotelChange" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
}