Loading ...

REST API: Get Single Bookmark for a User | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Bookmarks » REST API: Get Single Bookmark for a User
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 10

REST API: Get Single Bookmark for a User

0 
 /5
0 (0votes)

Get Single Bookmark for a User

GET api/content/{contentID}/bookmarks

Allows a member to retrieve the bookmark for a specific 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. 
UserID UserID=x - Used in the request URL  Unique identifier for a particular user.
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/7996/bookmarks?EntityType=3&UserID=376 

Example Response

Content JSON object is returned as ResponseData. 


{


    "IsError": false,
   "ResponseMessage": "",
    "ResponseData": {
        "BookmarkID": 160,
        "EntityID": 7996,
        "EntityType": 3,
        "ContentTypeID": 0,
        "SpaceID": 256,
        "Url": "",
        "UserID": 376,
        "DateCreated": "2023-03-20T09:39:25.213",
        "SortOrder": 0,
       "Title": "New Intranet Software Now Available to all Employees",
       "Description": "With remote work now the norm, everyone has access to Zoom for 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