YM REST Services

<back to all web services

MemberPulse

Requires Authentication
The following routes are available for this service:
GET/Ams/{ClientID}/Member/{MemberID}/MemberPulseLong polling pulse for checking the status of many objects as they change in order to notify the client to do a full request.
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
MemberPulseResponse Parameters:
NameParameterData TypeRequiredDescription
CheckNotificationsformboolNo
CheckPostsformboolNo
NotificationCountformintNo
LatestPostDateformDateTimeNo

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}/Member/{MemberID}/MemberPulse HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"CheckNotifications":false,"CheckPosts":false,"NotificationCount":0,"LatestPostDate":"0001-01-01T00:00:00.0000000","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-03T01:14:55.7581009-04:00","Device":"Desktop"}