Git Product home page Git Product logo

checklistapi's Introduction

Checklist API

Checklist is a application which allows users to create account and add list of items and interact with them.

Endpoints

Following the is list of endpoints available to fetch and interact with the data.

User related endpoints

Register User

URL /register
Method POST
Params name, email, password

Login User

URL /login
Method POST
Params email, password

Item related endpoints

For all item related endpoints you must supply the Api key to authenticate the operations. Each user in the application get unique Api key.

Add Item

URL /items
Method POST
Params item

Get Item

URL /items{id}
Method GET
Params -

Get Items

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.

Update Item

URL /items/{id}
Method PUT
Params item

Update Status

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.

Delete Item

URL /items/{id}
Method DELETE
Params -

Delete Items

URL /items
Method DELETE
Params -

Delete Completed Items

URL /clearcompleted
Method DELETE
Params -

checklistapi's People

Contributors

vaibhavawd avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.