Skip to content

Requests-Documentation.md

Latest commit

 

History

History
885 lines (719 loc) · 15.4 KB

Requests-Documentation.md

File metadata and controls

885 lines (719 loc) · 15.4 KB
Raw

Requests Documentation

This document describes the requests that can be sent to the server and the responses that can be received from the server.

1. Login Request

Send Request:

{
    "Request": 1,
    "Data":
        {
        "email": "user@example.com",
        "password": "pass"
        }
}

Receive Response:

On Success:

{
    "Response": 1,
    "Data": {
        "status": 1,
        "first_name": "User",
        "role": "user",
        "message": "Login successful"
    }
}

On Failure:

{
    "Response": 1,
    "Data": {
        "status": 0
        "message": "email not found"
    }
}

Or

{
    "Response": 1,
    "Data": {
        "status": 0
        "message": "Invalid password"
    }
}

Sequence diagram : LoginRequest processes login request

LoginRequest

2. Get Account Number (for Logged-in user)

Send Request:

{
    "Request": 2,
    "Data": {
        "email": "user@mail.com"
    }
}

Receive Response:

On Success:

{
    "Response": 2,
    "Data": {
		 "status": 1,
        "account_number": 123456789
    }
}

On Failure:

{
    "Response": 2,
    "Data": {
		 "status": 0,
        "message": "No account found"
        }
}

or

{
    "Response": 2,
    "Data": {
		 "status": 0,
        "message": "email not found"
        }
}

3. Get Balance

Send Request:

{
    "Request": 3,
    "Data": {
        "account_number": 123456789
    }
}

Receive Response:

On Success:

{
    "Response": 3,
    "Data": {
	    "status": 1,
		"message": "Balance fetched successfully",
        "balance": 500.0     
    }
}

On Failure: (will not Usually happen)

{
    "Response": 3,
    "Data": {
		 "status": 0,
        "message": "Account not found"
    }
}

Sequence diagram : GetBalanceRequest processes get balance request

GetBalanceRequest

4. Get Transactions History

Send Request:

As User:

{
    "Request": 4,
    "Data": {
		"email": "email@test.com"
    }
}

As Admin:

{
    "Request": 4,
    "Data": {
		"email": "admin@test.com"
    }
}

Receive Response:

As User:

{
    "Request": 4,
    "Data": {
		 "status": 1,
		"message": "Transaction history retrieved for account number 123456789",
        "List":
            [  // User will get transactions to or from his account only
                {
					"from_account_number": 123456789,
                    "to_account_number": 987654321,
                    "transaction_amount": 100.0,
                    "created_at": "2021-01-01"
                },
                {
					"from_account_number": 987654321,
                    "to_account_number": 123456789,
                    "transaction_amount": 130.0,
                    "created_at": "2021-01-03"
                }
            ]
        }
 }

As Admin:

{
    "Request": 4,
    "Data": {
		 "status": 1,
		"message": "Transaction history retrieved for all users",
         "List":
            [  // Admin will get all transactions in the database
                {
					"from_account_number": 123456789,
                    "to_account_number": 987654321,
                    "transaction_amount": 100.0,
                    "created_at": "2021-01-01"
                },
                {
					"from_account_number": 987654321,
                    "to_account_number": 123456789,
                    "transaction_amount": 130.0,
                    "created_at": "2021-01-03"
                },
                {
					"from_account_number": 4343656567,
                    "to_account_number": 123232324,
                    "transaction_amount": 1435.0,
                    "created_at": "2021-01-03"
                }
            ]
        }
 }

Sequence diagram : GetTransactionsHistoryRequest processes get transactions history request

GetTransactionsHistoryRequest

5. Make Transaction

Send Request:

Using email:

{
    "Request": 5,
    "Data": {
		"from_account_number": 123456789,
        "to_account_number": -1,
		"to_email": "user@mail.com",
        "transaction_amount": 100.0
    }
}

Using account number:

