YM REST Services

PeopleGroups

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin

The following routes are available for this service:
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.

**PeopleGroups** Parameters:
Name	Parameter	Data Type	Required	Description
ID	query	int	No

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**PeopleGroupsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Relationships	form	List<Relationship>	No

**Relationship** Parameters:
Name	Parameter	Data Type	Required	Description
RelationshipTag	form	string	No
Groups	form	List<PeopleGroup>	No

**PeopleGroup** Parameters:
Name	Parameter	Data Type	Required
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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:19:52.0939746-05:00","ServerID":"WS-6-56-398","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:50:34.4740555-05:00","Device":"Desktop"}