YM REST Services

<back to all web services

EngagementScores

This calculates and stores a score for the member based to evaluate their engagement level. Likes, Posts, Comments, etc.
Each engagement action is given a scored based on internal system settings.

Requires Authentication
Requires any of the roles:member, oauthmember
The following routes are available for this service:
POST/Ams/{ClientID}/Member/{MemberID}/EngagementScoresCredit a member with an Engagement Score per action.
GET/Ams/{ClientID}/Member/{MemberID}/EngagementScoresReturn the current Engagement score for a member.
EngagementScores Parameters:
NameParameterData TypeRequiredDescription
EngagementActionbodyGameActionTypeNo

Allowable Values

  • Log_In
  • Rating
  • Posting
  • Commenting
  • Event_Registration
  • Event_Attend
  • Wiki_Create
  • Wiki_Contribute
  • MemberReferral
  • Gallery_Upload
  • CVC_ResumeUpload
  • CVC_Apply_ToJob
  • BulkEmail_Open
  • Subscribe_NowFeed
  • Connection_Create
  • SocialNetwork_Create
  • Feed_Post_Like
  • Feed_Post_Share
  • Feed_Post_Comment
  • Feed_Post
  • Photo_Like
  • Photo_Share
  • Photo_Comment
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo

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}/EngagementScores HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"EngagementAction":"Log_In","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":"2025-01-15T08:39:45.5348314-05:00","Device":"Desktop"}