lets-go-company

README

Let's GO Company

I. What to do

In this service, you will develop a backend server side functions that handle the company and employee API resources.This service will contain 2 sub-services which are the Rest and gRPC service. Rest service will handle the http requests while gRPC will handle the rpc request to the API resources.

The company and employee ERD can be referred below:

II. API Output

1. Company API Output

1.1. Get a company by ID.

- URL: [GET] {company_url}/go/company/{id}
- Response: 
    {
        "id": "string",
        "name": "string",
        "phone": "string",
        "email": "string",
        "address": "string",
        "tax_number": "string",
        "total_employee": 0, // calculate the total employee
        "total_project": 0, // calculate the total "active" project
        "created_at": "string",
        "updated_at": "string"
    }

1.2. Create a company.

- URL: [POST] {company_url}/go/company
- Payload:
    {
        "name": "string",
        "phone": "string",
        "email": "string",
        "address": "string",
        "tax_number": "string"
    }
- Response:
    {
        "id": "string",
        "name": "string",
        "phone": "string",
        "email": "string",
        "address": "string",
        "tax_number": "string",
        "total_employee": 0, // calculate the total employee
        "total_project": 0, // calculate the total "active" project
        "created_at": "string",
        "updated_at": "string"
    }

1.3. Update a company by ID.

- URL: [PUT] {company_url}/go/company/{id}
- Payload:
    {
        "id": "string",
        "name": "string",
        "phone": "string",
        "email": "string",
        "address": "string",
        "tax_number": "string"
    }
- Response:
    {
        "id": "string",
        "name": "string",
        "phone": "string",
        "email": "string",
        "address": "string",
        "tax_number": "string",
        "total_employee": 0, // calculate the total employee
        "total_project": 0, // calculate the total "active" project
        "created_at": "string",
        "updated_at": "string"
    }

1.4. Delete a company by ID.

- URL: [DELETE] {company_url}/go/company/{id}
- Status: 200

1.5. List a company by page, limit; filter by created_at and search by "name", "phone", "email"

- URL: [GET] {company_url}/go/compannies
- Query: ?page=0&limit=0&search_value=string&search_fields=name,phone,email
- Response:
    {
        "items": [
            {
                "id": "string",
                "name": "string",
                "phone": "string",
                "email": "string",
                "address": "string",
                "tax_number": "string",
                "created_at": "string",
                "updated_at": "string"
            },
            ...
        ]
        "max_page": 0,
        "total_count": 0,
        "page": 0,
        "limit": 0,
    }

2. Employee API Output

2.1. Get an employee by ID.

- URL: [GET] {company_url}/go/employee/{id}
- Response:
    {
        "id": "string",
        "company_id": "string",
        "name": "string",
        "email": "string",
        "dob": "string",
        "gender": "string",
        "role": "string",
        "created_at": "string",
        "updated_at": "string"
    }

2.2. Create an employee for a specific company.

- URL: [POST] {company_url}/go/company/{company_id}/employee
- Payload:
    {
        "company_id": "string",
        "name": "string",
        "email": "string",
        "dob": "string",
        "gender": "string", // allowed values: "male", "female", "not_specified"
        "role": "string", // allowed values: "manager", "staff", "intern"
    }
- Response:
    {
        "id": "string",
        "company_id": "string",
        "name": "string",
        "email": "string",
        "dob": "string",
        "gender": "string",
        "role": "string",
        "created_at": "string",
        "updated_at": "string"
    }

2.3. Update an employee by ID.

- URL: [POST] {company_url}/go/employee/{id}
- Payload:
    {
        "id": "string",
        "company_id": "string",
        "name": "string",
        "email": "string",
        "dob": "string",
        "gender": "string", // allowed values: "male", "female", "not_specified"
        "role": "string", // allowed values: "manager", "staff", "intern"
    }
- Response:
    {
        "id": "string",
        "company_id": "string",
        "name": "string",
        "email": "string",
        "dob": "string",
        "gender": "string",
        "role": "string",
        "created_at": "string",
        "updated_at": "string"
    }

2.4. Delete an employee by ID.

- URL: [DELETE] {company_url}/go/employee/{id}
- Status: 200

2.5. List employee by company id, page, limit; filter by created_at and search by "name", "email"

- URL: [GET] {company_url}/go/company/{company_id}/employees
- Query: ?page=0&limit=0&search_value=string&search_fields=name,email
- Response:
    {
        "items": [
            {
                "id": "string",
                "company_id": "string",
                "name": "string",
                "email": "string",
                "dob": "string",
                "gender": "string",
                "role": "string",
                "created_at": "string",
                "updated_at": "string"
            },
            ...
        ]
        "max_page": 0,
        "total_count": 0,
        "page": 0,
        "limit": 0,
    }

NOTE: DO NOT commit changes directly into the master branch. Make your own master branch.