YM REST Services

<back to all web services

OrganizationPosts

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/OrganizationPostsGet a list of organization posts.
POST/Ams/{ClientID}/OrganizationPostsAdd a new organization post.
DELETE/Ams/{ClientID}/OrganizationPosts/{PostId}Delete an organization post.
PUT/Ams/{ClientID}/OrganizationPosts/{PostId}Update an organization post.
OrganizationPosts Parameters:
NameParameterData TypeRequiredDescription
LinkItemTypebodyWallPostLinkTypes?No

Allowable Values

  • WallPost
  • WallPostComment
  • BlogPost
  • BlogPostComment
  • ForumPost
  • ForumPostComment
  • Forum
  • EventRegistration
  • Event
  • Survey
  • NewsItem
  • Photo
LinkItemIdbodyintNo
SendNotificationAlertbodyboolNo
PostIdpathintNo
PostTextbodystringNo
PostHtmlbodystringNo
PostImageUrlbodyList<string>No
ContentTokenbodystringNo
ContentUrlbodystringNo
PageNumberbodyintNo
PageSizebodyintNo
OffSetbodyintNo
DefaultCommentsbodyintNo
Activebodybool?No
Repostbodybool?No
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
OrganizationPostsResponse Parameters:
NameParameterData TypeRequiredDescription
PhotoIdListformList<int>No

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

{"LinkItemType":"0","LinkItemId":0,"SendNotificationAlert":false,"PostId":0,"PostText":"String","PostHtml":"String","PostImageUrl":["String"],"ContentToken":"String","ContentUrl":"String","PageNumber":0,"PageSize":0,"OffSet":0,"DefaultComments":0,"Active":false,"Repost":false,"UsingRedis":true,"AppInitTime":"2024-05-03T07:46:06.7713048-04:00","ServerID":"WS-4-7-585","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-03T07:51:17.7005612-04:00","Device":"Desktop"}

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

{"PhotoIdList":[0],"LinkItemType":"0","LinkItemId":0,"SendNotificationAlert":false,"PostId":0,"PostText":"String","PostHtml":"String","PostImageUrl":["String"],"ContentToken":"String","ContentUrl":"String","PageNumber":0,"PageSize":0,"OffSet":0,"DefaultComments":0,"Active":false,"Repost":false,"UsingRedis":true,"AppInitTime":"2024-05-03T07:46:06.7713048-04:00","ServerID":"WS-4-7-585","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-03T07:51:17.7161944-04:00","Device":"Desktop"}