Loading ...

REST API: Get Notifications | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Notifications » REST API: Get Notifications
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 9

REST API: Get Notifications

0 
 /5
0 (0votes)

Get Notifications

GET /api/notifications

Get a list of the current user's notifications. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 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
StartPage &StartPage=x - Used in the request URL as a query parameter Specifies the starting page of list to be returned.
PageLength &PageLength=x - Used in the request URL as a query parameter Specifies the number of results to be returned per page.
fromDate &fromDate=x - Used in the request URL as a query parameter  Notifications sent between fromDate and toDate. (All results will be returned if not set)
toDate &toUserID=x Used in the request URL as a query parameter  Notifications sent between fromDate and toDate. (All results will be returned if not set)
fromUserID &fromUserID=x Used in the request URL as a query parameter  UserID of the person the notifications are from
entityTypeID &entityTypeID=x Used in the request URL as a query parameter  Entity type to limit notifications to. See REST API: System Entity Types for definition and details
categoryID &category=x Used in the request URL as a query parameter  CategoryID to limit notifications for (only applies to entity types with category)

Example Request

GET https://myintranet.communifire.com/api/notifications?StartPage=1&PageLength=2

Example Response

Notifications JSON object is returned as ResponseData.

{
 "IsError": false,
 "ResponseMessage": "",
 "ResponseData": [
   {
    "ID": 3,
    "SpaceID": 2,
    "SpaceName": "Human Resources",
    "SpaceURL": "https://myintranet.communifire.com/spaces/2/human-resources",
    "EntityID": 2,
    "ParentEntityID": 0,
    "EntityType": 10,
    "ActivityAction": 60,
    "DateCreated": "2019-02-04T04:26:19.153",
    "DateCreatedString": "59 seconds ago",
    "NewsFeedText": "Alexis Fox @mentioned you in: Laura Carter You should join this space",
    "IsRead": false,
    "DateRead": "2019-02-04T04:27:18.7004558Z",
    "URL": "https://myintranet.communifire.com/spaces/2/human-resources/wall/post/2",
    "FromUserID": 5,
    "FromUserInfoDisplayName": "Alexis Fox",
    "FromUserAvatarImageURL": "https://myintranet.communifire.com/assets/Themes/default/images/avatar-default.jpg",
    "FromUserProfileURL": "http://myintranet.communifire.com/people/alexis",
    "ActionText": "@mentioned you in",
    "Subject": "Laura Carter You should join this space",
    "EntityTypeID": 10,
    "ContentTypeID": 0,
    "TenantID": 0
  },
  {
    "ID": 2,
    "SpaceID": 2,
    "SpaceName": "Human Resources",
    "SpaceURL": "https://myintranet.communifire.com/spaces/2/human-resources",
    "EntityID": 1,
    "ParentEntityID": 0,
    "EntityType": 15,
    "ActivityAction": 15,
    "DateCreated": "2019-02-04T04:25:46.403",
    "DateCreatedString": "a minute ago",
    "NewsFeedText": "Alexis Fox invited you to a space: Human Resources",
    "IsRead": false,
    "DateRead": "2019-02-04T04:27:18.7004558Z",
    "URL": "https://myintranet.communifire.com/spaces/2/human-resources",
    "FromUserID": 5,
    "FromUserInfoDisplayName": "Alexis Fox",
    "FromUserAvatarImageURL": "https://myintranet.communifire.com/assets/Themes/default/images/avatar-default.jpg",
    "FromUserProfileURL": "https://myintranet.communifire.com/people/alexis",
    "ActionText": "invited you to a space",
    "Subject": "Human Resources",
    "EntityTypeID": 15,
    "ContentTypeID": 0,
    "TenantID": 0
  }
],
}

 

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

 

Wiki Index

Pages

Intranet Software