Checklist is a application which allows users to create account and add list of items and interact with them.
Following the is list of endpoints available to fetch and interact with the data.
URL |
/register |
Method |
POST |
Params |
name, email, password |
URL |
/login |
Method |
POST |
Params |
email, password |
For all item related endpoints you must supply the Api key to authenticate the operations. Each user in the application get unique Api key.
URL |
/items |
Method |
POST |
Params |
item |
URL |
/items{id} |
Method |
GET |
Params |
- |
URL |
/items |
Method |
GET |
Params |
status |
Here the param status is optional. But if the you want to filter the list of items to show only completed or only active items in the database then pass 1 to show complete and 0 to show active items.
URL |
/items/{id} |
Method |
PUT |
Params |
item |
URL |
/items/{id}/status{code} |
Method |
PUT |
Params |
- |
The status code should be either 1 or 0 to mark the item completed or active respectively.
URL |
/items/{id} |
Method |
DELETE |
Params |
- |
URL |
/items |
Method |
DELETE |
Params |
- |
URL |
/clearcompleted |
Method |
DELETE |
Params |
- |