The commands listed in this chapter let you Nudge other users, and create new or manage existing Reminders in relation to a parent object.

About Reminders #

The Reminders can be used as a tool for notifying others about a specific item in a Project (Task, Discussion, File, etc.). You can also schedule a future reminder for a particular object. There are two types of Reminders in activeCollab:

• Nudge notifies the selected users instantly.
• Reminder sets a future reminder that will notify users about something.

{context}/reminders/nudge #

This command creates and sends a new Nudge.

Method: POST

Request example:

1
2
3
4
5

reminder[send_to]=selected
reminder[selected_user_id]=1
reminder[send_on]=2012-07-25
reminder[comment]=sending nudge
submitted=submitted

Response:

1
2
3
4
5
6
7

<reminder>
  <id>20</id>
  <comment>
    <![CDATA[sending nudge]]>
  </comment>
  ...
</reminder>

{context}/reminders/add #

This command creates a new Reminder for a specific object.

Method: POST

Request example:

1
2
3
4
5

reminder[send_to]=selected
reminder[selected_user_id]=1
reminder[send_on]=2012-07-25
reminder[comment]=api reminder
submitted=submitted

Response:

1
2
3
4
5
6
7

<reminder>
  <id>18</id>
  <comment>
    <![CDATA[api reminder]]>
  </comment>
  ...
</reminder>

{context}/reminders/:reminder_id/send #

Use this command to send a Reminder before it is automatically sent by the system.

Method: POST

Request example:

1

submitted = submitted

Response:

1
2
3
4
5
6
7

<reminder>
  <id>19</id>
  <comment>
    <![CDATA[Reminder sent to subscribers]]>
  </comment>
  ...
</reminder>

{context}/reminders/:reminder_id/dismiss #

Use this command to dismiss an existing Reminder.

Method: POST

Request example:

1

submitted = submitted

Response:

1
2
3
4
5
6
7
8
9
10

<reminder>
  <id>20</id>
  <dismissed_on>
    <![CDATA[2012-07-25 11:43:17]]>
  </dismissed_on>
  <comment>
    <![CDATA[sending nudge]]>
  </comment>
  ...
</reminder>

{context}/reminders/:reminder_id/delete #

This command deletes an existing Reminder.

Method: POST

Request example:

1

submitted = submitted

Response:

1
2
3
4
5
6
7

<reminder>
  <id>19</id>
  <comment>
    <![CDATA[reminder to subscribers]]>
  </comment>
  ...
</reminder>