get group memberdetails
/members/{member}/groups/{group}/memberdetails [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.5912 | 5.9500 | xml, json |
Description
Get a group’s member details.
This service is used when a member does not belong to a group but wishes to join it. It returns the member detail fields (if defined for the group) that the member needs to enter when joining.
It also returns values that have been entered before by the member, if they joined previously or the details are configured to be shared across groups.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| role | If equal to manager, display all the group-specific fields for member (group manager only) | no | string |
Permission
Only the member matching the request or an administrator can invoke this service, unless parameter role=manager.
The member does not require a membership to the specified group unless the role=manager is used and they are not an administrator. In that case, the member must be a manager or higher of the group.
Response
The returned XML is as follows:
<details>
<field position="1"
name="[name]"
editable="[true|false]"
visibility="[group|member|manager]"
[title="[title]"]
[type="[type]"]>[value]</field>
...
</details>Or in JSON:
[
{
"position": number,
"name": string,
"editable": boolean,
"title": string,
"type": string,
"visibility": string,
"value": string
}
]
Error Handling
| Code | Cause / Description |
|---|---|
| 0x1108 | If the group is invalid |
| 0x102A | If the member not found |