Loading ...

REST API: Get Unread Contents | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Get Unread Contents
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 5

REST API: Get Unread Contents

0 
 /5
0 (0votes)

Get Unread Contents

GET  /api/content/unseen

Get a list of content that has not been viewed by the user. Valid for Communifire version 6.0 and above.

Please Note This API is not for required reading.

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.
SpaceID &SpaceID=x - Used in the request URL as a query parameter Unique Identifier for a space.
EntityTypeCsv &EntityTypeCsv=x - 
Used in the request URL as a query parameter		 Comma-separated list of IDs of the entity types to return.

REST API: System Entity Types 
Optional Parameters How to use Description
From &From=x - Used in the request URL as a query parameter Specifies a date range - content created after this date is returned.
To &To=x - Used in the request URL as a query parameter Specifies a date range - content created before this date is returned.
PageLength &PageLength=x - Used in the request URL as a query parameter Specifies the number of results to be returned per page.
StartPage &StartPage=x - Used in the request URL as a query parameter Specifies the starting page of list to be returned.

Please Note Date format should match with the user's date format preferences.

Example Request

GET https://myintranet.communifire.com/api/content/unseen?SpaceID=2&EntityTypeCsv=14&From=6/1/2019&To=6/25/2019&StartPage=1&PageLength=100

Example Response

Content JSON object is returned as ResponseData.


{
    "IsError": false,
    "ResponseMessage": "",
    "TotalRecords": 1,
    "ResponseData": [
        {
            "ContentID": 1074,
            "EntityType": 14,
            "ContentTypeID": 14,
            "ContentTitle": "File.jpeg",
            "ContentStub": "File.jpeg",
            "ContentBody": "",
            "ContentSummary": "",
            "AuthorID": 1,
            "UpdatedByUserID": 1,
            "ParentContentID": 22,
            "ContentVersionID": 1,
            "SpaceID": 2,
            "WorkflowID": 0,
            "CurrentWorkflowStepID": 0,
            "StatusID": 1,
            "DateCreated": "2019-06-15T07:16:55.307",
            "DatePublished": "2019-06-15T07:16:56.887",
            "DateUpdated": "2019-06-15T07:16:55.307",
            "IsFeatured": false,
            "ViewCount": 0,
            "CommentCount": 0,
            "Rating": 0,
            "MetaTitle": "File.jpeg",
            "MetaDescription": "",
            "MetaKeywords": "",
            "PageH1Content": "",
            "HeadCustomContent": "",
            "SideBarContent": "",
            "ExtraSideBarContent": "",
            "ContentMediaServerID": 1019,
            "ContentMediaFileName": "9375ae17-be4b-4bb9-b768-df81192ad78e.jpeg",
            "IsLatest": false,
            "IsPublishedFromDraftMode": false,
            "IsPublishedFromDelayedPublishingMode": false,
            "IsPublishedFromUnderProcessingMode": false,
            "IsWallContent": false,
            "HasRead": false,
            "ContentFileSize": 128139,
            "IsEditable": false,
            "IsDeletable": false,
            "IsDownloadable": false,
            "IsChekoutable": false,
            "IsUndochekoutable": false,
            "IsChekinable": false,
            "IsRestoreable": false,
            "IsPurgeable": false,
            "IsHistoryViewable": false,
            "IsMoveable": false,
            "IsChildContentCreationAllowed": false,
            "IsContentCreationAllowed": false,
            "ViewerVote": 0,
            "VoteCount": 0,
            "IsDirectory": false,
            "IsActivityStreamAlbum": false,
            "LastChildAuthorUserID": 0,
            "LastGrandChildAuthorUserID": 0,
            "TotalChildRecords": 0,
            "TotalGrandChildRecords": 0,
            "IsSticky": false,
            "IsAnswered": false,
            "IsContentAvailablePostExpiry": false,
            "TenantID": 1
        }
    ],
}

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

Wiki Index

Pages

Intranet Software