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 (integer) or Applicant Id (null) (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",
  • "applicant_id": 0,
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get Case

path Parameters
id
required
integer (Id)

Responses

Response samples

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

Update Case

path Parameters
id
required
integer (Id)
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 (integer) or Applicant Id (null) (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",
  • "applicant_id": 0,
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete Case

path Parameters
id
required
integer (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)
last_name
required
string (Last Name)
Middle Name (string) or Middle Name (null) (Middle Name)
gender
required
string (Gender)
date_of_birth
required
string <date> (Date Of Birth)
ssn
required
string (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 (Country)
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": "string",
  • "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": "string",
  • "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
id
required
integer (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": "string",
  • "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
id
required
integer (Id)
Request Body schema: application/json
first_name
required
string (First Name)
last_name
required
string (Last Name)
Middle Name (string) or Middle Name (null) (Middle Name)
gender
required
string (Gender)
date_of_birth
required
string <date> (Date Of Birth)
ssn
required
string (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 (Country)
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": "string",
  • "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": "string",
  • "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
id
required
integer (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
Id (integer) or Id (null) (Id)
user_id
required
string (User Id)
first_name
required
string (First Name)
last_name
required
string (Last Name)
display_name
required
string (Display Name)
email
required
string (Email)
is_active
boolean (Is Active)
Default: true
Created (string) or Created (null) (Created)
created_by
required
string (Created By)
Modified (string) or Modified (null) (Modified)
modified_by
required
string (Modified By)

Responses

Request samples

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

Response samples

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

Get Item

path Parameters
id
required
integer (Id)

Responses

Response samples

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

Update Item

path Parameters
id
required
integer (Id)
Request Body schema: application/json
Id (integer) or Id (null) (Id)
user_id
required
string (User Id)
first_name
required
string (First Name)
last_name
required
string (Last Name)
display_name
required
string (Display Name)
email
required
string (Email)
is_active
boolean (Is Active)
Default: true
Created (string) or Created (null) (Created)
created_by
required
string (Created By)
Modified (string) or Modified (null) (Modified)
modified_by
required
string (Modified By)

Responses

Request samples

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

Response samples

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

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