API docs by Redocly

FastAPI (0.1.0)

Download OpenAPI specification:Download

Cases

Get Cases

query Parameters
page_number
integer (Page Number)
Default: 0
page_size
integer (Page Size)
Default: 100

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "item_count": 0,
  • "page_count": 0,
  • "prev_page": 0,
  • "next_page": 0
}

Create Case

Request Body schema: application/json
status
required
string (Status)
Enum: "Not Started" "In Progress" "Approved" "Denied"
Assigned To (string) or Assigned To (null) (Assigned To)
applicant_id
required
integer (Applicant Id)

Responses

Request samples

Content type
application/json
{
  • "status": "Not Started",
  • "assigned_to": "string",
  • "applicant_id": 0
}

Response samples

Content type
application/json
{
  • "status": "Not Started",
  • "assigned_to": "string",
  • "id": 0,
  • "applicant_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get Case

path Parameters
case_id
required
integer (Case Id)

Responses

Response samples

Content type
application/json
{
  • "status": "Not Started",
  • "assigned_to": "string",
  • "id": 0,
  • "applicant_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "applicant": {
    }
}

Update Case

path Parameters
case_id
required
integer (Case Id)
Request Body schema: application/json
Status (string) or Status (null) (Status)
Assigned To (string) or Assigned To (null) (Assigned To)

Responses

Request samples

Content type
application/json
{
  • "status": "Not Started",
  • "assigned_to": "string"
}

Response samples

Content type
application/json
{
  • "status": "Not Started",
  • "assigned_to": "string",
  • "id": 0,
  • "applicant_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete Case

path Parameters
case_id
required
integer (Case Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Applicants

Get Applicants

query Parameters
page_number
integer (Page Number)
Default: 0
page_size
integer (Page Size)
Default: 100

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "item_count": 0,
  • "page_count": 0,
  • "prev_page": 0,
  • "next_page": 0
}

Create Applicant

Request Body schema: application/json
first_name
required
string (First Name) [ 1 .. 50 ] characters
last_name
required
string (Last Name) [ 1 .. 50 ] characters
Middle Name (string) or Middle Name (null) (Middle Name)
gender
required
string (Gender) [ 1 .. 20 ] characters
date_of_birth
required
string <date> (Date Of Birth)
ssn
required
string (Ssn) [ 9 .. 11 ] characters
Email (string) or Email (null) (Email)
Home Phone (string) or Home Phone (null) (Home Phone)
Mobile Phone (string) or Mobile Phone (null) (Mobile Phone)
Address (string) or Address (null) (Address)
City (string) or City (null) (City)
State (string) or State (null) (State)
Zip (string) or Zip (null) (Zip)
country
string (Country) <= 100 characters
Default: "USA"

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "middle_name": "string",
  • "gender": "string",
  • "date_of_birth": "2019-08-24",
  • "ssn": "stringstr",
  • "email": "string",
  • "home_phone": "string",
  • "mobile_phone": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "country": "USA"
}

Response samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "middle_name": "string",
  • "gender": "string",
  • "date_of_birth": "2019-08-24",
  • "ssn": "stringstr",
  • "email": "string",
  • "home_phone": "string",
  • "mobile_phone": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "country": "USA",
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get Applicant

path Parameters
applicant_id
required
integer (Applicant Id)

Responses

Response samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "middle_name": "string",
  • "gender": "string",
  • "date_of_birth": "2019-08-24",
  • "ssn": "stringstr",
  • "email": "string",
  • "home_phone": "string",
  • "mobile_phone": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "country": "USA",
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update Applicant

path Parameters
applicant_id
required
integer (Applicant Id)
Request Body schema: application/json
First Name (string) or First Name (null) (First Name)
Last Name (string) or Last Name (null) (Last Name)
Middle Name (string) or Middle Name (null) (Middle Name)
Gender (string) or Gender (null) (Gender)
Date Of Birth (string) or Date Of Birth (null) (Date Of Birth)
Ssn (string) or Ssn (null) (Ssn)
Email (string) or Email (null) (Email)
Home Phone (string) or Home Phone (null) (Home Phone)
Mobile Phone (string) or Mobile Phone (null) (Mobile Phone)
Address (string) or Address (null) (Address)
City (string) or City (null) (City)
State (string) or State (null) (State)
Zip (string) or Zip (null) (Zip)
Country (string) or Country (null) (Country)

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "middle_name": "string",
  • "gender": "string",
  • "date_of_birth": "2019-08-24",
  • "ssn": "string",
  • "email": "string",
  • "home_phone": "string",
  • "mobile_phone": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "country": "string"
}

Response samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "middle_name": "string",
  • "gender": "string",
  • "date_of_birth": "2019-08-24",
  • "ssn": "stringstr",
  • "email": "string",
  • "home_phone": "string",
  • "mobile_phone": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "country": "USA",
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete Applicant

path Parameters
applicant_id
required
integer (Applicant Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Users

Get Items

query Parameters
page_number
integer (Page Number)
Default: 0
page_size
integer (Page Size)
Default: 100

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "item_count": 0,
  • "page_count": 0,
  • "prev_page": 0,
  • "next_page": 0
}

Create Item

Request Body schema: application/json
user_id
required
string (User Id) [ 1 .. 100 ] characters
first_name
required
string (First Name) [ 1 .. 100 ] characters
last_name
required
string (Last Name) [ 1 .. 100 ] characters
display_name
required
string (Display Name) [ 1 .. 200 ] characters
email
required
string (Email) [ 1 .. 254 ] characters
is_active
boolean (Is Active)
Default: true
created_by
required
string (Created By) [ 1 .. 100 ] characters
modified_by
required
string (Modified By) [ 1 .. 100 ] characters
Hashed Password (string) or Hashed Password (null) (Hashed Password)

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "display_name": "string",
  • "email": "string",
  • "is_active": true,
  • "created_by": "string",
  • "modified_by": "string",
  • "hashed_password": "string"
}

Response samples

Content type
application/json
{
  • "user_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "display_name": "string",
  • "email": "string",
  • "is_active": true,
  • "created_by": "string",
  • "modified_by": "string",
  • "id": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Get Item

path Parameters
id
required
integer (Id)

Responses

Response samples

Content type
application/json
{
  • "user_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "display_name": "string",
  • "email": "string",
  • "is_active": true,
  • "created_by": "string",
  • "modified_by": "string",
  • "id": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Update Item

path Parameters
id
required
integer (Id)
Request Body schema: application/json
User Id (string) or User Id (null) (User Id)
First Name (string) or First Name (null) (First Name)
Last Name (string) or Last Name (null) (Last Name)
Display Name (string) or Display Name (null) (Display Name)
Email (string) or Email (null) (Email)
Is Active (boolean) or Is Active (null) (Is Active)
Modified By (string) or Modified By (null) (Modified By)

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "display_name": "string",
  • "email": "string",
  • "is_active": true,
  • "modified_by": "string"
}

Response samples

Content type
application/json
{
  • "user_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "display_name": "string",
  • "email": "string",
  • "is_active": true,
  • "created_by": "string",
  • "modified_by": "string",
  • "id": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Delete Item

path Parameters
id
required
integer (Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Admin

Get Current User

Authorizations:
HTTPBearer

Responses

Response samples

Content type
application/json
null

Health

Get Health

Responses

Response samples

Content type
application/json
null