Domestic Violence Empathy Builder v1.0.0

API for the empathy builder calculator for freeform.org.

• Auth

  • Login registered user
  • Register new user

• Budgets

  • Delete a budget
  • Get all lines for specific budget
  • Get all budgets
  • Create lines for specific budget
  • Post new budget
  • Edit lines for specific budget
  • Edit budget name

• Categories

  • Delete a specific category
  • Get all categories
  • Add a new category
  • Edit a specific category

Auth

Login registered user

POST auth/login

Parameters

Name	Type	Description
username	String	User's username
password	String	User's password

Success Response

Success-Response:

HTTP 201 Created
{
    "user_id": 3,
    "username": "abc123",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJqZWN0IjoxLCJ1c2VybmFtZSI6InRlc3QxIiwiaWF0IjoxNTY3MDE4OTcxLCJleHAiOjE1NjcwMzMzNzF9.75Q_EUManFaIczoccxkSC9LgFRm-zC5w3eeAHuhIWsg"
}

Error Response

Error-Response

HTTP 400 MissingData
{
    "error": "Please send both username and password."
}

Register new user

POST auth/register

Parameters

Name	Type	Description
username	String	User's unique username
password	String	User's password

Success Response

Success-Response:

HTTP 201 Created
{
    "user_id": 3,
    "username": "abc123"
}

Error Response

Error-Response

HTTP 400 MissingData
{
    "error": "Please send both username and password."
}

Budgets

Delete a budget

DEL budgets/:id

Headers

Name	Type	Description
authorization	String	User's unique authorization token

Success Response

Success-Response:

     HTTP 200 OK
[
   {
       "budget_name_id": 1,
       "budget_name": "Denver",
       "created_at": "2019-08-26T19:49:28.206Z",
       "updated_at": "2019-08-26T19:49:28.206Z",
       "user_id": 1
   }
]

Error Response

Error-Response

HTTP 400 MissingToken
{
    "error": "No token provided. Please include a token in your authorization header."
}

Get all lines for specific budget

GET budgets/:id

Headers

Name	Type	Description
authorization	String	User's unique authorization token

Success Response

Success-Response:

     HTTP 200 OK
[
   {
       "line_id": 1,
       "amount": 80,
       "category_id": 1,
       "category_name": "Car Payment"
   },
   {
       "line_id": 4,
       "amount": 0,
       "category_id": 2,
       "category_name": "Car Insurance"
   },
   {
       "line_id": 7,
       "amount": 0,
       "category_id": 3,
       "category_name": "Gas & Car Maintenance"
   },
]

Error Response

Error-Response

HTTP 400 MissingToken
{
    "error": "No token provided. Please include a token in your authorization header."
}

Get all budgets

GET budgets/

Headers

Name	Type	Description
authorization	String	User's unique authorization token

Success Response

Success-Response:

     HTTP 200 OK
[
   {
       "budget_name_id": 1,
       "budget_name": "Denver",
       "created_at": "2019-08-26T19:49:28.206Z",
       "updated_at": "2019-08-26T19:49:28.206Z",
       "user_id": 1
   }
]

Error Response

Error-Response

HTTP 400 MissingToken
{
    "error": "No token provided. Please include a token in your authorization header."
}

Create lines for specific budget

POST budgets/:id

Headers

Name	Type	Description
authorization	String	User's unique authorization token

Success Response

Success-Response:

     HTTP 200 OK
[
   {
       "line_id": 1,
       "amount": 80,
       "category_id": 1,
       "category_name": "Car Payment"
   },
   {
       "line_id": 4,
       "amount": 0,
       "category_id": 2,
       "category_name": "Car Insurance"
   },
   {
       "line_id": 7,
       "amount": 0,
       "category_id": 3,
       "category_name": "Gas & Car Maintenance"
   },
]

Error Response

Error-Response

HTTP 400 MissingToken
{
    "error": "No token provided. Please include a token in your authorization header."
}

Post new budget

POST budgets/

Headers

Name	Type	Description
authorization	String	User's unique authorization token

Success Response

Success-Response:

  HTTP 200 OK

{
    "budget_name_id": 1,
    "budget_name": "Denver",
    "created_at": "2019-08-26T19:49:28.206Z",
    "updated_at": "2019-08-26T19:49:28.206Z",
    "user_id": 1
}

