YM REST Services

<back to all web services

NotificationUpdate

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
PUT/Ams/{ClientID}/Notification/{NotificationID}Update the details of notification.
NotificationUpdate Parameters:
NameParameterData TypeRequiredDescription
NotificationIDpathstringNo
NotificationNamebodystringNo
NotificationDescriptionbodystringNo
NotificationCanDisablebodyboolNo
NotificationIsReadonlybodyboolNo
NotificationIsActivebodyboolNo
NotificationIsCustombodyboolNo
NotificationFrombodystringNo
NotificationSubjectbodystringNo
NotificationBodybodystringNo
NotificationMacroCountbodyintNo
NotificationFromDefaultbodystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
NotificationUpdate Parameters:
NameParameterData TypeRequiredDescription
NotificationIDpathstringNo
NotificationNamebodystringNo
NotificationDescriptionbodystringNo
NotificationCanDisablebodyboolNo
NotificationIsReadonlybodyboolNo
NotificationIsActivebodyboolNo
NotificationIsCustombodyboolNo
NotificationFrombodystringNo
NotificationSubjectbodystringNo
NotificationBodybodystringNo
NotificationMacroCountbodyintNo
NotificationFromDefaultbodystringNo

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

{
	NotificationID: String,
	NotificationName: String,
	NotificationDescription: String,
	NotificationCanDisable: False,
	NotificationIsReadonly: False,
	NotificationIsActive: False,
	NotificationIsCustom: False,
	NotificationFrom: String,
	NotificationSubject: String,
	NotificationBody: String,
	NotificationMacroCount: 0,
	NotificationFromDefault: String,
	UsingRedis: True,
	AppInitTime: 2024-05-03T14:13:55.3634116+00: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-03T14:25:11.9036302+00:00,
	Device: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	NotificationID: String,
	NotificationName: String,
	NotificationDescription: String,
	NotificationCanDisable: False,
	NotificationIsReadonly: False,
	NotificationIsActive: False,
	NotificationIsCustom: False,
	NotificationFrom: String,
	NotificationSubject: String,
	NotificationBody: String,
	NotificationMacroCount: 0,
	NotificationFromDefault: String,
	UsingRedis: True,
	AppInitTime: 2024-05-03T14:13:55.3634116+00: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-03T14:25:11.9036302+00:00,
	Device: Desktop
}