Roles

The Role API is closely associated with the User API, and defines the roles assigned to users when they are created. Roles can be grouped together to create collections of roles, which can then be used to control which functions the user can perform.


Typical workflow

 

Use Case

Roles in TalentLink can be grouped together based on the user function that they control. These groups, or collections of Roles, can then be assigned to new users when they are automatically created in TalentLink.

Pre-condition - The user is created in TalentLink.

Scenario

  1. START. All Roles in TalentLink available to the new user are listed.
  2. Roles are assigned "tags" to create groups of Roles (user profile templates).
  3. All Roles in a user profile template are assigned to the new user. END.

Response Format

XML

SOAP METHODS

The addTagToRole method adds a tag name and tag type to a specific role by using the role ID

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
roleId
Long
[mandatory] The ID of the role
tagName
String
[mandatory] Is the name for the tag for example: 'Reporter'
tagTypeName
String
[mandatory] Client Name(User Function)

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
The method getAccountRoles returns list of all roles with ACCOUNT type.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
role
Collection
Consists of Role ID, tag values and date
  id
Long
Id of the role
  name
String
Name of the role assigned to
  type
String
Type of current role for example (HIRING MANAGER, RECRUITER, BASIC ACCESS.. etc)
  updateDate
Date
Last update date
  tags
List
List of tags assigned to role
    tag
BasicTagDto
Tag assigned to role
      labelKey
String
[optional] Tag label
      name
String
Tag name
      type
TagTypeDto
Tag type
        labelKey
String
[optional] Tag type label
        name
String
Tag type name
The getAllRoles method returns list of all roles.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
role
Collection
Consists of Role ID, tag values and date
  id
Long
Id of the role
  name
String
Name of the role assigned to
  type
String
Type of current role for example (HIRING MANAGER, RECRUITER, BASIC ACCESS.. etc)
  updateDate
Date
Last update date
  tags
List
List of tags assigned to role
    tag
BasicTagDto
Tag assigned to role
      labelKey
String
[optional] Tag label
      name
String
Tag name
      type
TagTypeDto
Tag type
        labelKey
String
[optional] Tag type label
        name
String
Tag type name
The method getRolesForDepartment returns list of roles accessible for the current user in the provided department. Roles are filtered by the maximum role class for current user.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
dptId
Long
Lumesse ID Org department

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
role
Collection
Consists of Role ID, tag values and date
  id
Long
Id of the role
  name
String
Name of the role assigned to
  type
String
Type of current role for example (HIRING MANAGER, RECRUITER, BASIC ACCESS.. etc)
  updateDate
Date
Last update date
  tags
List
List of tags assigned to role
    tag
BasicTagDto
Tag assigned to role
      labelKey
String
[optional] Tag label
      name
String
Tag name
      type
TagTypeDto
Tag type
        labelKey
String
[optional] Tag type label
        name
String
Tag type name
The method getTaggedRoles returns a collection of all roles marked with a given Tag.

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
tagName
String
[mandatory] Is the name for the tag for example: 'Reporter'
tagTypeName
String
[mandatory] Client Name(User Function)

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
role
Collection
Consists of Role ID, tag values and date
  id
Long
Id of the role
  name
String
Name of the role assigned to
  type
String
Type of current role for example (HIRING MANAGER, RECRUITER, BASIC ACCESS.. etc)
  updateDate
Date
Last update date
  tags
List
List of tags assigned to role
    tag
BasicTagDto
Tag assigned to role
      labelKey
String
[optional] Tag label
      name
String
Tag name
      type
TagTypeDto
Tag type
        labelKey
String
[optional] Tag type label
        name
String
Tag type name
The removeTagFromRole method removes a Tag from a role

This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
roleId
Long
[mandatory] The ID of the role
tagName
String
[mandatory] Is the name for the tag for example: 'Reporter'
tagTypeName
String
[mandatory] Client Name(User Function)

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void