EmployeeProvider Service

An API to interact with the EmployeeInfo object.

Namespace
http://inside.service.cbtweb.cbt.com/
WSDL
inside.wsdl
Path
/EmployeeProviderService

getEmployeeInfoFromAgentSine Operation

A function we can use to get the EmployeeInfo from the PCC and agent sine.

Input Parameters
name type description
pcc string The pcc the employee should be in.
branch string The branch that the agent books as.
agentSine string The agent sine the employee books as.
gdsId long The GDS that the agent is working in.
Return Value
type description
employeeInfo The EmployeeInfo from the pcc and agent code.

updateEmployee Operation

A function to update or create Employees.

Input Parameters
name type description
record employeeInfo A zombie (unsessioned) employee object that holds data to create an employee within the database.
Return Value
type description
employeeInfo A Employees object that was updated.

deleteEmployee Operation

Deletes an employee from the database.

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

getEmployeesByOfficeId Operation

Input Parameters
name type description
officeId long  
Return Value
type description
list of employeeInfo  

getEmployeeInfoById Operation

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

searchEmployees Operation

Get a list of agent information based on a search criteria.

Input Parameters
name type description
searchList searchList Search criteria to search by.
Return Value
type description
list of employeeInfo A list of agent information based on a search criteria.

searchEmployeesForRecheck Operation

Get a list of agent information which is set to recheck.

Return Value
type description
list of employeeInfo A list of agent information.

searchSimpleAgents Operation

Get a list of agent information based on a search criteria.

Input Parameters
name type description
searchList searchList Query to search for agents by.
Return Value
type description
list of simpleAgent A list of agent information based on a search criteria.

countSimpleAgents Operation

Get a count of agents based on a search criteria.

Input Parameters
name type description
searchList searchList Query to count agents by.
Return Value
type description
long A count of agents based on a search criteria.

countEmployees Operation

Count the number of agents based on a search criteria.

Input Parameters
name type description
searchList searchList Search criteria to search by.
Return Value
type description
long The number of agents based on a search criteria.

getEmployeeInfoForUser Operation

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

getAdvisorProfiles Operation

Search for advisor profiles.

Input Parameters
name type description
search searchList A search object describing a query for profiles.
Return Value
type description
list of simpleAdvisor A list of advisor profiles.

getAdvisorProfileForUser Operation

Get The pending profile record for the user by user id.

Input Parameters
name type description
id long The user id to get a profile for.
Return Value
type description
advisorProfile The advisor profile for that particular user.

updateAdvisorProfile Operation

Updates a User's pending advisor profile. If the user doesn't have a Pending profile, one will be created for them.

Input Parameters
name type description
profile advisorProfile A profile that will become pending until it is approved.
Return Value
type description
advisorProfile A pending profile

deleteAdvisorProfile Operation

Delete both the active and pending profiles.

Input Parameters
name type description
id long The id of the user whose profiles you want to delete.
Return Value
type description
boolean true / false if the deletion was successful.

updateAdvisorSchedules Operation

This method has been deprecated.

Updates an advisors schedule list

Input Parameters
name type description
id long the advisor id
schedules list of advisorSchedule schedules to be changed
Return Value
type description
list of advisorSchedule  

createAdvisorIfNull Operation

creates an entry in the advisor tabel for a user if they are not already and advisor.

Input Parameters
name type description
userId long the id for the potential advisor we are checking.
Return Value
type description
advisorProfile  

getAdvisorProfilesBySubCategoryId Operation

Grabs all advisorProfiles for users in the group assigned to a subcategory.

Input Parameters
name type description
subCategoryId long the id of the subcategory
Return Value
type description
list of advisorProfile  

getAdvisorById Operation

Grabs and advisor by an advisor id

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

getAllEmployeeLocations Operation

Return Value
type description
list of city  

getAllAdvisorDepartments Operation

Return Value
type description
list of advisorDepartment  

getAdvisorInterestsById Operation

Gets interests of an advisor

Input Parameters
name type description
id long the User id
Return Value
type description
list of advisorInterest  

getAdvisorDestinationsById Operation

Gets Destinations of an advisor

Input Parameters
name type description
id long the User id
Return Value
type description
list of advisorDestination  

getAdvisorVisitedById Operation

Gets Visited of an advisor

Input Parameters
name type description
id long the User id
Return Value
type description
list of advisorDestination  

setAdvisorInterestsById Operation

Input Parameters
name type description
id long  
interests list of advisorInterest  
Return Value
type description
list of advisorInterest  

setAdvisorDestinationsById Operation

Input Parameters
name type description
id long  
destinations list of advisorDestination  
Return Value
type description
list of advisorDestination  

setAdvisorVisitedById Operation

Input Parameters
name type description
id long  
visited list of advisorDestination  
Return Value
type description
list of advisorDestination  

getAllAdvisorBanners Operation

Get a list of all of the banners

Return Value
type description
list of advisorBanner  

getAdvisorScheduleByUserId Operation

gets the schedule that is used in the employee directory.

Input Parameters
name type description
id long the user id
Return Value
type description
list of advisorSchedule  

updateAdvisorTestimonialsById Operation

Override the advisor's current list of testimonials with the ones passed in.

Input Parameters
name type description
id long advisor id
testimonials list of advisorTestimonial  
Return Value
type description
list of advisorTestimonial  

approveConsultantProfile Operation

Approve the pending advisor profile and make it the One True Profile. Delete all other profiles for the user.

Input Parameters
name type description
id long the ID of the profile we'll be approving
Return Value
type description
advisorProfile  

updateEmployeeProfile Operation

A lightweight updater used strictly by the employee profile piece to make updating less overhead intensive.

Input Parameters
name type description
profile employeeDirectoryProfile the employee profile to be updated.
Return Value
type description
employeeDirectoryProfile the updated employee profile.

getEmployeeProfileById Operation

get a users employee profile by profile id.

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

getEmployeeProfileForUser Operation

Get the employee directory profile for a user.

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

deleteEmployeeDirectoryProfile Operation

delete any employee directory profile(s) for a user.

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

getMidOfficeAgentDetails Operation

Endpoint to retrieve all data about agents that a system would need to issue tickets as them.

Input Parameters
name type description
pcc string The pcc the employee should be in.
branch string The branch that the agent books as.
agentSine string The agent sine the employee books as.
gds string The gds the agent is in. Valid values are 1P,1W,1V
accountnumber string The account number that the agent is servicing.
Return Value
type description
midofficeAgentDetail  

isMidofficeAgent Operation

Endpoint to determine if an agent exists or not.

Input Parameters
name type description
pcc string THe pcc the employee should be in.
branch string The branch that the agent books as.
agentSine string The agent sine the employee uses.
gds string The gds the agent is in. Valid values are 1P,1W,1V.
Return Value
type description
boolean true / false if this agent exists

makeAdvisorProfilesJson Operation

Return Value
type description
boolean  

andavoAdminSearchProfiles Operation

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

andavoAdminCountProfiles Operation

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

deleteConsultantProfile Operation

Delete an AdvisorProfile by id

Input Parameters
name type description
id long The id of the AdvisorProfile to delete