team_member_list (session, team, with_permissions)

All

SOAP, REST (Since API Version 2.7.31)

Input parameters:

• session: Session token obtained by calling session_init ()

• team: Reference or TEAM CODE of the desired TEAM

• with_permissions: (default = 1) 

  • 0 = don't include member roles

  • 1 = include send member roles

Output parameters:

• result / member_list: XML with information about the member of the TEAM. A member can be a USER or another TEAM

  • teams/team: list of TEAM members with the information of each TEAM

    • ref: reference of the parent TEAM

    • code: TEAM CODE. Introduced in API Version 2.7.19

    • name: Name of the TEAM

    • type: Type of TEAM. See TEAM.CATEGORY CODES

    • active: (true/false) Indicates if the current TEAM is active. Introduced in API Version 2.7.19

    • pictures: images of the TEAM. Introduced in API Version 2.7.19

    • assignments: List of ROLES of the TEAM in the parent TEAM

      • 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

  • users: list of USER members with the information of each USER 

    • ref: reference of the USER

    • gender: (M/F) gender of the USER (Male / Female)

    • name_complete: full name of the USER

    • assignments: List of ROLES of the USER in the parent TEAM

• ErrorMsg: any fault in the call, either in the validation of input parameters, errors in the connection to the database or any other error, this parameter returns the error message produced.

• ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

INVALID_TOKEN

The session token provided is not valid

TEAM.NOT_FOUND

The TEAM was not found