diff --git a/help.html b/help.html index 2521c41..15acbe4 100644 --- a/help.html +++ b/help.html @@ -1,45 +1,43 @@ - -

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

-

/BankF/admin/close (POST)

-

 attempt  - admin password

+

/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

+

 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

+

/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

+

 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

+

 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

+

/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

@@ -48,38 +46,38 @@

the page you're looking at right now!

/BankF/vpass (POST)

-

 name  - name of user being verified

-

 attempt  - password being verified

+

 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)

+

/BankF/contains/{name} (GET)

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

-

/BankF/{name}/bal (GET)

+

/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

+

/BankF/admin/vpass (POST)

+

 attempt  - admin password

Verifies if password entered is admin password

-

/BankF/{name}/log (POST)

-

 attempt  - user 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

+

 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

+

/BankF/admin/user (DELETE)

+

 name  - name of user being deleted

+

 attempt  - admin password

Deletes a user with admin password as verification