clientSettings Data Type

Specific settings or information that apply to an organization and their experience with Airportal. Created by nick on 11/9/15.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs constraints description
activateNewTravelers boolean element 1/1    
airbankObeSync boolean element 1/1   Whether or not this client desires to have airbank synchronize with their OBE.
annualAirBookings long element 0/1   The estimated total number of transactions in a year.
annualAirVolume double element 0/1   The estimated total for all air transactions in a year.
annualCarVolume double element 0/1   The estimated total for all car transactions in a year.
annualHotelVolume double element 0/1   The estimated total for all hotel transactions in a year.
atRiskNote string element 0/1   Message to describe why a client might be at risk.
client client element 1/1 required The client that these settings belong to.
concurExpense int element 0/1   A short description of the contract this client holds with Concur Expense. 0 = Expense Standard, 1 = Expense Premium
customLogoutUrl string element 0/1   Custom logout url for this client. Useful for SSO enabled clients who don't want their travelers getting trapped in AirPortal
customTravelRequestUrl string element 0/1   The URL for a custom form that this client requires for requesting travel. Null if they use the standard form.
defaultAgentUserGroup group element 0/1   The preferred group (permissions) that users should be added to for links about agents.
defaultOnlineUserGroup group element 0/1   The preferred group (permissions) that users should be added to for links about online booking.
defaultProfileUserGroup group element 0/1   The preferred group (permissions) that users should be added to for links about profiles.
firstTicketIssued dateTime element 0/1   The date of client creation
fullService boolean element 1/1   Whether or not this client books full service bookings.
gds globalDistributionSystem element 0/1   The GDS that this client is expecting to book in.
gdsName string element 0/1 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.
hotelAttachment boolean element 1/1   Determines whether hotel attachments should be sent out for this client.
hrFeed boolean element 1/1   Whether or not this client is setup for hr feed.
industry industry element 0/1   The industry that this account operates in.
loginClone string element 0/1   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.
string element 0/1   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 element 0/1   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.
marketingEmail boolean element 1/1   Whether or not this client desires to receiving marketing and promotional emails.
notificationLevel travelAlertSeverity element 0/1   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 int element 0/1   The radius around the focal point of the notification event that all travelers should be notified within automatically.
numEmployees long element 0/1   The total number of employees at this client.
numTravelers long element 0/1   The total number of travelers at this client.
obe onlineBookingEngine element 0/1   The online booking tool that this client prefers to use.
obeBookingLink int element 0/1    
obeContractHolder int element 1/1   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.
obeProfileLink int element 0/1    
obeSite string element 0/1   The name of the site for this client on the OBE.
obeSubscriptionLevel int element 1/1   The subscription level that this account has with their online tool. 0 = Standard, 1 = Professional. Leave 0 if no OBE is used.
onlineService boolean element 1/1   Whether or not this client uses an online booking engine.
onsiteService boolean element 1/1   Whether or not this client has an onsite agent.
profilePassword string element 0/1   The administrator password for this client's online booking engine site.
profileUsername string element 0/1   The administrator username for this client's online booking engine site.
quickLinks list of quickLink element 0/unbounded   Quick links are what are displayed on airportal and travelacumen on their navigation.
secureLogoutMessage string element 0/1    
secureProfile boolean element 1/1    
sendEmail boolean element 1/1   Default flag whether or not to send welcome to airportal emails to new enrollments.
showOldProfileLink boolean element 1/1    
source clientSource element 0/1   The source of this client, in reference to where the sales person first discovered this account.
surveyEmail boolean element 1/1 required Flag to control sending survey emails
travelAgency officeInfo element 0/1   The office of the travel agency that serves this client / account.
travelApproval boolean element 1/1   Determines whether travel approvals should be sent out for this client.
tripLinkEnabled boolean element 1/1   Whether or not this client is triplink enabled.
unusedTicketEmail boolean element 1/1 required Flag to control sending unused ticket emails to travelers
url string element 0/1   The URL that new travelers of this client should go to create a travel profile.
website string element 0/1   The home website of the account.
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

