YM REST Services

<back to all web services

NotificationSubscription

Requires Authentication
Requires any of the roles:member, oauthmember
The following routes are available for this service:
POST/Ams/{ClientID}/Member/{MemberID}/NotificationSubscriptionSubscribe a user/device for Push Notification.
NotificationSubscription Parameters:
NameParameterData TypeRequiredDescription
AppIdbodystringNo
DeviceIdbodystringNo
DeviceNetworkbodyDeviceNetworkNo

Allowable Values

  • None
  • Apple
  • Google
  • Amazon
ExtendedDatabodyDictionary<string, string>No
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
NotificationSubscriptionResponse Parameters:
NameParameterData TypeRequiredDescription
RegistrationIDformintNo

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.

POST /Ams/{ClientID}/Member/{MemberID}/NotificationSubscription HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"AppId":"String","DeviceId":"String","DeviceNetwork":"None","ExtendedData":{"String":"String"},"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":"2024-05-03T02:48:45.5267912-04:00","Device":"Desktop"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"RegistrationID":0,"AppId":"String","DeviceId":"String","DeviceNetwork":"None","ExtendedData":{"String":"String"},"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":"2024-05-03T02:48:45.5267912-04:00","Device":"Desktop"}