UserProvider Service

An API to interact with AirPortal User objects.

Namespace
http://airportal.service.cbtweb.cbt.com/
WSDL
airportal.wsdl
Path
/UserProviderService

getUserByEmail Operation

Get the user information of the provided email.

Input Parameters
name type description
email string The email address of the user.
Return Value
type description
user A user object containing the user's privileges and info.

getUserByNames Operation

Get the user based on the given name information. Searches first by last name and client. Then, if needs be, will narrow the list by first and middle names.

Input Parameters
name type description
first string  
middle string  
last string  
client client  
Return Value
type description
user the User

getLoggedInUser Operation

Get the user information of the logged-in user.

Return Value
type description
user  

updateUser Operation

A function to update users.

Input Parameters
name type description
record user A zombie (unsessioned) user that holds data to update with a user in the database.
Return Value
type description
user A message as to whether the user was updated successfully or failed.

updateLoggedInUser Operation

A function to update the logged in user. Used to avoid the permissions restriction on a user's own data.

Input Parameters
name type description
record user A zombie (unsessioned) user that holds data to update with a user in the database.
Return Value
type description
user A message as to whether the user was updated successfully or failed.

deleteUser Operation

Deletes a user from the database.

Input Parameters
name type description
id long The unique identifier of the object.

softDeleteUser Operation

Deletes a user softly, by removing connections to clients, unused ticket associations, and setting the user as inactive.

Input Parameters
name type description
id long The unique identifier of the object.
Return Value
type description
string  

getUserById Operation

Retrieves a user from the database.

Input Parameters
name type description
id long The unique identifier of the user.
Return Value
type description
user A user that represents the user with the given id from the provider.

isValid Operation

Check whether this user is a valid user object.

Input Parameters
name type description
user user a user object to check validity
Return Value
type description
boolean true/false if the user object is valid

getConstraints Operation

Get the constraint descriptions of this object.

Return Value
type description
list of simpleConstraintDescriptor A list of SimpleConstraintDescriptors that describe the constraints of this object required by the DB.

getEmailAddress Operation

Get the primary email for a user.

Input Parameters
name type description
id long The id of the user to get an email for.
Return Value
type description
string The email address for the user.

getTravelAgencyUserWorksFor Operation

Get the travel agency that a user works for. I.E CBTravel.

Return Value
type description
client The client that employs this user as a travel agent / account manager.

getOfficesUserWorksForById Operation

Get the office that the user is an employee of.

Input Parameters
name type description
id long The user id to get the employer for.
Return Value
type description
list of officeInfo Offices that employs this user.

getUserEmployeeInfoById Operation

Get the employee records for the user.

Input Parameters
name type description
id long The user id to get the employee info for.
Return Value
type description
list of employeeInfo Employee records of this user.

setDefaultClientForLoggedInUser Operation

Sets the default (favorite) client for logged in user

Input Parameters
name type description
clientId long The default client id. If null it will remove the default.
Return Value
type description
string true if operation was successful, false otherwise

setDefaultClient Operation

Sets the default (favorite) client for the given user

Input Parameters
name type description
userId long The id of the user to change the default client
clientId long The default client id.
Return Value
type description
string true if operation was successful, false otherwise

setDefaultEmployer Operation

Sets the default employer for the given traveler.

Input Parameters
name type description
userId long The id of the user to change the default employer.
clientId long The default client id. If null it will remove the default.
Return Value
type description
clientMember The member object that was created as the default.

setDefaultPlannerGroupForLoggedInUser Operation

Sets the default (favorite) planner group for logged in user

Input Parameters
name type description
clientId long The default client id. If null it will remove the default.
Return Value
type description
string true if operation was successful, false otherwise

setDefaultPlannerGroup Operation

Sets the default (favorite) planner group for the given user

Input Parameters
name type description
userId long The id of the user to change the default planner group
clientId long The default client id. If null it will remove the default.
Return Value
type description
string true if operation was successful, false otherwise

