Agamiru/rich_oak_test

rich_oak_test

Front end url = https://rich-oak-app.codemagic.app

RICH OAK APP TEST API DOCUMENTATION

Access

Methods

[ Jump to Models ]

Table of Contents

Accounts

• post /accounts/
• delete /accounts/{user_id}/
• get /accounts/
• patch /accounts/{user_id}/
• get /accounts/{user_id}/
• put /accounts/{user_id}/

Api

• post /api/token/
• post /api/token/refresh/

User

• post /user/
• delete /user/{id}/
• get /user/
• patch /user/{id}/
• get /user/{id}/
• put /user/{id}/

Accounts

Up

post /accounts/

(createAccountDetails)

Consumes

​ This API call consumes the following media types via the Content-Type request header:

• application/json
• application/x-www-form-urlencoded
• multipart/form-data

Request body

body AccountDetails (optional)

Body Parameter —

Form parameters

id (optional)

Form Parameter —

user (optional)

Form Parameter —

bank_details (optional)

Form Parameter —

account_balance (optional)

Form Parameter —

id (optional)

Form Parameter —

user (optional)

Form Parameter —

bank_details (optional)

Form Parameter —

account_balance (optional)

Form Parameter —

Return type

​ AccountDetails

Example data

Content-Type: application/json

{
  "account_balance" : 2.3021358869347655,
  "bank_details" : {
    "bank_code" : "bank_code",
    "credit_card" : 5,
    "name" : "name",
    "id" : 5
  },
  "id" : 0,
  "user" : {
    "is_superuser" : true,
    "is_active" : true,
    "user_permissions" : [ "user_permissions", "user_permissions" ],
    "is_staff" : true,
    "last_login" : "2000-01-23T04:56:07.000+00:00",
    "last_name" : "last_name",
    "groups" : [ "groups", "groups" ],
    "id" : 6,
    "date_joined" : "2000-01-23T04:56:07.000+00:00",
    "bvn" : 1,
    "first_name" : "first_name",
    "email" : ""
  }
}

Produces

​ This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

201

AccountDetails

---

Up

delete /accounts/{user_id}/

(destroyAccountDetails)

Path parameters

user_id (required)

Path Parameter —

Responses

204

---

Up

get /accounts/

(listAccountDetails)

Return type

​ array[AccountDetails]

Example data

Content-Type: application/json

[ {
  "account_balance" : 2.3021358869347655,
  "bank_details" : {
    "bank_code" : "bank_code",
    "credit_card" : 5,
    "name" : "name",
    "id" : 5
  },
  "id" : 0,
  "user" : {
    "is_superuser" : true,
    "is_active" : true,
    "user_permissions" : [ "user_permissions", "user_permissions" ],
    "is_staff" : true,
    "last_login" : "2000-01-23T04:56:07.000+00:00",
    "last_name" : "last_name",
    "groups" : [ "groups", "groups" ],
    "id" : 6,
    "date_joined" : "2000-01-23T04:56:07.000+00:00",
    "bvn" : 1,
    "first_name" : "first_name",
    "email" : ""
  }
}, {
  "account_balance" : 2.3021358869347655,
  "bank_details" : {
    "bank_code" : "bank_code",
    "credit_card" : 5,
    "name" : "name",
    "id" : 5
  },
  "id" : 0,
  "user" : {
    "is_superuser" : true,
    "is_active" : true,
    "user_permissions" : [ "user_permissions", "user_permissions" ],
    "is_staff" : true,
    "last_login" : "2000-01-23T04:56:07.000+00:00",
    "last_name" : "last_name",
    "groups" : [ "groups", "groups" ],
    "id" : 6,
    "date_joined" : "2000-01-23T04:56:07.000+00:00",
    "bvn" : 1,
    "first_name" : "first_name",
    "email" : ""
  }
} ]

Produces

​ This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

---

Up

patch /accounts/{user_id}/

(partialUpdateAccountDetails)

Path parameters

user_id (required)

Path Parameter —

Consumes

​ This API call consumes the following media types via the Content-Type request header:

• application/json
• application/x-www-form-urlencoded
• multipart/form-data

Request body

body AccountDetails (optional)

Body Parameter —

Form parameters

id (optional)

Form Parameter —

user (optional)

Form Parameter —

bank_details (optional)

Form Parameter —

account_balance (optional)

Form Parameter —

id (optional)

Form Parameter —

user (optional)

Form Parameter —

bank_details (optional)

Form Parameter —

account_balance (optional)

Form Parameter —

Return type

