YM REST Services

MembershipModifiers

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

The following routes are available for this service:
GET	/Ams/{ClientID}/MembershipModifiers/{MembershipID}	Return a list of membership modifiers for the given membership ID.

**MembershipModifiers** Parameters:
Name	Parameter	Data Type	Required	Description
MembershipID	path	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

**MembershipModifiersResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ModifierList	form	List<MembershipModifier>	No

**MembershipModifier** Parameters:
Name	Parameter	Data Type	Required
ID	form	int	No
Name	form	string	No
AdjustedName	form	string	No
Description	form	string	No
Amount	form	double	No
AdjustedAmount	form	double	No
Required	form	bool	No
Factored	form	bool	No
MinFactor	form	double	No
MaxFactor	form	double	No
Factor	form	double	No
AllowProRate	form	bool	No
CategoryID	form	int	No
CategoryName	form	string	No
Selected	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}/MembershipModifiers/{MembershipID} HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

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

{
	ModifierList: 
	[
		{
			ID: 0,
			Name: String,
			AdjustedName: String,
			Description: String,
			Amount: 0,
			AdjustedAmount: 0,
			Required: False,
			Factored: False,
			MinFactor: 0,
			MaxFactor: 9999999999,
			Factor: 0,
			AllowProRate: False,
			CategoryID: 0,
			CategoryName: String,
			Selected: False
		}
	],
	MembershipID: 0,
	UsingRedis: True,
	AppInitTime: 2024-05-03T09:24:49.0490081-04:00,
	ServerID: WS-4-69-031,
	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-03T09:47:09.6174017-04:00,
	Device: Desktop
}