getClientsUserIsPermissionedToSee Operation

Get a list of clients that the user is permissioned to see. This is not to be confused with getClientsUserCanSee() and getClientsThatCanSeeUser() since those lists are based on the linking tables.

Return Value
type description
list of client  

getClientsUserCanSee Operation

Get the clients (groups of travelers) that this user can see.

Return Value
type description
list of client A list of clients that this user can see.

getClientsThatCanSeeUser Operation

Get the clients that can see this user.

Return Value
type description
list of client A list of clients that can see this user's itineraries.

getDefaultClientUserCanSee Operation

Get the default client that the user can see or manage.

Return Value
type description
client The default client that the user can see or manage.

getDefaultClientThatCanSeeUser Operation

Get the default client that can see the user.

Return Value
type description
client The default client that can see the user.

getDefaultAccountForUser Operation

Get the default account that can see the user. The account is the parent client that is closest to the traveler with an account number.

Return Value
type description
client The default account that can see the user. This is the client the user does online booking under.

getDefaultClientThatCanSeeUserById Operation

Get the default client that can see the user.

Input Parameters
name type description
id long  
Return Value
type description
client The default client that can see the user. This is the client the user does online booking under.

getDefaultClientUserCanSeeById Operation

Get the default client that the user can see.

Input Parameters
name type description
id long  
Return Value
type description
client The default client that the user sees. This is the client the user sees and manages by default.

getDefaultAccountForUserById Operation

Get the default account that can see the user. The account is the parent client that is closest to the traveler with an account number.

Input Parameters
name type description
id long  
Return Value
type description
client The default account that can see the user. This is the client the user does online booking under.

getTravelAgentsForLoggedInUser Operation

Return Value
type description
list of user  

getBackupTravelAgentsForLoggedInUser Operation

Return Value
type description
list of user  

searchUsers Operation

Search the users using a search list.

Input Parameters
name type description
searchList searchList The search list to build a query from.
Return Value
type description
list of user The results of the search list's query, from the User object perspective.

countUsers Operation

Get a count of total users in a query.

Input Parameters
name type description
search searchList The query to get a count of.
Return Value
type description
long A long value that is the total records expected.

getUserByUid Operation

Search the users by the uid, whether it is a username or an id.

Input Parameters
name type description
uid string The user ID, may it be an ID or a username.
Return Value
type description
user The User represented by the ID.

getUserByUidAndClient Operation

Search the users by the uid, whether it is a username or an id.

Input Parameters
name type description
uid string The user ID, may it be an ID or a username.
clientId long  
Return Value
type description
user The User represented by the ID.

getClientsUserCanSeeById Operation

Get the clients (groups of travelers) that this user can see.

Input Parameters
name type description
id long The unique identifier of the user.
Return Value
type description
list of client A list of clients that this user can see.

getClientsThatCanSeeUserById Operation

Get the clients (groups of travelers) that can see this user.

Input Parameters
name type description
id long The unique identifier of the user.
Return Value
type description
list of client A list of clients that can see the user.

getAccountManagerClientsById Operation

Get the clients (groups of travelers) that the user is an account manager for

Input Parameters
name type description
id long The unique identifier of the user.
Return Value
type description
list of clientManager A list of ClientManager objects for the user and clients is an account manager for.

getSalesClientsById Operation

Get the clients (groups of travelers) that the user is an account manager for

Input Parameters
name type description
id long The unique identifier of the user.
Return Value
type description
list of clientManager A list of ClientManager objects for the user and clients is an account manager for.

getClientsManagedById Operation

Get the ClientManager objects for a user.

Input Parameters
name type description
userid long The unique identifier of the user.
Return Value
type description
list of clientManager A list of ClientManager objects that maps users to clients that they manage.

getClientIdsManagedById Operation

Get the ids of clients managed by a user.

