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

Retrieve all branches

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new branch

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

Branch name

address
required
string

Branch address

phone
required
string

Branch contact phone number

Responses

Request samples

Content type
application/json
{
  • "name": "Vancouver Branch",
  • "address": "1300 Burrard St, Vancouver, BC, V6Z 2C7",
  • "phone": "604-456-0022"
}

Response samples

Content type
application/json
{
  • "name": "Vancouver Branch",
  • "address": "1300 Burrard St, Vancouver, BC, V6Z 2C7",
  • "phone": "604-456-0022"
}

Retrieve a branch by ID

Authorizations:
bearerAuth
path Parameters
id
required
integer

Branch ID

Responses

Response samples

Content type
application/json
{
  • "name": "Vancouver Branch",
  • "address": "1300 Burrard St, Vancouver, BC, V6Z 2C7",
  • "phone": "604-456-0022"
}

Update an existing branch

Authorizations:
bearerAuth
path Parameters
id
required
integer

Branch ID

Request Body schema: application/json
required
name
string

Branch name

address
string

Branch address

phone
string

Branch contact phone number

Responses

Request samples

Content type
application/json
{
  • "name": "Vancouver Branch",
  • "address": "1300 Burrard St, Vancouver, BC, V6Z 2C7",
  • "phone": "604-456-0022"
}

Response samples

Content type
application/json
{
  • "name": "Vancouver Branch",
  • "address": "1300 Burrard St, Vancouver, BC, V6Z 2C7",
  • "phone": "604-456-0022"
}

Delete a branch by ID

Authorizations:
bearerAuth
path Parameters
id
required
integer

Branch ID

Responses

Employees

Retrieve all employees

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new employee

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

Employee full name

position
required
string

Job title or position

department
string

Department name

email
required
string <email>

Employee email address

phone
string

Contact phone number

branchId
required
integer

Related branch ID

Responses

Request samples

Content type
application/json
{
  • "name": "Alice Johnson",
  • "position": "Branch Manager",
  • "department": "Management",
  • "email": "alice.johnson@pixell-river.com",
  • "phone": "604-555-0148",
  • "branchId": 1
}

Response samples

Content type
application/json
{
  • "name": "Alice Johnson",
  • "position": "Branch Manager",
  • "department": "Management",
  • "email": "alice.johnson@pixell-river.com",
  • "phone": "604-555-0148",
  • "branchId": 1
}

Retrieve employees by branch

Authorizations:
bearerAuth
query Parameters
branchId
required
integer

Branch ID to filter employees

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve employees by department

Authorizations:
bearerAuth
query Parameters
department
required
string

Department name to filter employees

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve an employee by ID

Authorizations:
bearerAuth
path Parameters
id
required
integer

Employee ID

Responses

Response samples

Content type
application/json
{
  • "name": "Alice Johnson",
  • "position": "Branch Manager",
  • "department": "Management",
  • "email": "alice.johnson@pixell-river.com",
  • "phone": "604-555-0148",
  • "branchId": 1
}

Update an existing employee

Authorizations:
bearerAuth
path Parameters
id
required
integer

Employee ID

Request Body schema: application/json
required
name
string

Employee full name

position
string

Job title or position

department
string

Department name

email
string <email>

Employee email address

phone
string

Contact phone number

branchId
integer

Related branch ID

Responses

Request samples

Content type
application/json
{
  • "name": "Alice Johnson",
  • "position": "Branch Manager",
  • "department": "Management",
  • "email": "alice.johnson@pixell-river.com",
  • "phone": "604-555-0148",
  • "branchId": 1
}

Response samples

Content type
application/json
{
  • "name": "Alice Johnson",
  • "position": "Branch Manager",
  • "department": "Management",
  • "email": "alice.johnson@pixell-river.com",
  • "phone": "604-555-0148",
  • "branchId": 1
}

Delete an employee by ID

Authorizations:
bearerAuth
path Parameters
id
required
integer

Employee ID

Responses