The UM_GetUserDetailsExtended web service allows you to search for users by a limited number of user profile fields, or any combination of these fields.
Using the Service
Before using the service, consider the following:
All fields perform an exact-match search.
No wild cards are allowed in any search field.
If you search with multiple criteria, the search is treated as an "AND" search.
Returns a maximum of 500 users in any given search.
The available search fields include:
Username
Email
Last Name
First Name
OrgCode
Note: If OrgCode is used, only users within the specific group are included in the results. Users in sub-groups are not included.
Inputs
URL Parameter
Required
Description
customerId
Enter the sname for the company.
username
Enter the username of the user you are searching for.
email
Enter the email address of the user you are searching for.
firstName
Enter the first name of the user you are searching for.
lastName
Enter the last name of the user you are searching for.
orgCode
Enter the orgcode of the User Group to which the user or users belong. The orgCode field uses an an exact match search and only users within the specific group are included in the results. Users in sub-groups are not included.
Success Response(s)
XML response (restype=1):
Output
UM_GetUserDetailsExtended returns one or more user records with username as the unique identifier.
User Attributes
The User element contains optional metadata attributes that describe non-user profile field characteristics. These attributes, and their possible values include:
Activated - indicates whether or not the user's account is active
true or false
userRole - returns the user's role in Skillport
END_USER
MANAGER
ADMIN
COMPANY_ADMIN
SUPER_ADMIN
isCustomUser - indicates if the user’s privileges have been customized
true or false
selfReg - indicates if the user self registered for Skillport
true or false
regDate - displays the date and time the user registered, formatted as:
YYYY-MM-DD HH:MM:SS ZZZ
siteLanguage - displays the user's site language preference
searchLanguage - displays the user's search language preference
Group Attributes
The User element includes a child element for each user group to which the member belongs. These UserGroup elements include the following attributes:
id - the unique ID for the group
title - title of the group
orgCode - organizational code for the group
type - type of group; values include:
NORMAL
fullPath - the hierarchical structure of the group from this group up to the root group
Profile Fields
Profile field elements include all core fields and all enabled custom fields. Attributes for ProfileField elements include:
id - unique id for the profile field; core fields begin with "_sys_"
name - the name, or label for the field
type - indicates the data type for the field; values include
text
integer
date
boolean
selection
enabled - applies to custom profile fields; only enabled fields display
Result