Loading ...

REST API: Get Content Followers | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Get Content Followers
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 6

REST API: Get Content Followers

0 
 /5
0 (0votes)

Get Content Followers

GET /api/content/{ContentID}/followers

Get a list of users following content. 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.
ContentID Used in the request URL as a path parameter

Unique ID of the content.
EntityType &EntityType=x - Used in the request URL as a query parameter

ID of the entity type. See REST API: System Entity Types .
Optional Parameters How to use Description
populateSpaceMembershipStatus &EntityType=true/false - Used in the request URL as a query parameter
  • True: If we want to include MembershipStatus in the response, we can see "MembershipStatus" property and the value of it is the real status of the user.
  • Otherwise: False. But in response, we can see "MembershipStatus" property and its value of it is always 0.

Example Request

GET https://myintranet.communifire.com/api/content/53/followers?EntityType=3

Example Response

User JSON object is returned as ResponseData. Note that some properties are removed from this sample to make it shorter.

NOTE: For data field MembershipStatus the System Properties populateSpaceMembershipStatus needs to be set to true if a real status of the membership is expected. Otherwise False will always return 0.

 

 {
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "AvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/19/caafff60-d371-4f54-befc-bf8d06c0e730.jpg",
      "AvatarPath": "caafff60-d371-4f54-befc-bf8d06c0e730.jpg",
      "BlogID": 0,
      "DateFormat": "M/d/yyyy",
      "DateJoined": "2020-06-26T17:15:16.25",
      "DateJoinedString": "just now",
      "Email": "ben-n@axerosolutions.com",
      "EmailRecieve": 3,
      "SpaceDigestOption": 1,
      "FirstName": "Ben",
      "Gender": 0,
      "IP": "",
      "InvitationID": 0,
      "IsActivated": true,
      "IsAnonymous": false,
      "IsUserLocked": false,
      "IsBanned": false,
      "IsConfirmed": false,
      "IsContactInfoVisible": true,
      "IsFeatured": false,
      "IsIsolated": false,
      "IsProfileCompleted": true,
      "IsOptInPromotionalEmails": false,
      "IsPasswordEncrypted": false,
      "IsProfilePublic": true,
      "LastName": "Newman",
      "MediaServerID": 1,
      "MediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos",
      "MembershipStatus": 0,
      "MetaDescription": "{{USER_NAME}} is on {{COMMUNITY_NAME}}. Join {{COMMUNITY_NAME}} to connect with {{USER_NAME}}",
      "MetaKeywords": "Ben, Newman",
      "MetaTitle": "{{USER_NAME}} | {{COMMUNITY_NAME}}",
      "NumBlogPosts": 0,
      "NumPosts": 0,
      "Occupation": "Recruiting Manager",
      "PMNotification": false,
      "Password": "test",
      "Points": 0,
      "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/19/0ed43981-af8c-4093-bc73-692cb66db601.jpg",
      "ProfilePhoto": "0ed43981-af8c-4093-bc73-692cb66db601.jpg",
      "ProfileURL": "https://myintranet.communifire.com/people/ben-n",
      "OnlineChatStatus": 1,
      "RankID": 1,
      "RankImage": "rank-lurker.gif",
      "RankImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-lurker.gif",
      "RankName": "Lurker",
      "RoleID": 0,
      "ShowEmail": true,
      "TimeFormat": "h:mm tt",
      "TimeZoneID": "UTC",
      "UserID": 19,
      "UserInfoDisplayName": "Ben Newman",
      "UserName": "ben-n",
      "HasJoinedViaThirdPartyLogin": false,
      "IsWindowsADUser": false,
      "ChatStatusCssClass": "status-offline",
      "ChatStatusText": "Offline",
      "LastChatActivityDate": "2020-06-26T17:15:31.39",
      "UserPresenceStatus": 3,
      "IsPasswordHashed": false,
      "InOrgChart": false,
      "ConnectionStatus": 0,
      "CanChat": false,
      "PasswordExpiryType": 3,
      "TenantID": 0
    },
    {
      "AvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/10/1bcef682-b03c-47c3-a568-533f0caaf4d3.jpg",
      "AvatarPath": "1bcef682-b03c-47c3-a568-533f0caaf4d3.jpg",
      "BlogID": 0,
      "DateFormat": "M/d/yyyy",
      "DateJoined": "2020-06-26T17:15:14.437",
      "DateJoinedString": "2 seconds ago",
      "Email": "antonia@axerosolutions.com",
      "EmailRecieve": 3,
      "SpaceDigestOption": 1,
      "FirstName": "Antonia",
      "Gender": 0,
      "IP": "",
      "InvitationID": 0,
      "IsActivated": true,
      "IsAnonymous": false,
      "IsUserLocked": false,
      "IsBanned": false,
      "IsConfirmed": false,
      "IsContactInfoVisible": true,
      "IsFeatured": false,
      "IsIsolated": false,
      "IsProfileCompleted": true,
      "IsOptInPromotionalEmails": false,
      "IsPasswordEncrypted": false,
      "IsProfilePublic": true,
      "LastName": "Murray",
      "MediaServerID": 1,
      "MediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos",
      "MembershipStatus": 0,
      "MetaDescription": "{{USER_NAME}} is on {{COMMUNITY_NAME}}. Join {{COMMUNITY_NAME}} to connect with {{USER_NAME}}",
      "MetaKeywords": "Antonia, Murray",
      "MetaTitle": "{{USER_NAME}} | {{COMMUNITY_NAME}}",
      "NumBlogPosts": 0,
      "NumPosts": 0,
      "Occupation": "HR Coordinator",
      "PMNotification": false,
      "Password": "test",
      "Points": 0,
      "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/10/1763f6c1-98f0-4953-b3c8-8f58acabe43b.jpg",
      "ProfilePhoto": "1763f6c1-98f0-4953-b3c8-8f58acabe43b.jpg",
      "ProfileURL": "https://myintranet.communifire.com/people/antonia",
      "OnlineChatStatus": 1,
      "RankID": 1,
      "RankImage": "rank-lurker.gif",
      "RankImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-lurker.gif",
      "RankName": "Lurker",
      "RoleID": 0,
      "ShowEmail": true,
      "TimeFormat": "h:mm tt",
      "TimeZoneID": "UTC",
      "UserID": 10,
      "UserInfoDisplayName": "Antonia Murray",
      "UserName": "antonia",
      "HasJoinedViaThirdPartyLogin": false,
      "IsWindowsADUser": false,
      "ChatStatusCssClass": "status-offline",
      "ChatStatusText": "Offline",
      "LastChatActivityDate": "2020-06-26T17:15:41.807",
      "UserPresenceStatus": 3,
      "IsPasswordHashed": false,
      "InOrgChart": false,
      "ConnectionStatus": 0,
      "CanChat": false,
      "PasswordExpiryType": 3,
      "TenantID": 0
    },
    {
      "AvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/14/eaf1a7b4-de7d-4c39-84b3-5c87a178764f.jpg",
      "AvatarPath": "eaf1a7b4-de7d-4c39-84b3-5c87a178764f.jpg",
      "BlogID": 0,
      "DateFormat": "M/d/yyyy",
      "DateJoined": "2020-06-26T17:15:15.227",
      "DateJoinedString": "one second ago",
      "Email": "evelyn@axerosolutions.com",
      "EmailRecieve": 3,
      "SpaceDigestOption": 1,
      "FirstName": "Evelyn",
      "Gender": 0,
      "IP": "",
      "InvitationID": 0,
      "IsActivated": true,
      "IsAnonymous": false,
      "IsUserLocked": false,
      "IsBanned": false,
      "IsConfirmed": false,
      "IsContactInfoVisible": true,
      "IsFeatured": false,
      "IsIsolated": false,
      "IsProfileCompleted": true,
      "IsOptInPromotionalEmails": false,
      "IsPasswordEncrypted": false,
      "IsProfilePublic": true,
      "LastName": "Gomez",
      "MediaServerID": 1,
      "MediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos",
      "MembershipStatus": 0,
      "MetaDescription": "{{USER_NAME}} is on {{COMMUNITY_NAME}}. Join {{COMMUNITY_NAME}} to connect with {{USER_NAME}}",
      "MetaKeywords": "Evelyn, Gomez",
      "MetaTitle": "{{USER_NAME}} | {{COMMUNITY_NAME}}",
      "NumBlogPosts": 0,
      "NumPosts": 0,
      "Occupation": "Compensation and Benefits Manager",
      "PMNotification": false,
      "Password": "test",
      "Points": 0,
      "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/14/9c9a0411-e61e-44ce-955c-920d5a85b1c8.jpg",
      "ProfilePhoto": "9c9a0411-e61e-44ce-955c-920d5a85b1c8.jpg",
      "ProfileURL": "https://myintranet.communifire.com/people/evelyn",
      "OnlineChatStatus": 1,
      "RankID": 1,
      "RankImage": "rank-lurker.gif",
      "RankImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-lurker.gif",
      "RankName": "Lurker",
      "RoleID": 0,
      "ShowEmail": true,
      "TimeFormat": "h:mm tt",
      "TimeZoneID": "UTC",
      "UserID": 14,
      "UserInfoDisplayName": "Evelyn Gomez",
      "UserName": "evelyn",
      "HasJoinedViaThirdPartyLogin": false,
      "IsWindowsADUser": false,
      "ChatStatusCssClass": "status-online",
      "ChatStatusText": "Online",
      "LastChatActivityDate": "2020-06-26T17:15:51.213",
      "UserPresenceStatus": 1,
      "IsPasswordHashed": false,
      "InOrgChart": false,
      "ConnectionStatus": 0,
      "CanChat": false,
      "PasswordExpiryType": 3,
      "TenantID": 0
    }
  ]
}

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

 

Wiki Index

Pages

Intranet Software