🧾 Release Summary – Employee API

Version: 1.0
Base Path: /APITestify/rest/Employee
Module / Service: APITestify
Tag: Employee

🔹 1. /GetAll

Method: POST
Description: Retrieve all employee records.

Request: None

Response:
Returns an object containing:

• Employee[]: List of employees (Employee_DTO)

• ServerResponse: { Code, ErrorMessage, Validations[] }

Use Case:
Used to fetch all employee profiles from the system.

Release Note:
Initial implementation for bulk employee retrieval. Supports returning complete employee data, including department and status information.

🔹 2. /GetById

Method: POST
Description: Retrieve a single employee by ID.

Parameters:

• EmployeeId (query, integer, required) — e.g., 1234567891234567

Response:

• Employee: Employee object (Employee_DTO)

• ServerResponse: Operation result

Use Case:
Fetch details for a specific employee record.

Release Note:
Enables targeted retrieval of an employee record by unique ID.

🔹 3. /Create

Method: POST
Description: Create a new employee record.

Body: CreateEmployee_DTO

{
  "FullName": "string",
  "Role": "string",
  "Email": "string",
  "Mobile": "string",
  "OfficeLocation": "string",
  "HiringDate": "yyyy-MM-dd",
  "EmployeeCode": "string",
  "DepartmentId": 1234567891234567,
  "StatusId": 1234567891234567
}

Response:

• CreateAPIResponse → NewEmployeeId

• ServerResponse

Use Case:
Register a new employee in the system.

Release Note:
Added endpoint to support creation of employee profiles, including department and status assignment.

🔹 4. /Update

Method: POST
Description: Update an existing employee’s data.

Body: UpdateEmployee_DTO

{
  "EmployeeId": 1234567891234567,
  "FullName": "string",
  "Role": "string",
  "Email": "string",
  "Mobile": "string",
  "OfficeLocation": "string",
  "HiringDate": "yyyy-MM-dd",
  "EmployeeCode": "string",
  "DepartmentId": 1234567891234567,
  "StatusId": 1234567891234567
}

Response:

• ServerResponse

Use Case:
Modify employee information (e.g., promotion, department change).

Release Note:
Introduced update functionality to manage employee lifecycle modifications.

🔹 5. /Delete

Method: POST
Description: Delete an existing employee.

Parameters:

• EmployeeId (query, integer, required) — e.g., 1234567891234567

Response:

• ServerResponse

Use Case:
Remove an employee record (e.g., after resignation or termination).

Release Note:
Added deletion functionality with validation and server-side confirmation.

🔹 6. /GetLookups

Method: GET
Description: Retrieve lookup data for departments and statuses.

Response:
Lookups →

• Departments[]: List of Department_DTO → { Id, Name, Code }

• Status[]: List of Status_DTO → { Id, Label }

Use Case:
Populate dropdowns or reference lists in UI forms.

Release Note:
Added lookup endpoint to provide static reference data for departments and statuses.

🧩 Model Summary

⚙️ Common Server Response Format

{
  "Code": "200",
  "ErrorMessage": "",
  "Validations": [
    { "FieldName": "string", "Validation": "string" }
  ]
}

🚀 Version 1.0 Highlights

✅ Implemented full CRUD for Employee entity
✅ Introduced reusable DTOs for create, update, and retrieval
✅ Added consistent ServerResponse format
✅ Added lookup endpoint for departments and statuses