| Requires any of the roles: | admin, oauthadmin |
| GET | /Ams/{ClientID}/PeopleGroups | Returns a person's group relationship data. | There are three types of relationships that members may have with particular groups; 'Administrator', 'Member' and 'Representative'. Groups are listed within nodes respective of their relationship type. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ID | query | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UsingRedis | form | bool | No | |
| AppInitTime | form | DateTime | No | |
| ServerID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Relationships | form | List<Relationship> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RelationshipTag | form | string | No | |
| Groups | form | List<PeopleGroup> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GroupID | form | int | No | |
| Code | form | string | No | |
| Name | form | string | No | |
| Title | form | string | No | |
| Primary | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Ams/{ClientID}/PeopleGroups HTTP/1.1
Host: ws.yourmembership.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Relationships":[{"RelationshipTag":"String","Groups":[{"GroupID":0,"Code":"String","Name":"String","Title":"String","Primary":false}]}],"ID":0,"UsingRedis":true,"AppInitTime":"2025-01-15T08:45:31.6245802-05:00","ServerID":"WS-4-27-804","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2025-01-15T08:57:38.1479275-05:00","Device":"Desktop"}