Loading ...

REST API: Get List of Users who Bookmarked a Piece of Content | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Bookmarks » REST API: Get List of Users who Bookmarked a Piece of Content
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 1

REST API: Get List of Users who Bookmarked a Piece of Content

0 
 /5
0 (0votes)

Get List of Users who Bookmarked a Piece of Content

GET api/content/{ContentID}/bookmarks

Get a list of users who bookmarked a specific piece of 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  ContentID=x - Used in the request URL as a path parameter. Unique identifier for a particular content. 
EntityType EntityType=x - Used in the request URL  The entity type of the content to be returned. Here are the values of Entity Type parameter:
  • Article = 3
  • Blog = 4
  • Calendar events = 5
  • Photo = 6
  • Video = 7
  • Wiki = 9
  • File = 14
  • Album = 18
  • Case = 19
  • Idea = 44

Example Request

GET https://your-community.com/api/content/12714/bookmarks?EntityType=3&token=Vm 

Example Response

Content JSON object is returned as ResponseData. 


{
    "IsError": false,
    "ResponseMessage": "",
    "ResponseData": [
        {
            "BookmarkID": 226,
            "EntityID": 12714,
            "EntityType": 3,
            "ContentTypeID": 0,
            "SpaceID": 302,
            "Url": "/spaces/302/it-space/articles/news/12714/zoom",
            "UserID": 950,
            "DateCreated": "2024-07-26T17:32:44.517",
            "SortOrder": 0,
            "Title": "Zoom",
            "Description": "A video conferencing tool enabling virtual meetings and collaboration.",
            "BookmarkEntityIconCssClass": "icon-file",
            "PageID": 0,
            "TenantID": 0
        },
        {
            "BookmarkID": 231,
            "EntityID": 12714,
            "EntityType": 3,
            "ContentTypeID": 0,
            "SpaceID": 302,
            "Url": "/spaces/302/it-space/articles/news/12714/zoom",
            "UserID": 980,
            "DateCreated": "2024-07-26T19:26:34.573",
            "SortOrder": 0,
            "Title": "Zoom",
            "Description": "A video conferencing tool enabling virtual meetings and collaboration.",
            "BookmarkEntityIconCssClass": "icon-file",
            "PageID": 0,
            "TenantID": 0
        },
        {
            "BookmarkID": 232,
            "EntityID": 12714,
            "EntityType": 3,
            "ContentTypeID": 0,
            "SpaceID": 302,
            "Url": "/spaces/302/it-space/articles/news/12714/zoom",
            "UserID": 376,
            "DateCreated": "2024-07-26T19:28:27.197",
            "SortOrder": 0,
            "Title": "Zoom",
            "Description": "A video conferencing tool enabling virtual meetings and collaboration.",
            "BookmarkEntityIconCssClass": "icon-file",
            "PageID": 0,
            "TenantID": 0
         }
    ]
}

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

Wiki Index

Pages

Intranet Software