Loading ...

REST API: Get Abuse Report | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Abuse Reports » REST API: Get Abuse Report
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 3

REST API: Get Abuse Report

0 
 /5
0 (0votes)

Get Abuse Report

GET  /api/content/abuses

Allows an administrator to get details of abused 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.
Optional Parameters How to use Description
UserID &userid=x - Used in the request URL (see below) Unique Identifier for a User whose content has been reported by other members.
SpaceID &spaceid=x - Used in the request URL (see below) Unique Identifier for a space.
SpaceIDCSV &spaceidcsv=x - Used in the request URL (see below) A comma-separated list of space IDs.
ContentID &contentid=x - Used in the request URL (see below) Unique Identifier for a content whose abuse report has to be returned.
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/abuses?userid=664&spaceID=0&startPage=1&pageLength=100

Response JSON sample where abuse reports JSON object is returned as ResponseData


{
  "IsError": false,
  "ResponseMessage": "",
  "TotalRecords": 1,
  "ResponseData": [
    {
     "FlagID": 123,
     "FlaggedByUserID": 376,
     "DateFlagged": "2019-06-27T10:48:33.423",
     "FlaggedEntityURL": "https://your-community.com/articles/news/8985/Blogging",
     "FlagComment": "This content is wrong",
     "SpaceID": 0,
     "EntityID": 8985,
     "EntityType": 3,
     "ReportTypeID": 1,
     "TenantID": 1
    }
  ],
}

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

Wiki Index

Pages

Intranet Software