YM REST Services

MembershipRenewalReminderGetRequest

Get the Membership Renewal Reminder details

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

The following routes are available for this service:
GET	/Ams/{ClientID}/MembershipRenewalReminder/{id}	Return a Membership Renewal Reminders Details for given Membership Id.

**MembershipRenewalReminderGetRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	int	No	Membership Id

**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

**MembershipRenewalReminderGetResponse** Parameters:
Name	Parameter	Data Type	Required	Description
membershipRenewalReminder	form	MembershipRenewalReminder	No

**MembershipRenewalReminder** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	Membership Id
AdvanceRenewalReminder	form	List<AdvanceRenewalReminder>	No	Advance Renewal Reminder configuration for Reminder 1 , 2 and 3
AdvanceMembershipRenewalDays	form	int?	No	How many days in advance can memberships be renewed?
UseCustomLastDayExpireNotification	form	bool?	No	Use custom reminder email content for last day renewal reminder
UseCustomPostExpireNotication	form	bool?	No	Use custom reminder email content for post expiration renewal reminder
CustomLastDaySubject	form	string	No	Custom subject for last day renewal reminder
CustomLastDayNotificationBody	form	string	No	Custom message for last day renewal reminder
CustomPostExpireSubject	form	string	No	Custom subject for post expiration renewal reminder
CustomPostExpireNotificationBody	form	string	No	Custom message for post expiration renewal reminder
MembershipName	form	string	No	Membership name
PostExpireMembershipRenewalDays	form	int?	No	How many days after should a reminder be sent?
SendPostExpireMembershipReminder	form	bool?	No	Send a reminder via email for post expiration renewal reminder
SendLastDayExpireMembershipReminder	form	bool?	No	Send a reminder via email for last day renewal reminder

**AdvanceRenewalReminder** Parameters:
Name	Parameter	Data Type	Required	Description
ReminderType	form	int	No	Type of advance renewal reminder
SendMembershipReminder	form	bool?	No	Send a reminder via email for advanced renewal reminder
AdvanceMembershipRenewalReminderDays	form	int?	No	How many days in advance should a reminder be sent?
UseCustomPreExpireNotification	form	bool?	No	Use custom reminder email content for advanced renewal reminder
CustomPreExpireSubject	form	string	No	Custom subject for advanced renewal reminder
CustomPreExpireNotificationBody	form	string	No	Custom message for advanced renewal reminder

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}/MembershipRenewalReminder/{id} HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

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

{
	membershipRenewalReminder: 
	{
		Id: 0,
		AdvanceRenewalReminder: 
		[
			{
				ReminderType: 0,
				SendMembershipReminder: False,
				AdvanceMembershipRenewalReminderDays: 0,
				UseCustomPreExpireNotification: False,
				CustomPreExpireSubject: String,
				CustomPreExpireNotificationBody: String
			}
		],
		AdvanceMembershipRenewalDays: 0,
		UseCustomLastDayExpireNotification: False,
		UseCustomPostExpireNotication: False,
		CustomLastDaySubject: String,
		CustomLastDayNotificationBody: String,
		CustomPostExpireSubject: String,
		CustomPostExpireNotificationBody: String,
		MembershipName: String,
		PostExpireMembershipRenewalDays: 0,
		SendPostExpireMembershipReminder: False,
		SendLastDayExpireMembershipReminder: False
	},
	Id: 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: 2025-01-15T08:33:21.9939289-05:00,
	Device: Desktop
}