Customer Engagement User Services, Version 4.0

74 Customer Engagement User Services, Version 4.0

This chapter provides the information necessary to send messages contained in Version 4.0 of the Customer Engagement User Services API. Information can be obtained using the Web Service Description Language (WSDL) in conjunction with a Simple Object Access Protocol (SOAP), XML Schema, and various methods contained in the classes of the API to provide the web service described above.

The URL for the WSDL is:

https://<servername>:<portNumber>/ws/v4_0/RelateUserServices?wsdl

where <servername> is the name or address of the server. For a cloud installation, the default port number is 443.

The information presented below describes the methods and classes.

The format of the method and any arguments is shown along with an explanation of what the method does and any other information that is necessary to use the method properly. If an argument is shown in dark blue, it is a class and the class name is a link to a description of the class and its attributes.

The class section shows the attributes of the classes along with an explanation of each attribute and when necessary, when they are used.

Note:

Authentication is required. See Introduction for information on creating and implementing an authentication key.

Methods

This section presents the methods used in Version 4.0 of the User Services API.

getUserDetail

UserFranchiseeResponseType[] getRelateUserDetail(              string userId,              string securityUserId)     throws RelateProcessingException

Variable	Required?	Description
`criterias`	required	Array of search criteria.
`securityUserId`	required	ID of the Customer Engagement user performing the search.

The UserDetail method retrieves detail for a user based on user ID.

This method returns a UserFranchiseeResponseType element.

getUserList

UserType[] getRelateUserList(              UserSearchCriteriaType[] criterias,              string securityUserId)     throws RelateProcessingException

Variable	Required?	Description
`criterias`	required	Array of search criteria.
`securityUserId`	required	ID of the Customer Engagement user performing the search.

The UserList method performs a search for users matching certain, defined criteria.

This method returns an array of RelateUserType elements.

getRelateUsersFranchisee

UserFranchiseeResponseType getRelateUsersFranchisee(                                                      string userId,                                                      string securityUserId)     throws RelateProcessingException

Variable	Required?	Description
`criterias`	required	Array of search criteria.
`securityUserId`	required	ID of the Customer Engagement user performing the search.

The getRelateUsersFranchisee method retrieves the franchisee(s) with which a user is associated.

This method returns a UserFranchiseeResponseType element.

Classes

This section presents the classes used in Version 4.0 of the User Services API.

Exeception

See Introduction.

RelateProcessingException

For a description of this class, see Introduction.

UserSearchCriteriaType

The RelateUserSearchCriteriaType class contains the following elements:

Type	Element	Description
string	fieldValue	Value on which to search.
VelocityPeriodType	searchFieldType	Type of data in which to perform the search.
SearchOperatorType	searchOperator	Search operator used in the search.

UserType

The RelateUserType class contains the following elements:

Type	Element	Description
string	userId	ID of the user.
string	name	System name of the user.
string	email	Email address for the user.
string	language	ID code for the user’s language preference.
string	locationId	ID of the user’s location.
string	dataSecurityGroup	Security group to which the user belongs.
string	firstName	User’s first name.
string	lastName	User’s last name.
string	middleName	User’s middle name.
string	title	User’s title.
string	manager.Id	User ID of the user’s manager.
string	countryCode	Country code assigned to the user.
boolean	enabledFlag	Indicates if the requested user is currently enabled.
boolean	managerFlag	Indicates if the requested user is a manager.

UserFranchiseeContainerReturnType

The UserFranchiseeContainerReturnType class contains the following elements:

Type	Element	Description
UserFranchiseeReturnType[]	franchisee	Array of franchisees.

UserFranchiseeResponseType

The UserFranchiseeResponseType class contains the following elements:

Type	Element	Description
string	userId	ID of the user associated with the franchisees.
string	name	System name of the user.
string	email	Email address for the user.
string	language	ID code for the user's language preference.
string	locationId	ID of the user's location.
string	DataSecurityGroup	Security group to which the user belongs.
string	firstName	User's first name.
string	lastName	User's last name.
string	middleName	User's middle name.
string	title	User's title.
string	managerId	User ID of the user's manager.
string	countryCode	Country code assigned to the user.
boolean	enabledFlag	Indicates if the requested user is currently enabled.
boolean	managerFlag	Indicates if the requested user is a manager.
UserFranchiseeContainerReturnType	franchisees	Franchisees associated with the user.

UserFranchiseeReturnType

The UserFranchiseeReturnType class contains the following elements:

Type	Element	Description
long	franchiseeId	ID of the franchisee.
string	franchiseeName	Name of the franchisee.