All API access is over HTTP[S], and accessed from http://localhost:5000/api/people/. All data is sent and received as JSON.
- Example of data
{ 'id': 1, 'name': 'Foo', 'age': 25, 'sexe': 'H', 'student': False }
-
Get all rows: getPeople()
$ curl -i http://localhost:5000/api/people/
-
Get one row using ID: getPerson(person_id)
$ curl -i http://localhost:5000/api/people/id=person_id
-
Insert new row: createPerson()
$ curl -i -H "Content-Type: application/json" -X POST -d '{"name":"Poo"}' http://localhost:5000/api/people/
-
Update existing row using ID: updatePerson(person_id)
$ curl -i -H "Content-Type: application/json" -X PUT -d '{"student":true}' http://localhost:5000/api/people/id=2
-
Delete existing row using ID: deletePerson(person_id)
$ curl -i -H "Content-Type: application/json" -X DELETE http://localhost:5000/api/people/id=2
-
Not found error (404)
HTTP/1.0 404 NOT FOUND { "error": "Not found" }
-
Bad request error (400)
HTTP/1.0 400 BAD REQUEST { "error": "Bad request" }