A simple API for data querying.
The project is deployed and hosted on Heroku.

Main site: https://ra-api.herokuapp.com/
Query Full Record By HID GET https://ra-api.herokuapp.com/api/query/hid/<hid>
Query Parts of Record By HID POST https://ra-api.herokuapp.com/api/query

• Access by curl

# Query Full Record By HID
curl -i https://ra-api.herokuapp.com/api/query/hid/3126F2F5F8QR5N1OVUZEMNGHF0EPEO

# Query Parts of Record By HID
curl -H "Content-Type: application/json" -d '{"hid": "3GV1I4SEO9CX1NTBXKN9TIFKTSQ6LN", "res_hid": true, "res_content":true, "res_has_space": true}' https://ra-api.herokuapp.com/api/query

Returns the full record with the given “hid”

URL : /api/query/hid/<hid>

URL Parameters:

Method : GET

Data constraints : hid should be string type

Example Request: GET http://127.0.0.1:5000/api/query/hid/33BFF6QPI1YEFYISIWWDVQKGH8RW3Z

Condition : Exists a record with the given HID.

Code : 200 OK

Response Type: json

Response Content Example :

{
  "result": {
        "hid": "33BFF6QPI1YEFYISIWWDVQKGH8RW3Z",
        "content": "Landmark Center, 8th Fl",
        "has_space": false     
  }
}

Condition: Fail to find a record with the given HID.

Code: 404 Not Found

Response Type: json Response Content Example :

{
  "message": "[Err] 404 Not Found.", 
  "status": 404
}

Returns parts of record with the given “hid” and display parameters

URL : /api/query

URL Parameters:

Method : POST

Data constraints :

Example Request:

POST http://127.0.0.1:5000/api/query  
Content-Type:application/json
Accept:application/json	

{
    'hid': 32L724R85L73LS3ARDP572E97TLPIX,
    'res_hid': true,
    'res_content': true
}

Condition : Exists a record with the given HID.

Code : 200 OK

Response Type: json

Response Content Example : Note: result only contains fields that are specified in the given parameters.

{
  "result": {
        "hid": "33BFF6QPI1YEFYISIWWDVQKGH8RW3Z",
        "content": "Landmark Center, 8th Fl",
        "has_space": false     
  }
}

Condition: Fail to find a record with the given HID.

Code: 404 Not Found

Response Type: json Response Content Example :

{
  "message": "[Err] 404 Not Found.", 
  "status": 404
}

• Install Virtualenv

pip install virtualenv

Under the project directory

• Create the virtual environment

virtualenv ./

• Activate the virtual environment

source ./bin/activate

• install dependencies

pip install -r requirements.txt

• Initialize the database

python manage.py init

• Migrate the database

python manage.py migrate

• Upgrade the database

python manage.py upgrade

Under the project directory

• Start server

python manage.py runserver