{
    "Request": 5,
    "Data": {
		"from_account_number": 123456789,
        "to_account_number": 1222255555,
		"to_email": "",
        "transaction_amount": 100.0
    }
}

Receive Response:

On Success:

{

    "Response": 5,
    "Data": {
        "status": 1,
        "message": "Transaction successful"
    }
}

On Failure:

{
    "Response": 5,
    "Data": {
        "status": 0,
        "message": "Insufficient balance"
    }
}

Sequence diagram : MakeTransactionRequest processes make transaction request

MakeTransactionRequest

6. Transfer Amount (not currently implemented)

Send Request:

{
    "Request": 6,
    "Data": {
        "from_account_number": 123456789,
        "to_account_number": 987654321,
        "transferAmount": "+50.0"
    }
}

or

{
    "Request": 6,
    "Data": {
        "from_account_number": 123456789,
        "to_account_number": 987654321,
        "transferAmount": "-50.0"
    }
}

Receive Response:

On Success:

{
    "Response": 6,
    "Data": {
        "status": 1,
        "message": "Transfer successful"
    }
}

On Failure:

{
    "Response": 6,
    "Data": {
        "status": 0,
        "message": "Insufficient balance"
    }
}

or

{
    "Response": 6,
    "Data": {
        "status": 0,
        "message": "Account not found"
    }
}

7. Get Database (for admin)

Send Request:

{
    "Request": 7,
    "Data": {
        "email": "admin@mail.com",
    }
}

Receive Response:

On Success:

{
    "Response": 7,
    "Data": {
		"status": 1,
		"message": "Database fetched successfully",
        "users": [
            {
                "account_number": 123456789, // NULL if admin
                "first_name": "Admin",
                "last_name": "User",
                "email": "email@mail.com",
                "role": "user",
                "balance": 500.0
            },
            {
                "account_number": NULL, // NULL if admin
                "first_name": "User",
                "last_name": "User",
                "email": "admin@mail.com",
                "role": "admin",
                "balance": 500.0
            }
        ]
    }
}

On Failure:

{
	    "Response": 7,
	    "Data": {
			"status": 0,
        	 "message": "Cannot get database. User is not an admin",
	    }
}

or

{
	    "Response": 7,
	    "Data": {
			"status": 0,
        	 "message": "No data found",
	    }
}

Sequence diagram : GetDatabaseRequest processes get database request

GetDatabaseRequest

8. Create New User (for admin)

Send Request:

{
    "Request": 8,
    "Data": {
        "email": "admin@mail.com",
        "newUser": [
            {
                "first_name": "New",
                "last_name": "User",
                "email": "newuser@example.com",
                "password": "newpass",
                "role": "user",
                "initial_balance": 500.0
            }
        ],
    }
}

Receive Response:

On Success:

{
    "Response": 8,
    "Data": {
        "status": 1,
        "message": "New user created successfully"
    }
}

or

{
    "Response": 8,
    "Data": {
        "status": 1,
        "message": "New admin created successfully"
    }
}

On Failure:

{
    "Response": 8,
    "Data": {
        "status": 0,
        "message": "User already exists"
    }
}

or

{
    "Response": 8,
    "Data": {
        "status": 0,
        "message": "Cannot create new user. User is not an admin"
    }
}

or

{
    "Response": 8,
    "Data": {
        "status": 0,
        "message": "Missing required fields"
    }
}

or

{
    "Response": 8,
    "Data": {
        "status": 0,
        "message": "Invalid role"
    }
}

or

{
    "Response": 8,
    "Data": {
        "status": 0,
        "message": "Admin can't have account and initial balance"
    }
}

Sequence diagram : CreateNewUserRequest processes create new user request

CreateNewUserRequest

9. Delete User (for admin)

Send Request:

{
    "Request": 9,
    "Data": {
        "email": "admin@mail.com",
        "account_number": 123456789
    }
}

Receive Response:

On Success:

{
    "Response": 9,
    "Data": {
        "status": 1,
        "message": "User deleted successfully"
    }
}

