YM REST Services

Groups

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

The following routes are available for this service:
GET	/Ams/{ClientID}/Groups	Return a list of Groups for a Client.
POST	/Ams/{ClientID}/Groups	Create a Group and return the newly created GroupID.
PUT	/Ams/{ClientID}/Groups	Update an existing Group.	Omitted fields will be ignored.

**Groups** Parameters:
Name	Parameter	Data Type	Required
GroupID	body	int?	No
GroupCode	body	string	No
TypeID	body	int?	No
Name	body	string	No
Active	body	bool?	No
Hidden	body	bool?	No
Accessibility	body	int?	No
Membership	body	int?	No
Messaging	body	int?	No
SendNewsletter	body	bool?	No
EnableFeed	body	bool?	No
AdminCanExportMembers	body	bool?	No
PhotoApproval	body	bool?	No
EmailOptionsAdmin	body	int?	No
EmailOptionsMember	body	int?	No
ShortDescription	body	string	No
WelcomeContent	body	string	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

**GroupsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
GroupTypeList	form	List<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}/Groups HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	GroupID: 0,
	GroupCode: String,
	TypeID: 0,
	Name: String,
	Active: False,
	Hidden: False,
	Accessibility: 0,
	Membership: 0,
	Messaging: 0,
	SendNewsletter: False,
	EnableFeed: False,
	AdminCanExportMembers: False,
	PhotoApproval: False,
	EmailOptionsAdmin: 0,
	EmailOptionsMember: 0,
	ShortDescription: String,
	WelcomeContent: String,
	UsingRedis: True,
	AppInitTime: 2024-05-03T10:15:45.4274162-04:00,
	ServerID: WS-5-156-355,
	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:39:46.7277095-04:00,
	Device: Desktop
}

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

{
	GroupTypeList: 
	[
		{
			Id: 0,
			TypeName: String,
			SortIndex: 0,
			Groups: 
			[
				{
					Id: 0,
					Name: String,
					Status: None,
					JoinOption: CanJoin
				}
			]
		}
	],
	GroupID: 0,
	GroupCode: String,
	TypeID: 0,
	Name: String,
	Active: False,
	Hidden: False,
	Accessibility: 0,
	Membership: 0,
	Messaging: 0,
	SendNewsletter: False,
	EnableFeed: False,
	AdminCanExportMembers: False,
	PhotoApproval: False,
	EmailOptionsAdmin: 0,
	EmailOptionsMember: 0,
	ShortDescription: String,
	WelcomeContent: String,
	UsingRedis: True,
	AppInitTime: 2024-05-03T10:15:45.4274162-04:00,
	ServerID: WS-5-156-355,
	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:39:46.7436917-04:00,
	Device: Desktop
}