Thursday , April 27th 2017

remindd

a little something to remember those things you hate to forget

Overview

The Remindd API is a simple, easy to learn REST and XML powered API. You have full access to Remindd's user's reminders, the ability to set, edit and delete reminders from your application. Please read below for more information.

Where it all begins

All requests should be sent to the following URL in either GET or POST method. If requests are made via GET, please make sure that all requests are properly encoded.

http://remindd.com/request/

All requests must have the user's account email address & the user's password. Both sets of information must be base64 encoded.

Remindd's replies will be XML based. So make sure that your application is able to handle XML.

Error handling

All replies will have an XML "requeststatus" tree. If the requeststatus is set to "error", check the requestmessage tree for further information.

Possible Errors
Invalid Credentials - You'll get this error message if the user's details you provided are incorrect

Missing Information - You'll get this error message if you are using an API method and didn't provide information required.

Forbidden - You'll get this error message if you use a method that isn't allowed. For example, attempting to delete someone else's reminder.

Invalid Date or Time - You'll get this error message if the date you provide isn't valid or is in the past. Remember, we can't remind users to do something that was due a year ago =)

Not Found - You'll get this error message if you use a method and the reminder wasn't found or is already completed, this warning will only show up in the editreminder method.

Invalid API Method - You'll get this error message if the method you called doesn't exist or is invalid.

API Methods

Below are the list of possible API methods, how to use them, and results you should expect.
  • newreminder
    • Request URL -
      http://remindd.com/request/?action=newreminder&email=USEREMAIL&pass=USERPASS&reminder_title=REMINDER_TITLE&due_date=DUE_DATE&due_time=DUE_TIME
    • email - base64 encoded user's account email address
    • pass - base64 encoded user's account password
    • reminder_title - URL Encoded title of the new reminder
    • due_date -The date that this reminder is due in a MM dd YYYY format. Example: November 15 1990
    • due_time -The time that this reminder is due in a HH:MM AM format. Example: 12:00 AM

    • If successful the status message will be a numeric ID number for the reminder. If an error occurs check the requestmessage tree for further details.
  • editreminder
    • Request URL -
      http://remindd.com/request/?action=editreminder&email=USEREMAIL&pass=USERPASS&reminder_title=REMINDER_TITLE&due_date=DUE_DATE&due_time=DUE_TIME&reminder_id=REMINDER_ID
    • email - base64 encoded user's account email address
    • pass - base64 encoded user's account password
    • reminder_title - URL Encoded title of the new reminder
    • due_date -The date that this reminder is due in a MM dd YYYY format. Example: November 15 1990
    • due_time -The time that this reminder is due in a HH:MM AM format. Example: 12:00 AM
    • reminder_id -URL encoded ID of the reminder being edited.

    • If successful the status message will be the same as the reminder ID. If an error occurs check the requestmessage tree for further details.
  • removereminder
    • Request URL -
      http://remindd.com/request/?action=removereminder&email=USEREMAIL&pass=USERPASS&reminder_id=REMINDER_ID
    • email - base64 encoded user's account email address
    • pass - base64 encoded user's account password
    • reminder_id - URL Encoded ID of the reminder being deleted

    • If successful the status message will be set to the string "deleted". If an error occurs check the requestmessage tree for further details.
  • viewreminders
    • Request URL -
      http://remindd.com/request/?action=viewreminders&email=USEREMAIL&pass=USERPASS&view=VIEWTYPE
    • email - base64 encoded user's account email address
    • pass - base64 encoded user's account password
    • view - Type of reminders to view. This can be pending or completed. If this value is blank, all reminders will be shown.

Testing

If you would like to test the API for example XML replies and for a better understanding, we provide a test account for all developers to use. Please note that all the reminders in this account is deleted every day at 12:00AM.

Account Email: apitest@remindd.com

Account Password:apitest

Limits & Terms of Use

You are required to display "Powered by Remindd" message in your application if you use our API, that's all we ask for. As far as limits are concerned, you have 2500 requests per hour per user.