# Error Responses

| #   | meaning            |
| --- | ------------------ |
| -1  | UserNotFound       |
| -2  | WrongPassword      |
| -3  | InvalidRequest     |
| -4  | WrongAdminPassword |
| -5  | NameTooLong        |
| -6  | UserAlreadyExists  |
| -7  | InsufficientFunds  |

# Things of Note
* all endpoints respond with **JSON** file type
* "**A**" denotes requiring Authentication in the form of a header titled "**Password**"

# Usage
|      Name      | Path                              | Method |   A   | Description                                                                                                                 |
| :------------: | :-------------------------------- | :----: | :---: | --------------------------------------------------------------------------------------------------------------------------- |
|     GetBal     | /{name}/bal                       |  GET   | true  | returns the balance of a given user `{name}`                                                                                |
|     GetLog     | /{name}/log                       |  GET   | true  | returns a list of last `n` number of transactions (a configurable amount) of a given user `{name}`                          |
|   SendFunds    | /{name}/send/{to}/amount={amount} |  POST  | false | sends `{amount}` from user `{name}` to user `{to}`                                                                          |
| VerifyPassword | /{name}/pass/verify               |  GET   | true  | returns `true` or `false` depending on if the supplied user `{name}`'s password matches the password supplied in the header |

# Meta Usage
|      Name      | Path                              | Method |   A   | Description                                                                                                                              |
| :------------: | :-------------------------------- | :----: | :---: | ---------------------------------------------------------------------------------------------------------------------------------------- |
| ChangePassword | /{name}/pass/change               | PATCH  | true  | if the password supplied in the header matches the user `{name}`'s password, the user's password is changed to the one given in the body |
|     SetBal     | /admin/{name}/bal/amount={amount} | PATCH  | true  | sets the balance of a give user `{name}` if the supplied password matches the admin password                                             |

# System Usage
|      Name       | Path             | Method |   A   | Description                                                                                              |
| :-------------: | :--------------- | :----: | :---: | -------------------------------------------------------------------------------------------------------- |
|      Help       | /help            |  GET   | false | the page you're looking at right now!                                                                    |
|      Close      | /admin/close     |  POST  | true  | saves and then closes the program if the supplied password matches the admin password                    |
|    Contains     | /contains/{name} |  GET   | false | returns `true` or `false` depending on if the supplied user `{name}` exists                              |
| AdminVerifyPass | /admin/verify    |  GET   | true  | returns `true` or `false` depending on if the password supplied in the header matches the admin password |

# User Management
|     Name     | Path                                   | Method |   A   | Description                                                                                                                                                                                  |
| :----------: | :------------------------------------- | :----: | :---: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|   AddUser    | /user/{name}                           |  POST  | true  | registers a user with the name `{name}`, balance of 0 and a password of the password supplied in the header                                                                                  |
| AdminAddUser | /admin/user/{name}?init_bal={init_bal} |  POST  | true  | if the password supplied in the header matches the admin password, then it registers a user with the name `{name}`, balance of `init_bal` and a password supplied by the body of the request |
|   DelUser    | /user/{name}                           | DELETE | true  | if the password supplied in the header matches the user `{name}`'s password, then the user is deleted                                                                                        |
| AdminDelUser | /admin/user/{name}                     | DELETE | true  | if the password supplied in the header matches the admin password, then the user is deleted                                                                                                  |