​ AccountDetails

Example data

Content-Type: application/json

{
  "account_balance" : 2.3021358869347655,
  "bank_details" : {
    "bank_code" : "bank_code",
    "credit_card" : 5,
    "name" : "name",
    "id" : 5
  },
  "id" : 0,
  "user" : {
    "is_superuser" : true,
    "is_active" : true,
    "user_permissions" : [ "user_permissions", "user_permissions" ],
    "is_staff" : true,
    "last_login" : "2000-01-23T04:56:07.000+00:00",
    "last_name" : "last_name",
    "groups" : [ "groups", "groups" ],
    "id" : 6,
    "date_joined" : "2000-01-23T04:56:07.000+00:00",
    "bvn" : 1,
    "first_name" : "first_name",
    "email" : ""
  }
}

Produces

​ This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

AccountDetails

---

Up

get /accounts/{user_id}/

(retrieveAccountDetails)

Path parameters

user_id (required)

Path Parameter —

Return type

​ AccountDetails

Example data

Content-Type: application/json

{
  "account_balance" : 2.3021358869347655,
  "bank_details" : {
    "bank_code" : "bank_code",
    "credit_card" : 5,
    "name" : "name",
    "id" : 5
  },
  "id" : 0,
  "user" : {
    "is_superuser" : true,
    "is_active" : true,
    "user_permissions" : [ "user_permissions", "user_permissions" ],
    "is_staff" : true,
    "last_login" : "2000-01-23T04:56:07.000+00:00",
    "last_name" : "last_name",
    "groups" : [ "groups", "groups" ],
    "id" : 6,
    "date_joined" : "2000-01-23T04:56:07.000+00:00",
    "bvn" : 1,
    "first_name" : "first_name",
    "email" : ""
  }
}

Produces

​ This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

AccountDetails

---

Up

put /accounts/{user_id}/

(updateAccountDetails)

Path parameters

user_id (required)

Path Parameter —

Consumes

​ This API call consumes the following media types via the Content-Type request header:

• application/json
• application/x-www-form-urlencoded
• multipart/form-data

Request body

body AccountDetails (optional)

Body Parameter —

Form parameters

id (optional)

Form Parameter —

user (optional)

Form Parameter —

bank_details (optional)

Form Parameter —

account_balance (optional)

Form Parameter —

id (optional)

Form Parameter —

user (optional)

Form Parameter —

bank_details (optional)

Form Parameter —

account_balance (optional)

Form Parameter —

Return type

​ AccountDetails

Example data

Content-Type: application/json

{
  "account_balance" : 2.3021358869347655,
  "bank_details" : {
    "bank_code" : "bank_code",
    "credit_card" : 5,
    "name" : "name",
    "id" : 5
  },
  "id" : 0,
  "user" : {
    "is_superuser" : true,
    "is_active" : true,
    "user_permissions" : [ "user_permissions", "user_permissions" ],
    "is_staff" : true,
    "last_login" : "2000-01-23T04:56:07.000+00:00",
    "last_name" : "last_name",
    "groups" : [ "groups", "groups" ],
    "id" : 6,
    "date_joined" : "2000-01-23T04:56:07.000+00:00",
    "bvn" : 1,
    "first_name" : "first_name",
    "email" : ""
  }
}

Produces

​ This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

AccountDetails

---

Api

Up

post /api/token/

(createTokenObtainPair)

Takes a set of user credentials and returns an access and refresh JSON web token pair to prove the authentication of those credentials.

Consumes

​ This API call consumes the following media types via the Content-Type request header:

• application/json
• application/x-www-form-urlencoded
• multipart/form-data

Request body

body TokenObtainPair (optional)

Body Parameter —

Form parameters

email (optional)

Form Parameter —

password (optional)

Form Parameter —

email (optional)

Form Parameter —

password (optional)

Form Parameter —

Return type

​ TokenObtainPair

Example data

Content-Type: application/json

{
  "password" : "password",
  "email" : "email"
}

Produces

​ This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

201

TokenObtainPair

---

Up

post /api/token/refresh/

(createTokenRefresh)

Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.

Consumes

​ This API call consumes the following media types via the Content-Type request header:

• application/json
• application/x-www-form-urlencoded
• multipart/form-data

Request body

body TokenRefresh (optional)

Body Parameter —

Form parameters

refresh (optional)

Form Parameter —

refresh (optional)

Form Parameter —

Return type

​ TokenRefresh

Example data

Content-Type: application/json

{
  "refresh" : "refresh"
}

Produces

​ This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

201

