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 2

Rest Api: Get Single Bookmark for a User

0 
 /5
0 (0votes)

Get Bookmark

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  Used in the request URL as a path parameter. Unique identifier for a particular content. List of supported entities: Articles, Blogs, CMS Pages, Wikis, Files, Videos, Ideas, Photos, Albums, Forums, Forum Groups, Forum Topics, Forum Posts.
UserID Used in the request URL as a path parameter. Unique identifier for a particular user.
Optional Parameters How to use Description
PageLength  &pagelength=x - Used in the request URL (see below) Specifies the number of results to be returned per page.
StartPage &startpage=x - Used in the request URL (see below) Specifies the starting page of the list to be returned.

 

Example URL: https://your-community.com/api/content/7996/bookmarks?entitytype=3&userid=376 

Response JSON sample where bookmarks 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 work from home now a new normal, everyone gets access to Zoom. Here's how you get it.",
        "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