On Failure:

{
    "Response": 9,
    "Data": {
        "status": 0,
        "message": "Account number does not exist"
    }
}
{
    "Response": 9,
    "Data": {
        "status": 0,
        "message": "Unauthorized, Cannot delete user."
    }
}

Sequence diagram : DeleteUserRequest processes delete user request

DeleteUserRequest

10. Update User (for admin)

Send Request:

{
    "Request": 10,
    "Data": {
        "email": "admin@mail.com",
        "account_number": 123456789,
        "newData": {
            "first_name": "Updated",
            "last_name": "User",
            "email": "updateduser@example.com",
            "role": "admin"
        }
    }
}

Receive Response:

On Success:

{
    "Response": 10,
    "Data": {
        "status": 1,
        "message": "User updated successfully"
    }
}

On Failure:

{
    "Response": 10,
    "Data": {
        "status": 0,
        "message": "Account number does not exist"
    }
}

or

{
    "Response": 10,
    "Data": {
        "status": 0,
        "message": "Unauthorized, Cannot update user"
    }
}

or

{
    "Response": 10,
    "Data": {
        "status": 0,
        "message": "Failed to update user"
    }
}

Sequence diagram : UpdateUserRequest processes update user request

UpdateUserRequest

Special Requests

11. Init Rquest

{
    "Request": 11,
    "Data":
        {
        "email": "user@example.com",
        "password": "pass"
        }
}

Receive Response:

on Success:

As User
{
    "Request": 11,
    "Data": {
		"status": 1,
		"first_name": "ahmed",
		"role": "user",
        "account_number": 123456789,
        "current_balance": 500.0,
        "List": // List of history transactions
            [
                {
                    "to_account_number": 987654321,
                    "transaction_amount": 100.0,
					"transaction_type": "+", // "+" for deposit
                    "created_at": "2021-01-01"
                },
                {
                    "to_account_number": 987612321,
                    "transaction_amount": 130.0,
					"transaction_type": "Withdrawal", // "-" for withdrawal
                    "created_at": "2021-01-03"
                }
            ]
        }
}
As Admin
{
    "Request": 11,
    "Data": {
		"status": 1,
		"first_name": "ahmed",
		"role": "admin",
        "List": // List of database users
          [
           {
                "account_number": 123456789, // NULL if admin
                "first_name": "Admin",
                "last_name": "User",
                "email": "email@mail.com",
                "role": "user",
                "balance": 500.0
            },
            {
                "account_number": NULL, // NULL if admin
                "first_name": "User",
                "last_name": "User",
                "email": "admin@mail.com",
                "role": "admin",
                "balance": 500.0
            }
           ]
      }
}

Sequence diagram : UserInitRequest processes user initialization request (for user and admin widgets)

UserInitRequest

12. Update email

Send Request:

{
    "Request": 12,
    "Data":
        {
        "email": "user@example.com",
        "password": "pass",
        "new_email": "newmail@example.com"
        }
}

Receive Response:

on Success:

{
    "Response": 12,
    "Data": {
        "status": 1,
        "message": "Email updated successfully"
    }
}

on Failure:

{
    "Response": 12,
    "Data": {
        "status": 0,
        "message": "Email already exists"
    }
}

or

{
    "Response": 12,
    "Data": {
        "status": 0,
        "message": "Invalid password"
    }
}

Sequence diagram : UpdateEmailRequest processes update email request

UpdateEmailRequest

12. Update Password

Send Request:

{
    "Request": 13,
    "Data":
        {
        "email": "user@example.com",
        "password": "pass",
        "new_password": "newPass"
        }
}

Receive Response:

on Success:

{
    "Response": 12,
    "Data": {
        "status": 1,
        "message": "Password updated successfully"
    }
}

on Failure:

{
    "Response": 12,
    "Data": {
        "status": 0,
        "message": "Invalid password"
    }
}

Sequence diagram : UpdatePasswordRequest processes update password request

UpdatePasswordRequest