An object that describes a trip as a summary.
| name | data type | constraints | description |
|---|---|---|---|
| recordLocator | string | required, max size: 6, min size: 0 | The agency locator for the trip. |
| agentName | string | max size: 255, min size: 0 | The name of the booking agent. |
| client | Client | required | The client that paid for this trip. |
| office | OfficeInfo | required | The travel agency that the trip was booked under. |
| departureDate | number | The date that this trip starts. | |
| completionDate | number | The date that this trip ends. | |
| importDate | number | The date that this trip was imported into Airportal. | |
| gds | GlobalDistributionSystem | required | The GDS that this trip was booked in. |
| latest | boolean | required boolean | Whether or not this trip is hidden from view. |
| citySummary | string | A quick summary of the cities visited in this trip. | |
| departureCity | City | The city the passenger(s) are leaving. | |
| arrivalCity | City | The destination city. | |
| arrivalDate | number | The date of arrival to destination city | |
| utcArrivalDate | number | The date of arrival to destination city in UTC | |
| startDate | number | When the trip will begin in UTC. | |
| endDate | number | When the trip will end in UTC. | |
| purpose | string | A short note as to what the purpose of the trip is. | |
| explanation | string | A short note as to what the purpose of the trip is. | |
| string | max size: 64, min size: 0 | The authorization code for this itinerary. Configurable by the client via udid. | |
| costCenterCode | string | max size: 64, min size: 0 | The cost center code for this itinerary. configurable by the client via udid. |
| departmentCode | string | max size: 64, min size: 0 | The department code for this itinerary. configurable by the client via udid. |
| clientCode | string | max size: 64, min size: 0 | The client code for this itinerary. Configurable by the client via udid. |
| regionCode | string | max size: 64, min size: 0 | The region code for this itinerary. Configurable by the client via udid. |
| billable | string | max size: 64, min size: 0 | The billable ID for this itinerary. Configurable by the client via udid. |
| travelerCode | string | max size: 64, min size: 0 | The traveler id for this itinerary. Configurable by the client via udid. |
| managerCode | string | max size: 64, min size: 0 | The manager id for this itinerary. Configurable by the client via udid. |
| projectCode | string | max size: 64, min size: 0 | The project id for this itinerary. Configurable by the client via udid. |
| status | ItineraryStatus | required | |
| observers | array of Client | Observers are the airportal clients who CAN SEE this itinerary. | |
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
{
"recordLocator" : "...",
"agentName" : "...",
"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" : "..."
} ]
},
"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" : "..."
} ]
},
"departureDate" : 12345,
"completionDate" : 12345,
"importDate" : 12345,
"gds" : {
"code" : "...",
"name" : "...",
"enabled" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"latest" : true,
"citySummary" : "...",
"departureCity" : {
"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" : "..."
} ]
},
"arrivalCity" : {
"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" : "..."
} ]
},
"arrivalDate" : 12345,
"utcArrivalDate" : 12345,
"startDate" : 12345,
"endDate" : 12345,
"purpose" : "...",
"explanation" : "...",
"authorizationCode" : "...",
"costCenterCode" : "...",
"departmentCode" : "...",
"clientCode" : "...",
"regionCode" : "...",
"billable" : "...",
"travelerCode" : "...",
"managerCode" : "...",
"projectCode" : "...",
"status" : {
"name" : "...",
"position" : 12345,
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"observers" : [ {
"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" : "..."
} ]
}, {
"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" : "..."
} ]
} ],
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
}