Case API

The Case API is a JSON API which stores case objects.

This API holds the functionality for creating the migrating tables, getting data from the database, converting to JSON and returns as an endpoint.

Contents

• Usage
• Getting Started
• Changing the migration
• Current Model

Usage

get     /                 # automatically redirects to helloworld for app test
get     /helloworld       # test endpoint for the application
get     /case             # get all cases
get     /case/<id_>       # get a cases with an id in the URL
delete  /case/<id_>       # delete a case with an id in the URL
post    /case             # Create a case by posting a json object reflecting the model

model for post

Getting Started

1. Clone the repo
2. In the directory enter the command

pip install -r requirements.txt

3. Export your database URI

export DATABASE_URI=postgresql://username:password@localhost/database

4. To run the migration run the command

python run.py db upgrade head

5. To run the application run the command

python run.py runserver

Changing the migration

All you have to do is change/create the related model and run the command

python run.py db revision --autogenerate

For some helpful documentation on using alembic go here

Current Model

{
  "id": Integer(Primary Key),
  "status": String
  "created_on": ISO Format DateTime,
  "last_updated": ISO Format DateTime,
  "deed_id": Integer,
  "conveyancer_id": Integer,
}

e.g.

{
  "id": 865604,
  "deed_id": 1,
  "conveyancer_id": 1,
  "status": "the status",
  "last_updated": "2015-06-23T23:37:08.156342",
  "created_on": "2015-06-23T23:37:08.156356"
}