Function prototype	team_member_role_list ( session, [team], [member] )
API Version	All
Supported interfaces	SOAP, REST (Since API Version 2.7.31)

Description

Returns the list of ROLES that can be assigned to the members of a TEAM

The ROLES returned by this function can be used in other API functions like team_member_set ( session, team_member ) to assign ROLES to the member of a TEAM

Input parameters:

session: a token obtained from a session_init () call
team: Reference or TEAM CODE of the parent TEAM (where the member is assigned). Depending on the type of parent TEAM, some ROLES may be prohibited
member: reference of the USER or TEAM to which we want to assign the ROLES as a member of the parent TEAM. To differentiate between a USER or a TEAM, the reference must be built as the concatenation of the word “USER” or “TEAM” and the reference of the member, separated by a pipe (“|”) character. Example: “USER|2332”

Output parameters:

result/role_list: XML with the list of ROLES. Each ROLE contains:
- role: Information about each ROLE
  - ref: Reference of the ROLE (e.g. 24 = CASE MANAGER)
  - name: Description of the ROLE in the active SESSION language
  - profiles/profile: list of profiles. Some ROLES have a sub-classification in "profiles" (sub-roles). For example, roles "Team Manager" and "Program Manager" are considered profiles of the parent ROLE “Admin”. See ROLE OBJECT.
    - ref: Reference of the ROLE (e.g. 24 = CASE MANAGER)
    - name: Description of the ROLE in the active SESSION language
ErrorMsg: If any error occurs, then this value contains a description of the error translated to the current language
ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

Request example

team_member_role_list(“LCAAAAAAAAAAAA”, 1, "USER|23222")

The response format is XML when the function has been invoked via the SOAP API, and JSON when it has been invoked via the REST API

ERROR CODE

ERROR CODE
INVALID_TOKEN	The session token provided is not valid