Input Parameters
name type description
userid long The unique identifier of the user.
Return Value
type description
list of long A list of client ids that maps users to clients that they manage.

getEmployersById Operation

Get the ClientMember objects for a user.

Input Parameters
name type description
userid long The unique identifier of the user.
Return Value
type description
list of clientMember A list of ClientMember objects that maps users to clients that employ them as travelers.

updateUsername Operation

A function to update or create Usernames.

Input Parameters
name type description
record username A zombie (unsessioned) user that holds data to create a user with in the database.
Return Value
type description
username A Username object that was updated.

updateLoggedInUsername Operation

A function to update the logged in username. Used to avoid permission restrictions on a user's own data.

Input Parameters
name type description
record username A zombie (unsessioned) user that holds data to create a user with in the database.
Return Value
type description
username A Username object that was updated.

removeUsername Operation

Remove a Username from a user.

Input Parameters
name type description
usernameId long The id of the username to remove.

removeLoggedInUsername Operation

Remove a Username from the logged in user. Used to avoid permission restrictions on a user's own data.

Input Parameters
name type description
usernameId long The id of the username to remove.

getUsername Operation

A function to find a username, for validation purposes.

Input Parameters
name type description
name string A string username, email or otherwise, to search for
Return Value
type description
string the Username string, if found.

getPrimaryUsername Operation

Get the primary username object for a user.

Input Parameters
name type description
id long The id of the user.
Return Value
type description
username The primary username object for the user.

getUsernames Operation

Get all username objects for a user.

Input Parameters
name type description
id long The id of the user.
Return Value
type description
list of username List of usernames of the user.

getQuickLinksForOnlineBooking Operation

Get the quick links to be displayed for airportal.

Return Value
type description
list of quickLink The quick links to be displayed for airportal.

getUserQuickLinksForOnlineBooking Operation

Get the quick links to be displayed for airportal.

Input Parameters
name type description
userId long  
Return Value
type description
list of quickLink The quick links to be displayed for airportal.

getCustomTravelRequestUrl Operation

Get the custom travel request url for the logged in user, based on their default client.

Return Value
type description
string The custom travel request url for the logged in user.

setLoggedInPassword Operation

A function to allow updating the logged in user to change their password. Done so that a user can change their own password but no user can change another user's password.

Input Parameters
name type description
newpass string A new password to replace the old one

resetUserPassword Operation

A function to reset a given user's temporary password with a randomly generated one.

Input Parameters
name type description
userid long Id of the user to reset password for
Return Value
type description
statusResponse  

createOBEUser Operation

Creates a user, associated username, and an OBE profile with just an email

Input Parameters
name type description
email string The user's email address
firstName string The user's first name
middleName string The user's middle name
lastName string The user's last name
cellPhoneNumber string The user's mobile phone number
obeUserName string The user's obe user name
clientId long The client that the user will be a member of
createNewProfile boolean Should a new profile be created in the obe?
showWelcomeDialog boolean Should the user be shown a welcome dialog when they first log in?
profileData profileData Data to add to the new user's profile
Return Value
type description
user The new user

createUser Operation

A function to create a user and associated username with just an email

Input Parameters
name type description
email string Email address for the primary email/username
firstName string The first name of the user.
lastName string The last name of the user.
clientId long The internal ID of the client to add the user as a traveler to.
Return Value
type description
user A User object that represents the newly created user.

emailNewUser Operation

A function email a user with a welcome email and a link to change their password

Input Parameters
name type description
userId long Id of the user to email
Return Value
type description
string  

sendWelcomeEmailToUsers Operation

Send the welcome to airportal email to the users specified by the searchlist

Input Parameters
name type description
list searchList  

changeUserPassword Operation

Method to change the password of a user to a specific password

Input Parameters
name type description
userId long the userid of the user
password string the new password
Return Value
type description
boolean string true or false based on result

doesHashMatch Operation

Checks to see if the has matches the built hash

