YM REST Services

MembershipPromoCodes

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

The following routes are available for this service:
PUT	/Ams/{ClientID}/MembershipPromoCodes	Validates a Membership Promo Code.
GET	/Ams/{ClientID}/MembershipPromoCodes/{MembershipID}/{MemberID}	Return a list of valid membership promo codes for the given Member
GET	/Ams/{ClientID}/MembershipPromoCodes/{MembershipID}/	Return a list of membership promo codes for the given Membership

**MembershipPromoCodes** Parameters:
Name	Parameter	Data Type	Required
MembershipID	path	int	No
MemberID	path	int	No
PromoCode	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

**MembershipPromoCodesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
MembershipPromoCodeList	form	List<MembershipPromoCode>	No

**MembershipPromoCode** Parameters:
Name	Parameter	Data Type	Required
FriendlyName	form	string	No
FlatDiscount	form	double?	No
PercentDiscount	form	double?	No

**PromoCodeBase** Parameters:
Name	Parameter	Data Type	Required
PromoCodeID	form	int?	No
ClientID	form	int	No
PromoCode	form	string	No
Expires	form	DateTime?	No
GLCode	form	string	No
QBClass	form	string	No
Start	form	DateTime?	No
UsageLimit	form	int	No
UsageOnePerUser	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.

PUT /Ams/{ClientID}/MembershipPromoCodes HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	MembershipID: 0,
	MemberID: 0,
	PromoCode: String,
	UsingRedis: True,
	AppInitTime: 2024-05-02T22:24:34.1976649-04:00,
	ServerID: WS-6-183-431,
	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-03T00:49:09.4762380-04:00,
	Device: Desktop
}

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

{
	MembershipPromoCodeList: 
	[
		{
			FriendlyName: String,
			FlatDiscount: 0,
			PercentDiscount: 0,
			PromoCodeID: 0,
			ClientID: 0,
			PromoCode: String,
			Expires: 0001-01-01,
			GLCode: String,
			QBClass: String,
			Start: 0001-01-01,
			UsageLimit: 0,
			UsageOnePerUser: False
		}
	],
	MembershipID: 0,
	MemberID: 0,
	PromoCode: String,
	UsingRedis: True,
	AppInitTime: 2024-05-02T22:24:34.1976649-04:00,
	ServerID: WS-6-183-431,
	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-03T00:49:09.4918330-04:00,
	Device: Desktop
}