Loading ...

REST API: Get Announcements | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Get Announcements
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 4

REST API: Get Announcements

0 
 /5
0 (0votes)

Get Announcements

GET  /api/announcements

Get a list of announcements. 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.
SpaceID &SpaceID=x - Used in the request URL as a query parameter Specifies the unique id of a space.
Optional Parameters How to use Description
PageLength &PageLength=x - Used in the request URL as a query parameter Specifies the number of results to be returned per page.
PageNumber &PageNumber=x - Used in the request URL as a query parameter Specifies the page number to be returned.

Example Request

GET https://myintranet.communifire.com/api/announcements?SpaceID=0&PageLength=5&PageNumber=1

Example Response

Announcements JSON object is returned as ResponseData.


{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
   {
    "PropertyID": 1,
    "PropertyCategoryName": "Announcement",
    "PropertyCategoryID": 1,
    "PropertyName": "CommunityAnnouncement",
    "PropertyValue": "Welcome to Communifire",
    "PropertyDescription": "This is a sample example of how Dynamic Properties can be used",
    "IsActive": true,
    "SpaceID": 0,
    "IsPlainText": false,
    "IsLocked": false,
    "SendNotificationToUsers": false,
    "SpaceImageUrl": "https://myintranet.communifire.com/assets/Themes/default/images/space-icon-default.png",
    "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