subscription_member_list ( session, program, [team], [subscription] )

All

SOAP, REST (Since API Version 2.7.23)

Input parameters

• session: is the session token obtained in the session_init() call

• program: PROGRAM reference. This field is ignored if a specific SUBSCRIPTION reference is passed in parameter subscription. This value is used along with the team parameter to locate the SUBSCRIPTION

• team: Reference of the SUBSCRIPTION’s owner TEAM. This field is ignored if a specific SUBSCRIPTION reference is passed in parameter subscription. This value is used along with the program parameter to locate the SUBSCRIPTION. If not provided, the active SESSION’s TEAM will be assumed.

• subscription: reference to the SUBSCRIPTION from which the member will be detached. If not provided, then the SUBSCRIPTION will be determined by the combination of program and team.

• subscription: team and program parameter can be avoid, but in this case, the parameter subscription must be filled.

Output parameters

• result: XML with the following structure

  • editable: (true/false) indicates whether the session's user can edit the members of the SUBSCRIPTION members. The member list is editable if the active USER has role TEAM_MANAGER in the TEAM owner of the SUBSCRIPTION

  • inherit_owner_users: (true/false) Indicates whether the PROFESSIONAL members of the SUBSCRIPTION are inherited from the TEAM owner of the SUBSCRIPTION or are assigned manually. If true, then the members of the SUBSCRIPTION are considered to be the members of the TEAM owner with their corresponding ROLES. Introduced in API Version 2.7.27

  • inherit_owner_teams: (true/false) Indicates whether the TEAM members of the SUBSCRIPTION are inherited from the TEAM owner of the SUBSCRIPTION or are assigned manually. If true, then the members of the SUBSCRIPTION are considered to be the members of the TEAM owner with their corresponding ROLES. Introduced in API Version 2.7.27

  • 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

    • 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