YM REST Services

GroupJoin

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

The following routes are available for this service:
POST	/Ams/{ClientID}/Member/{MemberID}/GroupJoin	Member request to join a group.

**GroupJoin** Parameters:
Name	Parameter	Data Type	Required	Description
GroupID	body	int	No

**MemberBaseSharedDto** Parameters:
Name	Parameter	Data Type	Required	Description
MemberID	form	int	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

**GroupJoinResponse** Parameters:
Name	Parameter	Data Type	Required	Description
GroupType	form	GroupType	No

**GroupType** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
TypeName	form	string	No
SortIndex	form	double?	No
Groups	form	List<Group>	No

**Group** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Status	form	Status?	No
JoinOption	form	JoinOption?	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.

POST /Ams/{ClientID}/Member/{MemberID}/GroupJoin HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	GroupID: 0,
	MemberID: 0,
	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-03T10:55:00.3751284-04:00,
	Device: Desktop
}

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

{
	GroupType: 
	{
		Id: 0,
		TypeName: String,
		SortIndex: 0,
		Groups: 
		[
			{
				Id: 0,
				Name: String,
				Status: None,
				JoinOption: CanJoin
			}
		]
	},
	GroupID: 0,
	MemberID: 0,
	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-03T10:55:00.4006359-04:00,
	Device: Desktop
}