Input Parameters
name type description
hash string the has to check
userId long the user to check the hash against
Return Value
type description
statusResponse string boolean result

isTravelManager Operation

Checks to see if the user is a travel planner

Input Parameters
name type description
userId long the user id to check
type string the type of manager (manager/planner)
Return Value
type description
string String representing a boolean

getLoggedInUsersGridSetting Operation

Retrieve the settings key for a table for a logged in user.

Input Parameters
name type description
tableCode string A unique code that describes a particular table
Return Value
type description
string The permutation for the table for the logged in user.

getLoggedInUsersGridState Operation

Retrieve the json grid state for the logged in user

Input Parameters
name type description
tableCode string A unique code that describes a particular table
Return Value
type description
string The json state for the table for the logged in user.

saveUsersGridSetting Operation

Save the settings key for a table for a logged in user.

Input Parameters
name type description
tableCode string The table code to save the key for.
permutation string The key to save.
jsonState string  

getLogoById Operation

Get the display logo for a target user by id

Input Parameters
name type description
userId long the id of the user whose logo you want to get.
Return Value
type description
string the logo filename

getApplicationUrlForUser Operation

Determines the application URL to display.

Input Parameters
name type description
userId long the user's ID.
Return Value
type description
string the application url

getSubCategoriesForUser Operation

List all the Helpdesk SubCategory objects the user is responsible for.

Input Parameters
name type description
userId long  
Return Value
type description
list of subCategory list of SubCategory objects

getPlannersForUser Operation

Input Parameters
name type description
user_id long  
Return Value
type description
list of clientManager  

getApproversForUser Operation

Get all approvers that this user may choose.

Input Parameters
name type description
userid long The user to choose an approver for.
Return Value
type description
list of clientManager A list of all approvers that can take responsibility for this user.

logSsoUsage Operation

Logs the use of an sso link.

Input Parameters
name type description
userId long The unique identifier of the user that the sso linked to.
managerId long The unique identifier of the user that used the link.

getYearToDateAccountManagerProactiveTimeById Operation

Get proactive time entries for a given account manager for the year

Input Parameters
name type description
userId long  
Return Value
type description
list of proactiveTime  

getLastYearAccountManagerProactiveTimeById Operation

Get proactive time entries for a given account manager for last year

Input Parameters
name type description
userId long  
Return Value
type description
list of proactiveTime  

getQuarterAccountManagerProactiveTimeById Operation

Get proactive time entries for a given account manager for the current quarter

Input Parameters
name type description
userId long  
Return Value
type description
list of proactiveTime  

searchAccountManagerProactiveTime Operation

Get proactive time entries for a given account manager for the current quarter

Input Parameters
name type description
searchList searchList  
userId long  
Return Value
type description
list of proactiveTime  

getAccountManagerProactiveTimeGoalsById Operation

Get proactive time entries for a given account manager for the current quarter

Input Parameters
name type description
userId long  
Return Value
type description
proactiveTimeGoals  

sendNewPlannerNotification Operation

Input Parameters
name type description
plannerName string  
plannerEmail string  

sendTravelerAddedToPlannerNotification Operation

Input Parameters
name type description
userName string  
userEmail string  
plannerName string  
plannerEmail string  

sendTravelerRemovedFromPlannerNotification Operation

Input Parameters
name type description
userName string  
userEmail string  
plannerName string  
plannerEmail string  

sendTravelerDeletedNotification Operation

Input Parameters
name type description
userId long  

getSSOPassword Operation

Input Parameters
name type description
userId long  
Return Value
type description
string  

updateUserManagerRecordsByPermission Operation

Input Parameters
name type description
userId long  
Return Value
type description
boolean  

addCompositeManager Operation

Input Parameters
name type description
userId long  
clientId long  
Return Value
type description
boolean  

removeCompositeManager Operation

Input Parameters
name type description
userId long  
clientId long  
Return Value
type description
boolean  

getPlannerGroups Operation

