YM REST Services

<back to all web services

PushNotificationsConfig

Requires Authentication
Requires any of the roles:member, oauthmember
The following routes are available for this service:
GET/Ams/{ClientID}/Member/{MemberID}/PushNotificationsConfigReturn a list of Push Notification Config settings for the member.
PUT/Ams/{ClientID}/Member/{MemberID}/PushNotificationsConfigUpdate the list of Push Notification Config settings for the member.
PUT/Ams/{ClientID}/Member/{MemberID}/PushNotificationsConfig/{NotificationID}Update the switch value for the given NotificationID.
PushNotificationsConfig Parameters:
NameParameterData TypeRequiredDescription
PushNotificationConfigListbodyList<PushNotificationConfig>No
NotificationIDpathintNo
StatusbodyboolNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
PushNotificationConfig Parameters:
NameParameterData TypeRequiredDescription
NotificationIDformintNo
DisplayNameformstringNo
StatusformboolNo

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.

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

{"PushNotificationConfigList":[{"NotificationID":0,"DisplayName":"String","Status":false}],"NotificationID":0,"Status":false,"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-03T00:38:30.8897671-04:00","Device":"Desktop"}

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

{"PushNotificationConfigList":[{"NotificationID":0,"DisplayName":"String","Status":false}],"NotificationID":0,"Status":false,"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-03T00:38:30.8897671-04:00","Device":"Desktop"}