<clientSettings>
  <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>
  <url>...</url>
  <obeSite>...</obeSite>
  <loginClone>...</loginClone>
  <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>
      <oldCode>...</oldCode>
      <name>...</name>
      <agressoCode>...</agressoCode>
      <enabled>...</enabled>
      <profileSyncEnabled>...</profileSyncEnabled>
    </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>
  <annualAirVolume>...</annualAirVolume>
  <annualCarVolume>...</annualCarVolume>
  <annualHotelVolume>...</annualHotelVolume>
  <annualAirBookings>...</annualAirBookings>
  <numEmployees>...</numEmployees>
  <numTravelers>...</numTravelers>
  <fullService>...</fullService>
  <onlineService>...</onlineService>
  <onsiteService>...</onsiteService>
  <marketingEmail>...</marketingEmail>
  <concurExpense>...</concurExpense>
  <source>
    <name>...</name>
    <id>...</id>
    <version>...</version>
  </source>
  <logo>...</logo>
  <logoLink>...</logoLink>
  <sendEmail>...</sendEmail>
  <activateNewTravelers>...</activateNewTravelers>
  <defaultAgentUserGroup>
    <name>...</name>
    <permissions>
      <name>...</name>
      <description>...</description>
    </permissions>
    <description>...</description>
    <role>
      <name>...</name>
      <code>...</code>
    </role>
    <type>...</type>
    <id>...</id>
    <version>...</version>
  </defaultAgentUserGroup>
  <defaultProfileUserGroup>
    <name>...</name>
    <permissions>
      <name>...</name>
      <description>...</description>
    </permissions>
    <description>...</description>
    <role>
      <name>...</name>
      <code>...</code>
    </role>
    <type>...</type>
    <id>...</id>
    <version>...</version>
  </defaultProfileUserGroup>
  <defaultOnlineUserGroup>
    <name>...</name>
    <permissions>
      <name>...</name>
      <description>...</description>
    </permissions>
    <description>...</description>
    <role>
      <name>...</name>
      <code>...</code>
    </role>
    <type>...</type>
    <id>...</id>
    <version>...</version>
  </defaultOnlineUserGroup>
  <notificationLevel>
    <name>...</name>
    <id>...</id>
    <version>...</version>
  </notificationLevel>
  <notificationRadius>...</notificationRadius>
  <firstTicketIssued>...</firstTicketIssued>
  <website>...</website>
  <profileUsername>...</profileUsername>
  <profilePassword>...</profilePassword>
  <obe>
    <code>...</code>
    <name>...</name>
    <profileSyncEnabled>...</profileSyncEnabled>
    <id>...</id>
    <version>...</version>
  </obe>
  <showOldProfileLink>...</showOldProfileLink>
  <customTravelRequestUrl>...</customTravelRequestUrl>
  <airbankObeSync>...</airbankObeSync>
  <gdsName>...</gdsName>
  <gds>
    <code>...</code>
    <oldCode>...</oldCode>
    <name>...</name>
    <agressoCode>...</agressoCode>
    <enabled>...</enabled>
    <profileSyncEnabled>...</profileSyncEnabled>
    <id>...</id>
    <version>...</version>
  </gds>
  <tripLinkEnabled>...</tripLinkEnabled>
  <quickLinks>
    <requiredPermission>...</requiredPermission>
    <url>...</url>
    <text>...</text>
    <description>...</description>
    <linkOrder>...</linkOrder>
    <allClients>...</allClients>
    <newWindow>...</newWindow>
    <dashboards>
      <name>...</name>
    </dashboards>
    <id>...</id>
    <version>...</version>
  </quickLinks>
  <obeProfileLink>...</obeProfileLink>
  <obeBookingLink>...</obeBookingLink>
  <secureLogoutMessage>...</secureLogoutMessage>
  <unusedTicketEmail>...</unusedTicketEmail>
  <hotelAttachment>...</hotelAttachment>
  <travelApproval>...</travelApproval>
  <surveyEmail>...</surveyEmail>
  <obeSubscriptionLevel>...</obeSubscriptionLevel>
  <obeContractHolder>...</obeContractHolder>
  <industry>
    <name>...</name>
    <id>...</id>
    <version>...</version>
  </industry>
  <secureProfile>...</secureProfile>
  <hrFeed>...</hrFeed>
  <customLogoutUrl>...</customLogoutUrl>
  <atRiskNote>...</atRiskNote>
  <id>...</id>
  <version>...</version>
  <violations/>
</clientSettings>