get the planner groups for the user

Input Parameters
name type description
id long  
Return Value
type description
list of clientManager  

getDefaultPlannerGroup Operation

get the default planner group for the user

Input Parameters
name type description
id long  
Return Value
type description
client  

searchUsersSimple Operation

Search the users using a search list.

Input Parameters
name type description
searchList searchList The search list to build a query from.
Return Value
type description
list of simpleUser A list of simple users with basic fields only.

sendTravelersRemovedFromPlannerNotification Operation

Create a helpdesk ticket for planner notifictation for removing a large number of users.

Input Parameters
name type description
userIds list of long  
plannerName string  
plannerEmail string  

getDefaultHelpdeskSupportTeam Operation

Get the default helpdesk support team for the logged in user.

Return Value
type description
supportTeam  

addAgentGroup Operation

Create a new agent group with the given name.

Input Parameters
name type description
name string The name of the agent group to create.
Return Value
type description
agentGroup The updated agent group (verify that it has an id).

getAgentGroup Operation

Get an agent group by id.

Input Parameters
name type description
groupId long The id of the group.
Return Value
type description
agentGroup The agent group referred to by the id.

updateAgentGroup Operation

Update an agent group.

Input Parameters
name type description
group agentGroup The group, with updated fields.
Return Value
type description
agentGroup  

searchAgentGroups Operation

Get a list of agent groups based on a query.

Input Parameters
name type description
searchList searchList The query to find agent groups with.
Return Value
type description
list of agentGroup A list of agent groups referred to by the query.

countAgentGroups Operation

Count a number of agent groups based on a query.

Input Parameters
name type description
searchList searchList The query to count agent groups with.
Return Value
type description
long A list of agent groups referred to by the query.

removeAgentGroup Operation

Remove an agent group by the given id.

Input Parameters
name type description
groupId long The group id to remove.

addAgentToGroup Operation

Add an agent to an agent group.

Input Parameters
name type description
groupId long The group to add the agent to.
agentId long The agent to add the group to.
Return Value
type description
agentGroup The group, with the agent added to it.

removeAgentFromGroup Operation

Remove an agent from an agent group by id. This will not delete the group or the agent, just removes the agent from the group.

Input Parameters
name type description
groupId long The id of the agent group.
agentId long The id of the agent.

getAgentsOfGroup Operation

Get all agents present in an agent group.

Input Parameters
name type description
groupId long The group ID to retrieve agents for.
Return Value
type description
list of user A list of agents present in the agent group.

getEmployersWithTravelProfile Operation

Get all employers that have travel profiles set up.

Input Parameters
name type description
userid long  
Return Value
type description
list of clientMember  

getNonTravelingUsersSimple Operation

Get a list of users who are not currently traveling

Input Parameters
name type description
clientId long  
Return Value
type description
list of simpleUser  

isAuthenticated Operation

Check if the user is authenticated

Return Value
type description
string  

setWelcomeFlag Operation

Should the user be welcomed into airportal?

Input Parameters
name type description
shouldWelcome boolean Flag indicating welcome status
userId long User to set the flag for.
Return Value
type description
boolean Whether the user flag was saved

getUserBySyncId Operation

Get a user by their matching sync id

Input Parameters
name type description
syncId string The sync id to get the user by
Return Value
type description
user The user matching the sync id

getTravelerByProfileName Operation

Get a user using the profile name from the GDS.

Input Parameters
name type description
clientId long The client id to find the user for.
profileName string The name of the user as it appears in the GDS.
Return Value
type description
clientMember  

fulfillUserRequest Operation

Mark a user reuqest as fulfilled

Input Parameters
name type description
requestId long The request id to fulfill
accepted boolean Whether the request was accepted
Return Value
type description
userRequest The fulfilled user request

sendEnrollmentEmail Operation

Send the enrollment instruction email to the specified email addresses

