Loading ...

REST API: Get Activity Ticker | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Wall Posts » REST API: Get Activity Ticker
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 2

REST API: Get Activity Ticker

0 
 /5
0 (0votes)

Get activity ticker

GET /api/wall/ticker

Returns a list of activity feeds based on the parameters specified in the URL. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
Optional Parameters How to use Description
EntityTypeCsv &entityTypeCsv=x - Used in the request URL CSV of entity types.

REST API: System Entity Types 
Activity &activity=x - Used in the request URL  Unique Identifier for an Activity.

REST API: Activity Action ID 
SpaceID &spaceid=x - Used in the request URL  Unique Identifier for a space.
UserID &userid=x - Used in the request URL  Unique Identifier for a user.
StartPage
 &startpage=x - Used in the request URL  Specifies the starting page of list to be returned.
PageLength &pagelength=x - Used in the request URL Specifies the number of results to be returned per page.

Example URL: http://your-community.com/api/wall/ticker?activity=1&entitytypecsv=24

Response JSON sample where activity ticker feeds JSON object is returned as ResponseData


{
  "IsError":false,
  "ResponseMessage":"",
  "ResponseData": [
    {
      "EntityComments": [],
      "EntityCommentCount": 0,
      "CustomEntityActivityComments": [],
      "ActivityFeedID": 3267,
      "ActivityDate": "2019-06-11T10:15:29.317",
      "WallID": 0,
      "WallContentType": 0,
      "OEmbedProviderType": 0,
      "UserID": 376,
      "ActivityEntityType": 24,
      "ActivityEntityTypeID": 24,
      "ActivityContentTypeID": 0,
      "ActivityEntityID": 1216,
      "UserName": "admin",
      "UserEmail": "test@axerosolutions.com",
      "FirstName": "Alexis",
      "LastName": "Fox",
      "AvatarPath": "f9c8486c-f3f3-41f9-9f46-044093247dc9.jpg",
      "ActionText": "commented on the article: REST API - From Mobile",
      "ActivityText": "commented on the article: REST API - From Mobile",
      "ActivityAction": 1,
      "MediaServerRootURL": "http://your-community.com/Assets/Uploaded-Photos",
      "UserAvatarFullUrl": "http://your-community.com/Assets/Uploaded-Photos/376/f9c8486c-f3f3-41f9-9f46-044093247dc9.jpg",
      "UserProfileURL": "http://your-community.com/people/admin",
      "UserDisplayName": "Alexis Fox",
      "DateTimeSpan": "19 days ago",
      "DateTimeISO": "2019-06-11T15:45:29.3170000",
      "DateTimeFull": "Tuesday, June 11, 2019 at 03:45",
      "ToUserID": 0,
      "SpaceID": 0,
      "DisplayOption": 0,
      "CanBeCommented": true,
      "CanBeLiked": true,
      "CanBeDeleted": false,
      "CanFollow": false,
      "CanBookmark": false,
      "IsFeed": false,
      "LikeDislikeCountResult": {
         "EntityID": 1216,
         "SystemEntityType": 24,
         "LikeCount": 1,
         "DislikeCount": 0,
         "DoesCurrentUserLikes": true,
         "DoesCurrentUserDislikes": false,
         "CurrentUserLikeID": 1816,
         "TenantID": 0
       },
      "PermissionCheckEntityID": 0,
      "ParentEntityID": 8802,
      "Photos": [],
      "Files": [],
      "WallComment": [],
      "TenantID": 1
    },
  ]
}


Please Note Your content type that you pass in the header of your request should be 'application/json'.

 

Wiki Index

Pages

Intranet Software