YM REST Services

<back to all web services

Shares

Requires Authentication
Requires any of the roles:member, oauthmember, admin, oauthadminRequires the permission:CanMaintainWall
The following routes are available for this service:
POST/Ams/{ClientID}/Member/{MemberID}/SharesShare a post from the feed to a member's wall.
GET/Ams/{ClientID}/Member/{MemberID}/SharesReturn a list of members who have shared a specific post.
GET/Ams/{ClientID}/SharesReturn a list of members who have shared a specific post.
Shares Parameters:
NameParameterData TypeRequiredDescription
PostIdbodyintNo
PhotoIdbodyintNo
PostTextbodystringNo
PageNumberbodyintNo
PageSizebodyintNo
OffSetbodyintNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
SharesResponse Parameters:
NameParameterData TypeRequiredDescription
NewPostIdformintNo
MemberListformList<Share>No
Share Parameters:
NameParameterData TypeRequiredDescription
ShareIdformintNo
PostIdformintNo
PhotoIdformintNo
DateSharedformDateTimeNo
Connection Parameters:
NameParameterData TypeRequiredDescription
ConnectionStatusformConnectionStatus?No
ConnectionIdformintNo
FirstNameformstringNo
LastNameformstringNo
ConnectionNameformstringNo
OrganizationformstringNo
HeadShotImageformstringNo
WorkTitleformstringNo
MemberTypeformstringNo
CityformstringNo
StateformstringNo
LocationformstringNo
CountryformstringNo
SharedformboolNo
EmailformstringNo
PhoneLabelformstringNo
PhoneAreaCodeformstringNo
PhoneNumberformstringNo
FaxLabelformstringNo
FaxAreaCodeformstringNo
FaxNumberformstringNo
CanShowformShowPreferencesNo
intCategoryIDformintNo
IsAmbassadorformboolNo
ShowPreferences Parameters:
NameParameterData TypeRequiredDescription
CityformboolNo
LocationformboolNo
CountryformboolNo
PhoneformboolNo
FaxformboolNo
EmailformboolNo
EmployerNameformboolNo
EmployerTitleformboolNo

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

HTTP + CSV

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

POST /Ams/{ClientID}/Member/{MemberID}/Shares HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"PostId":0,"PhotoId":0,"PostText":"String","PageNumber":0,"PageSize":0,"OffSet":0,"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:53:55.7093470-05:00","Device":"Desktop"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"NewPostId":0,"MemberList":[{"ShareId":0,"PostId":0,"PhotoId":0,"DateShared":"0001-01-01T00:00:00.0000000","ConnectionStatus":"None","ConnectionId":0,"FirstName":"String","LastName":"String","ConnectionName":"String","Organization":"String","HeadShotImage":"String","WorkTitle":"String","MemberType":"String","City":"String","State":"String","Location":"String","Country":"String","Shared":false,"Email":"String","PhoneLabel":"String","PhoneAreaCode":"String","PhoneNumber":"String","FaxLabel":"String","FaxAreaCode":"String","FaxNumber":"String","CanShow":{"City":false,"Location":false,"Country":false,"Phone":false,"Fax":false,"Email":false,"EmployerName":false,"EmployerTitle":false},"intCategoryID":0,"IsAmbassador":false}],"PostId":0,"PhotoId":0,"PostText":"String","PageNumber":0,"PageSize":0,"OffSet":0,"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:53:55.7093470-05:00","Device":"Desktop"}