Error Response

Error-Response

HTTP 400 MissingToken
{
    "error": "No token provided. Please include a token in your authorization header."
}

Edit lines for specific budget

PUT budgets/:id/lines

Headers

Name	Type	Description
authorization	String	User's unique authorization token

Success Response

Success-Response:

     HTTP 200 OK
[
   {
       "line_id": 1,
       "amount": 80,
       "category_id": 1,
       "category_name": "Car Payment"
   },
   {
       "line_id": 4,
       "amount": 0,
       "category_id": 2,
       "category_name": "Car Insurance"
   },
   {
       "line_id": 7,
       "amount": 0,
       "category_id": 3,
       "category_name": "Gas & Car Maintenance"
   },
]

Error Response

Error-Response

HTTP 400 MissingToken
{
    "error": "No token provided. Please include a token in your authorization header."
}

Edit budget name

PUT budgets/:id

Headers

Name	Type	Description
authorization	String	User's unique authorization token

Success Response

Success-Response:

     HTTP 200 OK
[
   {
       "budget_name_id": 1,
       "budget_name": "Denver",
       "created_at": "2019-08-26T19:49:28.206Z",
       "updated_at": "2019-08-26T19:49:28.206Z",
       "user_id": 1
   }
]

Error Response

Error-Response

HTTP 400 MissingToken
{
    "error": "No token provided. Please include a token in your authorization header."
}

Categories

Delete a specific category

DELETE categories/:id

Headers

Name	Type	Description
authorization	String	User's unique authorization token

Parameters

Name	Type	Description
ID	Number	Category's ID

Success Response

Success-Response:

HTTP 200 OK
[
     {
         "category_id": 1,
         "category_name": "Car Payment",
         "category_type": "Personal",
         "user_id": null
     },
    {
        "category_id": 2,
        "category_name": "Car Insurance",
        "category_type": "Personal",
        "user_id": null
    },
    {
        "category_id": 3,
        "category_name": "Gas & Car Maintenance",
        "category_type": "Personal",
        "user_id": null
    }
]

Error Response

Error-Response

HTTP 400 MissingToken
{
    "error": "No token provided. Please include a token in your authorization header."
}

Get all categories

GET categories/

Headers

Name	Type	Description
authorization	String	User's unique authorization token

Success Response

Success-Response:

HTTP 200 OK
[
     {
         "category_id": 1,
         "category_name": "Car Payment",
         "category_type": "Personal",
         "user_id": null
     },
    {
        "category_id": 2,
        "category_name": "Car Insurance",
        "category_type": "Personal",
        "user_id": null
    },
    {
        "category_id": 3,
        "category_name": "Gas & Car Maintenance",
        "category_type": "Personal",
        "user_id": null
    }
]

Error Response

Error-Response

HTTP 400 MissingToken
{
    "error": "No token provided. Please include a token in your authorization header."
}

Add a new category

POST categories/

Headers

Name	Type	Description
authorization	String	User's unique authorization token

Parameters

Name	Type	Description
category_name	String	Category's name
category_type	String	Either personal or relocation

Success Response

Success-Response:

HTTP 201 Created
{
    "category_id": 24,
    "category_name": "Test234",
    "category_type": "Personal",
    "user_id": 1
 }

Error Response

Error-Response

HTTP 400 MissingToken
{
    "error": "No token provided. Please include a token in your authorization header."
}

Edit a specific category

PUT categories/:id

Headers

Name	Type	Description
authorization	String	User's unique authorization token

Parameters

Name	Type	Description
ID	Number	Category's unique ID
category_name	String	Category's name
category_type	String	Either personal or relocation

Success Response

Success-Response:

HTTP 200 OK
[
     {
         "category_id": 1,
         "category_name": "Car Payment",
         "category_type": "Personal",
         "user_id": null
     },
    {
        "category_id": 2,
        "category_name": "Car Insurance",
        "category_type": "Personal",
        "user_id": null
    },
    {
        "category_id": 3,
        "category_name": "Gas & Car Maintenance",
        "category_type": "Personal",
        "user_id": null
    }
]

Error Response

Error-Response

HTTP 400 MissingToken
{
    "error": "No token provided. Please include a token in your authorization header."
}