TokenRefresh

---

User

Up

post /user/

(createUser)

Consumes

​ This API call consumes the following media types via the Content-Type request header:

• application/json
• application/x-www-form-urlencoded
• multipart/form-data

Request body

body User (optional)

Body Parameter —

Form parameters

id (optional)

Form Parameter —

last_login (optional)

Form Parameter — format: date-time

is_superuser (optional)

Form Parameter —

is_staff (optional)

Form Parameter —

is_active (optional)

Form Parameter —

date_joined (optional)

Form Parameter — format: date-time

email (optional)

Form Parameter — format: email

first_name (optional)

Form Parameter —

last_name (optional)

Form Parameter —

bvn (optional)

Form Parameter —

groups (optional)

Form Parameter —

user_permissions (optional)

Form Parameter —

id (optional)

Form Parameter —

last_login (optional)

Form Parameter — format: date-time

is_superuser (optional)

Form Parameter —

is_staff (optional)

Form Parameter —

is_active (optional)

Form Parameter —

date_joined (optional)

Form Parameter — format: date-time

email (optional)

Form Parameter — format: email

first_name (optional)

Form Parameter —

last_name (optional)

Form Parameter —

bvn (optional)

Form Parameter —

groups (optional)

Form Parameter —

user_permissions (optional)

Form Parameter —

Return type

​ User

Example data

Content-Type: application/json

{
  "is_superuser" : true,
  "is_active" : true,
  "user_permissions" : [ "user_permissions", "user_permissions" ],
  "is_staff" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "last_name" : "last_name",
  "groups" : [ "groups", "groups" ],
  "id" : 0,
  "date_joined" : "2000-01-23T04:56:07.000+00:00",
  "bvn" : 6,
  "first_name" : "first_name",
  "email" : ""
}

Produces

​ This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

201

User

---

Up

delete /user/{id}/

(destroyUser)

Path parameters

id (required)

Path Parameter — A unique integer value identifying this user.

Responses

204

---

Up

get /user/

(listUsers)

Return type

​ array[User]

Example data

Content-Type: application/json

[ {
  "is_superuser" : true,
  "is_active" : true,
  "user_permissions" : [ "user_permissions", "user_permissions" ],
  "is_staff" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "last_name" : "last_name",
  "groups" : [ "groups", "groups" ],
  "id" : 0,
  "date_joined" : "2000-01-23T04:56:07.000+00:00",
  "bvn" : 6,
  "first_name" : "first_name",
  "email" : ""
}, {
  "is_superuser" : true,
  "is_active" : true,
  "user_permissions" : [ "user_permissions", "user_permissions" ],
  "is_staff" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "last_name" : "last_name",
  "groups" : [ "groups", "groups" ],
  "id" : 0,
  "date_joined" : "2000-01-23T04:56:07.000+00:00",
  "bvn" : 6,
  "first_name" : "first_name",
  "email" : ""
} ]

Produces

​ This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

---

Up

patch /user/{id}/

(partialUpdateUser)

Path parameters

id (required)

Path Parameter — A unique integer value identifying this user.

Consumes

​ This API call consumes the following media types via the Content-Type request header:

• application/json
• application/x-www-form-urlencoded
• multipart/form-data

Request body

body User (optional)

Body Parameter —

Form parameters

id (optional)

Form Parameter —

last_login (optional)

Form Parameter — format: date-time

is_superuser (optional)

Form Parameter —

is_staff (optional)

Form Parameter —

is_active (optional)

Form Parameter —

date_joined (optional)

Form Parameter — format: date-time

email (optional)

Form Parameter — format: email

first_name (optional)

Form Parameter —

last_name (optional)

Form Parameter —

bvn (optional)

Form Parameter —

groups (optional)

Form Parameter —

user_permissions (optional)

Form Parameter —

id (optional)

Form Parameter —

last_login (optional)

Form Parameter — format: date-time

is_superuser (optional)

Form Parameter —

is_staff (optional)

Form Parameter —

is_active (optional)

Form Parameter —

date_joined (optional)

Form Parameter — format: date-time

email (optional)

Form Parameter — format: email

first_name (optional)

Form Parameter —

last_name (optional)

Form Parameter —

bvn (optional)

Form Parameter —

groups (optional)

Form Parameter —

user_permissions (optional)

Form Parameter —

Return type

​ User

Example data

Content-Type: application/json

