diff --git a/help.html b/help.html index 15acbe4..a233d6e 100644 --- a/help.html +++ b/help.html @@ -1,85 +1,198 @@ - -

ALL FUNCTIONS (that have args) ARE EXPECTING JSON AS DATA TYPE

-

/BankF/admin/close (POST)

-

 attempt  - admin password

-
-

Closes and Saves the server.

-
-

/BankF/user (POST)

-

 name  - name of the user being added (must be less then 50 characters)

-

 init_pass  - initial password for the user being added

-
-

Adds a user to the bank

-
-

/BankF/admin/user (POST)

-

 name  - name of the user being added

-

 attempt  - admin password required to add user with balance

-

 init_bal  - initial balance for user being added

-

 init_pass  - initial password for user being added

-
-

Adds a user with initial balance

-
-

/BankF/sendfunds (POST)

-

 a_name  - sender's name

-

 b_name  - reciever's name

-

 amount  - amount being sent

-

 attempt  - password of sender

-
-

Sends money from one user to another

-
-

/BankF/changepass (PATCH)

-

 name  - name of user's password being changes

-

 attempt  - password of user being changed

-

 new_pass  - new password to replace the current user's password

-
-

Changes password of a user, returns -1 if user doesnt exist

-
-

/BankF/admin/{name}/bal (PATCH)

-

 name  - the name of the user being set

-

 attempt  - the admin password required

-

 amount  - the new balance of the user

-
-

Sets the balance of a user

-
-

/BankF/help (GET)

-
-

the page you're looking at right now!

-
-

/BankF/vpass (POST)

-

 name  - name of user being verified

-

 attempt  - password being verified

-
-

returns 0 or 1 based on if [attempt] is equal to the password of the user [name], or -1 if user does not exist. The intended usage for this function is for connected services

-
-

/BankF/contains/{name} (GET)

-
-

returns a 0 or 1 based on if the bank contains the user

-
-

/BankF/{name}/bal (GET)

-
-

returns the balance of a given user's name, if -1 that means the user does not exist

-
-

/BankF/admin/vpass (POST)

-

 attempt  - admin password

-
-

Verifies if password entered is admin password

-
-

/BankF/{name}/log (POST)

-

 attempt  - user password

-
-

returns a list of last 100 transactions, -1 if user not found, 0 if invalid password

-
-

/BankF/user (DELETE)

-

 name  - name of user being deleted

-

 attempt  - password of user being deleted

-
-

Deletes a user with the password of the user as verification

-
-

/BankF/admin/user (DELETE)

-

 name  - name of user being deleted

-

 attempt  - admin password

-
-

Deletes a user with admin password as verification

-
- - +

Error Responses

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

Things of Note

+ +

Usage

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NamePathMethodADescription
GetBal/{name}/balGETtruereturns the balance of a given user {name}
GetLog/{name}/logGETtruereturns a list of last n number of transactions (a configurable amount) of a given user {name}
SendFunds/{name}/send/{to}/amount={amount}POSTfalsesends {amount} from user {name} to user {to}
VerifyPassword/{name}/pass/verifyGETtruereturns true or false depending on if the supplied user {name}'s password matches the password supplied in the header
+

Meta Usage

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NamePathMethodADescription
ChangePassword/{name}/pass/changePATCHtrueif 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}PATCHtruesets the balance of a give user {name} if the supplied password matches the admin password
+

System Usage

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NamePathMethodADescription
Help/helpGETfalsethe page you’re looking at right now!
Close/admin/closePOSTtruesaves and then closes the program if the supplied password matches the admin password
Contains/contains/{name}GETfalsereturns true or false depending on if the supplied user {name} exists
AdminVerifyPass/admin/verifyGETtruereturns true or false depending on if the password supplied in the header matches the admin password
+

User Management

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NamePathMethodADescription
AddUser/user/{name}POSTtrueregisters 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}POSTtrueif 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}DELETEtrueif the password supplied in the header matches the user {name}'s password, then the user is deleted
AdminDelUser/admin/user/{name}DELETEtrueif the password supplied in the header matches the admin password, then the user is deleted
\ No newline at end of file