membership
/groups/{group}/members/{member} [GET]
API Support | Available since | Last updated | Output |
---|---|---|---|
4.8000 | 5.9500 | xml, json |
Description
Returns the group details for a member.
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
role | If equal to manager , display all details fields (group manager only) | no | string | |
subgroups | If subgroups should be included in the response | no | boolean | true |
subgroups
This parameter is used as a flag to specify if subgroup membership is to be considered. The possible values are true
and false
and the default value is true
.
Permission
Only the member herself or an administrator can invoke this service. If parameter role=manager
then a manager of the group is also allowed.
Response
If the member belongs to the group, the membership is returned as <membership> element enclosing the <member>
, <group>/<project>
and if applicable the <details>
elements.
<membership id="[membership id]" email-listed="[true|false]" notification="[none|immediate|daily]" flags="[flags]" status="[normal| invited| self-invited| disabled]" role="[role]" [subgroups="[subgroups]"]> <member id="[member id]" firstname="[first name]" surname="[surname]" username="[username]" status="[activated|unactivated]"> <fullname>[full name]</fullname> </member> <group|project id="[group id]" name="[group name]" description="[description]" owner="[owner]" [relatedurl="[url]"] /> <details> <field position="1" name="[field name]" editable="[true|false]" [title="[field title]"] [type="[field type]"]>[field value] </field> ... </details> </membership>
Error Handling
Code | Cause / Description |
---|---|
0x0106 | Unable to find matching member |
0x0107 | Unable to find matching group |
0x1022 | If the member specified does not belong to the group specified |
0x6004 | If the member details have not been configured properly |