Reminders

// TODO need a description of reminders

Object Definition

Field	Type	Description
uuid	string	Unique identifier for the object
created_at	string	ISO 8601 datetime when the reminder was originally created
updated_at	string	ISO 8601 datetime when the reminder was last updated
title	string	Title of the reminder
description	string / null	A longer description of the reminder
due_at	string	ISO 8601 date or datetime when the reminder should be completed by
anytime	boolean	If the reminder is due at a specific time or all day

List all Reminders

Retrieve a paginated list of all the accounts Reminders. GET /reminders.

Filters

You many filter the results from the list endpoint using the following query parameters

Field	Type	Description
due_at	string	ISO 8601 datetime when the reminder is due

Example Response

{
  "data": [
    {
      "uuid": "082bdfe1-c21a-4941-bf29-47c2249a7761",
      "created_at": "2018-08-02T15:39:45+01:00",
      "updated_at": "2018-08-02T15:39:49+01:00",
      "title": "Gas Safety Inspection",
      "description": "Gas Safety Inspection is due for 1400 Blueprint, Dundas Spur, Portsmouth, Hampshire, PO3 5RW",
      "due_at": "2018-08-02T15:00:00+01:00",
      "anytime": false
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Get a single Reminder

Retrieve a single reminder by it's uuid. GET /reminders/:uuid.

Example Response

{
  "uuid": "082bdfe1-c21a-4941-bf29-47c2249a7761",
  "created_at": "2018-08-02T15:39:45+01:00",
  "updated_at": "2018-08-02T15:39:49+01:00",
  "title": "Gas Safety Inspection",
  "description": "Gas Safety Inspection is due for 1400 Blueprint, Dundas Spur, Portsmouth, Hampshire, PO3 5RW",
  "due_at": "2018-08-02T15:00:00+01:00",
  "anytime": false
}

Creating a Reminder

Perform a POST request to the /reminders endpoint. This endpoint will return a HTTP 201 status code on success.

Input

Field	Type	Description
title	string	Required
description	string / null
due_at	string	ISO 8601 date or datetime when the reminder should be completed
anytime	boolean / null	If the reminder doesn't have a specific time it should be completed. (Defaults to false)

Updating a Reminder

Perform a PUT request to the /reminders/:uuid endpoint. This endpoint will return a HTTP 200 status code on success.

Input

Field	Type	Description
title	string	Title of the reminder
description	string / null	A longer description of the reminder
due_at	string	ISO 8601 date or datetime when the reminder should be completed by
anytime	boolean	If the reminder is due at a specific time or all day

Deleting a Reminder

Perform a DELETE request to the /reminders/:uuid endpoint. This endpoint will return a HTTP 204 status code on success.