Loading ...

REST API: Get Comment Attachments | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Comments » REST API: Comment Attachments » REST API: Get Comment Attachments
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 3

REST API: Get Comment Attachments

0 
 /5
0 (0votes)

Get Comment Attachments

GET  /api/comments/{commentid}/attachments

Allows a member to get attachments of a comment. 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.
CommentID Used in the request URL:
commentid=x (see below)		 Unique Identifier for a comment.
EntityType Used in the request URL:
&entitytype=x		 Unique Identifier for a particular comment entity type.

REST API: System Entity Types 

Example URL: https://your-community.com/api/comments/2/attachments?entitytype=24

Response JSON sample where comment attachments JSON object is returned as ResponseData


{
 "IsError": false,
 "ResponseMessage": "",
 "ResponseData": [
   {
    "FileID": 21,
    "FileExtension": "jpeg",
    "Caption": "File1.jpeg",
    "FileName": "344692c7-c54b-4402-b814-3396775d9def.jpeg",
    "MediaServerRootURL": "https://your-community.com/Assets/Uploaded-CMS-Files",
    "MediaServerID": 1019,
    "EntityID": 2,
    "EntityType": 0,
    "FileSize": 60736,
    "FileSizeText": "59.3KB",
    "Active": true,
    "DateCreated": "2019-07-01T04:09:10.05",
    "FileURL": "https://your-community.com/attachment?file=s%2FX043qt1eRRDw1KBZYi0A%3D%3D",
    "FileThumbURL": "https://your-community.com/attachment?file=s%2FX043qt1eRRDw1KBZYi0A%3D%3D",
    "FileTypeIconCSSClass": "cf-icon cf-icon-file-image",
    "IsImage": true,
    "AttachmentType": 1,
    "TenantID": 0
   },
   {
    "FileID": 22,
    "FileExtension": "pdf",
    "Caption": "File2.pdf",
    "FileName": "9be1a15b-4d09-4ea2-83ab-8a599d92b144.pdf",
    "MediaServerRootURL": "https://your-community.com/Assets/Uploaded-CMS-Files",
    "MediaServerID": 1019,
    "EntityID": 2,
    "EntityType": 0,
    "FileSize": 60736,
    "FileSizeText": "59.3KB",
    "Active": true,
    "DateCreated": "2019-07-01T04:21:56.987",
    "FileURL": "https://your-community.com/attachment?file=8dEjsAaY2778oP9Mp%2BSzlA%3D%3D",
    "FileThumbURL": "https://your-community.com/attachment?file=8dEjsAaY2778oP9Mp%2BSzlA%3D%3D",
    "FileTypeIconCSSClass": "cf-icon cf-icon-file-pdf",
    "IsImage": false,
    "AttachmentType": 1,
    "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