Input Parameters
name type description
emails list of string The emails to send to
clientId long The client to send the email as
Return Value
type description
boolean The result of the email send process

setApproverForUser Operation

Add an approver to a user for the given policy.

Input Parameters
name type description
approverId long The approver for the user.
policyId long The policy we want to approver to apply.
userId long The traveler that needs trips approved.
Return Value
type description
clientManager The client member record of the approver so it can be added to UI elements.

setSiteTour Operation

Input Parameters
name type description
enable boolean  

getSecureLogoutMessageForLoggedInUser Operation

Get the message that should show as the logout message for this user.

Return Value
type description
string The message that should show as the logout message for this user.

getLoginAttemptsByUserId Operation

Gets the failed login attempts for a user

Input Parameters
name type description
userId long the user id
Return Value
type description
loginAttempts the failed login attempts for a user

isUserTraveling Operation

Find out if a user is currently traveling

Input Parameters
name type description
userid long The user id
Return Value
type description
boolean True if they are traveling

getNotificationMethodForUser Operation

Get the notification method for the given user.

Input Parameters
name type description
userid long The user id
Return Value
type description
notificationMethod The NotificationMethod

getRoleSummaryForLoggedInUser Operation

Get summarized information about the currently logged in user.

Return Value
type description
simpleRoleSummary A summarized version of the currently logged in user.

getEnrollmentRequestCount Operation

Input Parameters
name type description
userId long  
Return Value
type description
list of wt0TaskCount  

searchEnrollmentRequests Operation

Search for enrollment requests for airportal logins.

Input Parameters
name type description
searchList searchList A query for enrollment requests.
Return Value
type description
list of userRequest A list of enrollment requests for airportal logins.

countEnrollmentRequests Operation

Count enrollment requests for airportal logins.

Input Parameters
name type description
searchList searchList A query for enrollment requests.
Return Value
type description
long The number of enrollment requests for airportal logins.

searchTravelers Operation

Input Parameters
name type description
searchList searchList  
Return Value
type description
list of simpleUser  

countTravelers Operation

Input Parameters
name type description
searchList searchList  
Return Value
type description
long  

isResponsive Operation

Return Value
type description
boolean  

setResponsive Operation

Input Parameters
name type description
responsive boolean  
Return Value
type description
boolean  

searchIncompleteProfiles Operation

Returns a list of incomplete profiles that isn't completed such as (a) the profiles is yet to be uploaded to the Booking Engines. (b) requested user hasn't completed the initial profile form. (c) still waiting on manager's approval.

Input Parameters
name type description
searchList searchList  
Return Value
type description
list of incompleteProfileGrid list of ProfileLogicPojo Object

searchIncompleteProfilesForLoggedInUser Operation

Returns a list of incomplete profiles for the loggedIn User that isn't completed such as (a) the profiles is yet to be uploaded to the Booking Engines. (b) requested user hasn't completed the initial profile form. (c) still waiting on manager's approval.

Input Parameters
name type description
searchList searchList  
Return Value
type description
list of incompleteProfileGrid list of ProfileLogicPojo Object

countIncompleteProfiles Operation

Returns the count based on the incomplete profiles

Input Parameters
name type description
searchList searchList  
Return Value
type description
long Long

countIncompleteProfilesForLoggedInUser Operation

Returns the count based on the incomplete profiles for loggedIn User

Input Parameters
name type description
searchList searchList  
Return Value
type description
long Long

getWt0IncompleteProfiles Operation

Returns the count based on the incomplete profiles for loggedIn User

Input Parameters
name type description
userId long  
Return Value
type description
list of wt0TaskCount Long

sendProfileCompletionRequest Operation

Send out a request to the traveler asking them to fill out their profile.

Input Parameters
name type description
memberId long The ClientMember ID we want the profile filled out for.

getCallerInfo Operation

This is used by Screen Pop to supply info from our database based on phone number

Input Parameters
name type description
phoneNumber string  
Return Value
type description
callInfo