Specific settings or information that apply to an organization and their experience with Airportal. Created by nick on 11/9/15.
| name | data type | constraints | description |
|---|---|---|---|
| client | Client | required | The client that these settings belong to. |
| url | string | The URL that new travelers of this client should go to create a travel profile. | |
| obeSite | string | The name of the site for this client on the OBE. | |
| loginClone | string | The sub-name of the site for this client on the OBE, if a sub-name applies. This is specific to OBEs like NuTravel, in that their site will typically be a TMC-wide site and this will identify their specific login. | |
| travelAgency | OfficeInfo | The office of the travel agency that serves this client / account. | |
| annualAirVolume | number | The estimated total for all air transactions in a year. | |
| annualCarVolume | number | The estimated total for all car transactions in a year. | |
| annualHotelVolume | number | The estimated total for all hotel transactions in a year. | |
| annualAirBookings | number | The estimated total number of transactions in a year. | |
| numEmployees | number | The total number of employees at this client. | |
| numTravelers | number | The total number of travelers at this client. | |
| fullService | boolean | required boolean | Whether or not this client books full service bookings. |
| onlineService | boolean | required boolean | Whether or not this client uses an online booking engine. |
| onsiteService | boolean | required boolean | Whether or not this client has an onsite agent. |
| marketingEmail | boolean | required boolean | Whether or not this client desires to receiving marketing and promotional emails. |
| concurExpense | number | A short description of the contract this client holds with Concur Expense. 0 = Expense Standard, 1 = Expense Premium | |
| source | ClientSource | The source of this client, in reference to where the sales person first discovered this account. | |
| logo | string | The logo to show on pages for this client. This is for both the TMC and client on the web and on airtineraries. | |
| logoLink | string | The link to direct the user when they click on the logo. This is for both the TMC and client on the web and on airtineraries. | |
| sendEmail | boolean | required boolean | Default flag whether or not to send welcome to airportal emails to new enrollments. |
| activateNewTravelers | boolean | required boolean | |
| defaultAgentUserGroup | Group | The preferred group (permissions) that users should be added to for links about agents. | |
| defaultProfileUserGroup | Group | The preferred group (permissions) that users should be added to for links about profiles. | |
| defaultOnlineUserGroup | Group | The preferred group (permissions) that users should be added to for links about online booking. | |
| notificationLevel | TravelAlertSeverity | The severity level of notifications that this account desires to be automatically sent. All notifications of this severity and above will be sent automatically. | |
| notificationRadius | number | The radius around the focal point of the notification event that all travelers should be notified within automatically. | |
| firstTicketIssued | number | The date of client creation | |
| website | string | The home website of the account. | |
| profileUsername | string | The administrator username for this client's online booking engine site. | |
| profilePassword | string | The administrator password for this client's online booking engine site. | |
| obe | OnlineBookingEngine | The online booking tool that this client prefers to use. | |
| showOldProfileLink | boolean | required boolean | |
| customTravelRequestUrl | string | The URL for a custom form that this client requires for requesting travel. Null if they use the standard form. | |
| airbankObeSync | boolean | required boolean | Whether or not this client desires to have airbank synchronize with their OBE. |
| gdsName | string | max size: 16, min size: 0 | The ID/Name for this client in the GDS. This is required if you plan to synchronize trips, profiles, or policies to the GDS. |
| gds | GlobalDistributionSystem | The GDS that this client is expecting to book in. | |
| tripLinkEnabled | boolean | required boolean | Whether or not this client is triplink enabled. |
| quickLinks | array of QuickLink | Quick links are what are displayed on airportal and travelacumen on their navigation. | |
| obeProfileLink | number | ||
| obeBookingLink | number | ||
| secureLogoutMessage | string | ||
| unusedTicketEmail | boolean | required boolean | Flag to control sending unused ticket emails to travelers |
| hotelAttachment | boolean | required boolean | Determines whether hotel attachments should be sent out for this client. |
| travelApproval | boolean | required boolean | Determines whether travel approvals should be sent out for this client. |
| surveyEmail | boolean | required boolean | Flag to control sending survey emails |
| obeSubscriptionLevel | number | required int | The subscription level that this account has with their online tool. 0 = Standard, 1 = Professional. Leave 0 if no OBE is used. |
| obeContractHolder | number | required int | Who holds the contract for the online booking tool for this account. 0 = Client, 1 = TMC. This helps determine how we support the client in regards to their OBE. Leave as 0 if no OBE is used. |
| industry | Industry | The industry that this account operates in. | |
| secureProfile | boolean | required boolean | |
| hrFeed | boolean | required boolean | Whether or not this client is setup for hr feed. |
| customLogoutUrl | string | Custom logout url for this client. Useful for SSO enabled clients who don't want their travelers getting trapped in AirPortal | |
| atRiskNote | string | Message to describe why a client might be at risk. | |
| globalAccount | boolean | required boolean | |
| enableProfileUrl | boolean | required boolean | |
| groupAir | boolean | required boolean | Determines if group travel air service is enabled for this client |
| groupHotel | boolean | required boolean | Determines if group travel hotel service is enabled for this client |
| groupGround | boolean | required boolean | Determines if group travel ground service is enabled for this client |
| groupMeetingSpace | boolean | required boolean | Determines if group travel meeting space service is enabled for this client |
| groupEquipment | boolean | required boolean | Determines if group travel equipment service is enabled for this client |
| groupBudget | boolean | required boolean | Determines if group travel budget service is enabled for this client |
| profilesEnabled | boolean | required boolean | Determines if group travel budget service is enabled for this client |
| idp | number | The idp the client is using. | |
| oktaEnabled | boolean | If the client is ssoing into okta instead of our simple saml instance. | |
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" : "..."
} ]
},
"url" : "...",
"obeSite" : "...",
"loginClone" : "...",
"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" : "..."
} ]
},
"annualAirVolume" : 12345.0,
"annualCarVolume" : 12345.0,
"annualHotelVolume" : 12345.0,
"annualAirBookings" : 12345,
"numEmployees" : 12345,
"numTravelers" : 12345,
"fullService" : true,
"onlineService" : true,
"onsiteService" : true,
"marketingEmail" : true,
"concurExpense" : 12345,
"source" : {
"name" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"logo" : "...",
"logoLink" : "...",
"sendEmail" : true,
"activateNewTravelers" : true,
"defaultAgentUserGroup" : {
"name" : "...",
"permissions" : [ {
"name" : "...",
"description" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
}, {
"name" : "...",
"description" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
} ],
"description" : "...",
"role" : {
"name" : "...",
"code" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"type" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"defaultProfileUserGroup" : {
"name" : "...",
"permissions" : [ {
"name" : "...",
"description" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
}, {
"name" : "...",
"description" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
} ],
"description" : "...",
"role" : {
"name" : "...",
"code" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"type" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"defaultOnlineUserGroup" : {
"name" : "...",
"permissions" : [ {
"name" : "...",
"description" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
}, {
"name" : "...",
"description" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
} ],
"description" : "...",
"role" : {
"name" : "...",
"code" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"type" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"notificationLevel" : {
"name" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"notificationRadius" : 12345,
"firstTicketIssued" : 12345,
"website" : "...",
"profileUsername" : "...",
"profilePassword" : "...",
"obe" : {
"code" : "...",
"name" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"showOldProfileLink" : true,
"customTravelRequestUrl" : "...",
"airbankObeSync" : true,
"gdsName" : "...",
"gds" : {
"code" : "...",
"name" : "...",
"enabled" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"tripLinkEnabled" : true,
"quickLinks" : [ {
"requiredPermission" : "...",
"url" : "...",
"text" : "...",
"description" : "...",
"linkOrder" : 12345,
"allClients" : true,
"newWindow" : true,
"dashboards" : [ {
"name" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
}, {
"name" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
} ],
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
}, {
"requiredPermission" : "...",
"url" : "...",
"text" : "...",
"description" : "...",
"linkOrder" : 12345,
"allClients" : true,
"newWindow" : true,
"dashboards" : [ {
"name" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
}, {
"name" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
} ],
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
} ],
"obeProfileLink" : 12345,
"obeBookingLink" : 12345,
"secureLogoutMessage" : "...",
"unusedTicketEmail" : true,
"hotelAttachment" : true,
"travelApproval" : true,
"surveyEmail" : true,
"obeSubscriptionLevel" : 12345,
"obeContractHolder" : 12345,
"industry" : {
"name" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"secureProfile" : true,
"hrFeed" : true,
"customLogoutUrl" : "...",
"atRiskNote" : "...",
"globalAccount" : true,
"enableProfileUrl" : true,
"groupAir" : true,
"groupHotel" : true,
"groupGround" : true,
"groupMeetingSpace" : true,
"groupEquipment" : true,
"groupBudget" : true,
"profilesEnabled" : true,
"idp" : 12345,
"oktaEnabled" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
}