Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 116 lines (87 sloc) 2.062 kb

Reminders

List upcoming

  • GET /#{token}/reminders.xml lists reminders with those to be reminded earliest first

Response:

<reminders>
  <reminder id="5">
    <remind_at>2007-07-03 14:59:00</remind_at>
    <content>Hello</content>
    <creator id="123" name="John D." />
    <remindees>
      <user id="456" name="Jane D." />
    </remindees>
  </reminder>
  <reminder id="6">
    <remind_at>2007-09-03 15:59:00</remind_at>
    <content>World!</content>
    <creator id="456" name="Jane D." />
    <remindees>
      <user id="123" name="John D." />
      <user id="789" name="Foo B." />
    </remindees>
  </reminder>
</reminders>

Create with fuzzy date

  • POST /#{token}/reminders.xml creates a reminder with a fuzzy date in the content.

Request:

<reminder>
  <content>+30 In thirty minutes!</content>
  <remindees type="array">
    <user_id>123</user_id>
    <user_id>456</user_id>
  </remindees>
</reminder>

Response:

Status: 201 Created
Location: /reminders/#{id}
<reminder id="1234">...</reminder>

Create with specific date

  • POST /#{token}/reminders.xml creates a reminder with a specific date.

Request:

<reminder>
  <remind_at>2007-07-03 19:51:00</remind_at>
  <content>In thirty minutes!</content>
  <remindees type="array">
    <user_id>123</user_id>
    <user_id>456</user_id>
  </remindees>
</reminder>

Response:

Status: 201 Created
Location: /reminders/#{id}
<reminder id="1234">...</reminder>

Update

  • PUT /#{token}/reminders/#{id}.xml changes a reminder.

Request:

<reminder>
  <remind_at>2007-07-03 20:06:00</remind_at>
  <content>In forty-five minutes!</content>
  <remindees type="array">
    <user_id>123</user_id>
    <user_id>456</user_id>
  </remindees>
</reminder>

Response:

Status: 200 OK

Destroy

  • DELETE /#{token}/reminders/#{id}.xml removes a reminder.

Response:

Status: 204 No Content
Something went wrong with that request. Please try again.