Loading ...

REST API: Get Reminders | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Events » REST API: Event Reminders » REST API: Get Reminders
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 3

REST API: Get Reminders

0 
 /5
0 (0votes)

Get Reminders

GET /api/events/{EventID}/reminders

Get a list of reminders a user has set for a certain event. 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.
EventID Used in the request URL as a path parameter

Unique ID of the event.
Optional Parameters How to use Description
UserID &UserID=x - Used in the request URL as a query parameter Unique ID of the user to return reminders for.
Note: Only a site administrator can get reminders of other users.

Example Request

GET https://myintranet.communifire.com/api/events/153/reminders?UserID=1017

Example Response

Reminder JSON object is returned as ResponseData.

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "ReminderID": 627,
      "EntityType": 5,
      "EntityID": 153,
      "ReminderType": 1,
      "ReminderTime": 30,
      "UserID": 1017,
      "ReminderSent": false,
      "TenantID": 0
    },
    {
      "ReminderID": 628,
      "EntityType": 5,
      "EntityID": 153,
      "ReminderType": 1,
      "ReminderTime": 10,
      "UserID": 1017,
      "ReminderSent": false,
      "TenantID": 0
    },
    {
      "ReminderID": 629,
      "EntityType": 5,
      "EntityID": 153,
      "ReminderType": 1,
      "ReminderTime": 2,
      "UserID": 1017,
      "ReminderSent": false,
      "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