{
  "is_superuser" : true,
  "is_active" : true,
  "user_permissions" : [ "user_permissions", "user_permissions" ],
  "is_staff" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "last_name" : "last_name",
  "groups" : [ "groups", "groups" ],
  "id" : 0,
  "date_joined" : "2000-01-23T04:56:07.000+00:00",
  "bvn" : 6,
  "first_name" : "first_name",
  "email" : ""
}

Produces

​ This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

User

---

Up

get /user/{id}/

(retrieveUser)

Path parameters

id (required)

Path Parameter — A unique integer value identifying this user.

Return type

​ User

Example data

Content-Type: application/json

{
  "is_superuser" : true,
  "is_active" : true,
  "user_permissions" : [ "user_permissions", "user_permissions" ],
  "is_staff" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "last_name" : "last_name",
  "groups" : [ "groups", "groups" ],
  "id" : 0,
  "date_joined" : "2000-01-23T04:56:07.000+00:00",
  "bvn" : 6,
  "first_name" : "first_name",
  "email" : ""
}

Produces

​ This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

User

---

Up

put /user/{id}/

(updateUser)

Path parameters

id (required)

Path Parameter — A unique integer value identifying this user.

Consumes

​ This API call consumes the following media types via the Content-Type request header:

• application/json
• application/x-www-form-urlencoded
• multipart/form-data

Request body

body User (optional)

Body Parameter —

Form parameters

id (optional)

Form Parameter —

last_login (optional)

Form Parameter — format: date-time

is_superuser (optional)

Form Parameter —

is_staff (optional)

Form Parameter —

is_active (optional)

Form Parameter —

date_joined (optional)

Form Parameter — format: date-time

email (optional)

Form Parameter — format: email

first_name (optional)

Form Parameter —

last_name (optional)

Form Parameter —

bvn (optional)

Form Parameter —

groups (optional)

Form Parameter —

user_permissions (optional)

Form Parameter —

id (optional)

Form Parameter —

last_login (optional)

Form Parameter — format: date-time

is_superuser (optional)

Form Parameter —

is_staff (optional)

Form Parameter —

is_active (optional)

Form Parameter —

date_joined (optional)

Form Parameter — format: date-time

email (optional)

Form Parameter — format: email

first_name (optional)

Form Parameter —

last_name (optional)

Form Parameter —

bvn (optional)

Form Parameter —

groups (optional)

Form Parameter —

user_permissions (optional)

Form Parameter —

Return type

​ User

Example data

Content-Type: application/json

{
  "is_superuser" : true,
  "is_active" : true,
  "user_permissions" : [ "user_permissions", "user_permissions" ],
  "is_staff" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "last_name" : "last_name",
  "groups" : [ "groups", "groups" ],
  "id" : 0,
  "date_joined" : "2000-01-23T04:56:07.000+00:00",
  "bvn" : 6,
  "first_name" : "first_name",
  "email" : ""
}

Produces

​ This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

User

---

Models

[ Jump to Methods ]

Table of Contents

1. AccountDetails
2. AccountDetails_bank_details
3. AccountDetails_user
4. TokenObtainPair
5. TokenRefresh
6. User

AccountDetails Up

id (optional)

Integer

user (optional)

AccountDetails_user

bank_details (optional)

AccountDetails_bank_details

account_balance (optional)

BigDecimal

AccountDetails_bank_details Up

id (optional)

Integer

name

String

bank_code

String

credit_card (optional)

Integer

AccountDetails_user Up

id (optional)

Integer

last_login (optional)

Date format: date-time

is_superuser (optional)

Boolean Designates that this user has all permissions without explicitly assigning them.

is_staff (optional)

Boolean Designates whether the user can log into this admin site.

is_active (optional)

Boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

date_joined (optional)

Date format: date-time

email

String format: email

first_name

String

last_name

String

bvn (optional)

Integer

groups (optional)

[arrayString] The groups this user belongs to. A user will get all permissions granted to each of their groups.

user_permissions (optional)

[arrayString] Specific permissions for this user.

TokenObtainPair Up

email

String

password

String

TokenRefresh Up

refresh

String

User Up

id (optional)

Integer

last_login (optional)

Date format: date-time

is_superuser (optional)

Boolean Designates that this user has all permissions without explicitly assigning them.

is_staff (optional)

Boolean Designates whether the user can log into this admin site.

is_active (optional)

Boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

date_joined (optional)

Date format: date-time

email

String format: email

first_name

String

last_name

String

bvn (optional)

Integer

groups (optional)

[arrayString] The groups this user belongs to. A user will get all permissions granted to each of their groups.

user_permissions (optional)

[arrayString] Specific permissions for this user.