YM REST Services

<back to all web services

SendTestNotification

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
POST/Ams/{ClientID}/Notification/{NotificationID}/SendTestSend the Test Email Notification.
SendTestNotification Parameters:
NameParameterData TypeRequiredDescription
NotificationIDpathstringNo
NotificationBodybodystringNo
NotificationSubjectbodystringNo
NotificationNamebodystringNo
NotificationFrombodystringNo
NotificationTobodystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
SendTestNotificationResponse Parameters:
NameParameterData TypeRequiredDescription
successformboolNo

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}/Notification/{NotificationID}/SendTest HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	NotificationID: String,
	NotificationBody: String,
	NotificationSubject: String,
	NotificationName: String,
	NotificationFrom: String,
	NotificationTo: String,
	UsingRedis: True,
	AppInitTime: 2024-09-07T22:22:20.2611970-04:00,
	ServerID: WS-4-137-943,
	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-09-07T23:16:45.5217508-04:00,
	Device: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	success: False
}