API docs by Redocly

Task Management API Documentation (1.0.0)

Download OpenAPI specification:

This is the API documentation for the Task Management application.

Branches

Create a new branch

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string
address
required
string
phone
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "Winnipeg Campuss",
  • "address": "190 Princess St, Winnipeg, MB",
  • "phone": "+1-431-355-0100"
}

Get all branches

Authorizations:
bearerAuth

Responses

Get a branch by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Update a branch by ID

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string
address
string
phone
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "phone": "string"
}

Delete a branch by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Employees

Create a new employee

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string
position
required
string
department
required
string
email
required
string <email>
phone
string
branchId
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "Ravdeep Sharma",
  • "position": "Backend Developer",
  • "department": "Engineering",
  • "email": "rsharma1@rrc.ca",
  • "phone": "+1-431-555-9876",
  • "branchId": "branch_001"
}

Get all employees

Authorizations:
bearerAuth

Responses

Get employees for a specific branch

Authorizations:
bearerAuth
path Parameters
branchId
required
string

Responses

Get employees by department

Authorizations:
bearerAuth
path Parameters
department
required
string

Responses

Get an employee by id

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Update an employee by id

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string
position
string
department
string
email
string <email>
phone
string
branchId
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "position": "string",
  • "department": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "branchId": "string"
}

Delete an employee by id

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses