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 .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Relationships: 
	[
		{
			RelationshipTag: String,
			Groups: 
			[
				{
					GroupID: 0,
					Code: String,
					Name: String,
					Title: String,
					Primary: False
				}
			]
		}
	],
	ID: 0,
	UsingRedis: True,
	AppInitTime: 2024-05-03T04:12:11.8641083-04:00,
	ServerID: WS-5-221-763,
	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: 2024-05-03T05:22:50.8491815-04:00,
	Device: Desktop
}