YM REST Services

MembersGroups

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

The following routes are available for this service:
GET	/Ams/{ClientID}/MembersGroups	Members Groups lookup - with cache.	Return members' groups.

**MembersGroups** Parameters:
Name	Parameter	Data Type	Required
Timestamp	query	DateTime?	No
PageSize	query	int	No
PageNumber	query	int	No
OffSet	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

**MembersGroupsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
MembersGroupsList	form	List<MembersGroupData>	No

**MembersGroupData** Parameters:
Name	Parameter	Data Type	Required
WebSiteMemberID	form	int	No
GroupCode	form	string	No
GroupName	form	string	No
PrimaryGroup	form	bool	No
GroupID	form	int	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}/MembersGroups HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

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

{
	MembersGroupsList: 
	[
		{
			WebSiteMemberID: 0,
			GroupCode: String,
			GroupName: String,
			PrimaryGroup: False,
			GroupID: 0
		}
	],
	Timestamp: 0001-01-01,
	PageSize: 0,
	PageNumber: 0,
	OffSet: 0,
	UsingRedis: True,
	AppInitTime: 2024-05-03T02:46:08.6976410-04:00,
	ServerID: WS-4-7-585,
	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-03T03:33:07.2059572-04:00,
	Device: Desktop
}