YM REST Services

<back to all web services

NotificationMacros

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/NotificationMacrosReturn the list of Event Registration Notification Macros.
GET/Ams/{ClientID}/NotificationMacros/{NotificationID}Return a list of Notification Macros.
NotificationMacros Parameters:
NameParameterData TypeRequiredDescription
NotificationIDpathstringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
NotificationMacrosResponse Parameters:
NameParameterData TypeRequiredDescription
MacrosListformList<NotificationMacro>No
NotificationMacro Parameters:
NameParameterData TypeRequiredDescription
MacroIdformintNo
NameformstringNo
DescriptionformstringNo
MacroformstringNo
IsRequiredformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Ams/{ClientID}/NotificationMacros HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"MacrosList":[{"MacroId":0,"Name":"String","Description":"String","Macro":"String","IsRequired":false}],"NotificationID":"String","UsingRedis":true,"AppInitTime":"2024-05-02T23:46:07.4185243-04:00","ServerID":"WS-4-7-585","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:54:42.8785441-04:00","Device":"Desktop"}