REST API GUIDE
workforceos-attendancemanagement-service
Version: 1.0.5
Handles employee attendance logging (check-in/out), attendance rules (lateness/absence/early-leave), real-time & historical logs, and publishes notification events. Enforces company data isolation, strict record uniqueness, and one-per-shift attendance rule.
Architectural Design Credit and Contact Information
The architectural design of this microservice is credited to . For inquiries, feedback, or further information regarding the architecture, please direct your communication to:
Email:
We encourage open communication and welcome any questions or discussions related to the architectural aspects of this microservice.
Documentation Scope
Welcome to the official documentation for the AttendanceManagement Service’s REST API. This document is designed to provide a comprehensive guide to interfacing with our AttendanceManagement Service exclusively through RESTful API endpoints.
Intended Audience
This documentation is intended for developers and integrators who are looking to interact with the AttendanceManagement Service via HTTP requests for purposes such as creating, updating, deleting and querying AttendanceManagement objects.
Overview
Within these pages, you will find detailed information on how to effectively utilize the REST API, including authentication methods, request and response formats, endpoint descriptions, and examples of common use cases.
Beyond REST It’s important to note that the AttendanceManagement Service also supports alternative methods of interaction, such as gRPC and messaging via a Message Broker. These communication methods are beyond the scope of this document. For information regarding these protocols, please refer to their respective documentation.
Authentication And Authorization
To ensure secure access to the AttendanceManagement service’s protected endpoints, a project-wide access token is required. This token serves as the primary method for authenticating requests to our service. However, it’s important to note that access control varies across different routes:
Protected API: Certain API (routes) require specific authorization levels. Access to these routes is contingent upon the possession of a valid access token that meets the route-specific authorization criteria. Unauthorized requests to these routes will be rejected.
**Public API **: The service also includes public API (routes) that are accessible without authentication. These public endpoints are designed for open access and do not require an access token.
Token Locations
When including your access token in a request, ensure it is placed in one of the following specified locations. The service will sequentially search these locations for the token, utilizing the first one it encounters.
| Location | Token Name / Param Name |
|---|---|
| Query | access_token |
| Authorization Header | Bearer |
| Header | workforceos-access-token |
| Header | workforceos-access-token-{companyCodename} |
| Cookie | workforceos-access-token-{companyCodename} |
Please ensure the token is correctly placed in one of these locations, using the appropriate label as indicated. The service prioritizes these locations in the order listed, processing the first token it successfully identifies.
Api Definitions
This section outlines the API endpoints available within the AttendanceManagement service. Each endpoint can receive parameters through various methods, meticulously described in the following definitions. It’s important to understand the flexibility in how parameters can be included in requests to effectively interact with the AttendanceManagement service.
This service is configured to listen for HTTP requests on port 3002,
serving both the main API interface and default administrative endpoints.
The following routes are available by default:
- API Test Interface (API Face):
/ - Swagger Documentation:
/swagger - Postman Collection Download:
/getPostmanCollection - Health Checks:
/healthand/admin/health - Current Session Info:
/currentuser - Favicon:
/favicon.ico
This service is accessible via the following environment-specific URLs:
- Preview:
https://workforceos.prw.mindbricks.com/attendancemanagement-api - Staging:
https://workforceos-stage.mindbricks.co/attendancemanagement-api - Production:
https://workforceos.mindbricks.co/attendancemanagement-api
Parameter Inclusion Methods: Parameters can be incorporated into API requests in several ways, each with its designated location. Understanding these methods is crucial for correctly constructing your requests:
Query Parameters: Included directly in the URL’s query string.
Path Parameters: Embedded within the URL’s path.
Body Parameters: Sent within the JSON body of the request.
Session Parameters: Automatically read from the session object. This method is used for parameters that are intrinsic to the user’s session, such as userId. When using an API that involves session parameters, you can omit these from your request. The service will automatically bind them to the API layer, provided that a session is associated with your request.
Note on Session Parameters: Session parameters represent a unique method of parameter inclusion, relying on the context of the user’s session. A common example of a session parameter is userId, which the service automatically associates with your request when a session exists. This feature ensures seamless integration of user-specific data without manual input for each request.
By adhering to the specified parameter inclusion methods, you can effectively utilize the AttendanceManagement service’s API endpoints. For detailed information on each endpoint, including required parameters and their accepted locations, refer to the individual API definitions below.
Common Parameters
The AttendanceManagement service’s business API support several common parameters designed to modify and enhance the behavior of API requests. These parameters are not individually listed in the API route definitions to avoid repetition. Instead, refer to this section to understand how to leverage these common behaviors across different routes. Note that all common parameters should be included in the query part of the URL.
Supported Common Parameters:
-
getJoins (BOOLEAN): Controls whether to retrieve associated objects along with the main object. By default,
getJoinsis assumed to betrue. Set it tofalseif you prefer to receive only the main fields of an object, excluding its associations. -
excludeCQRS (BOOLEAN): Applicable only when
getJoinsistrue. By default,excludeCQRSis set tofalse. Enabling this parameter (true) omits non-local associations, which are typically more resource-intensive as they require querying external services like ElasticSearch for additional information. Use this to optimize response times and resource usage. -
requestId (String): Identifies a request to enable tracking through the service’s log chain. A random hex string of 32 characters is assigned by default. If you wish to use a custom
requestId, simply include it in your query parameters. -
caching (BOOLEAN): Determines the use of caching for query API. By default, caching is enabled (
true). To ensure the freshest data directly from the database, set this parameter tofalse, bypassing the cache. -
cacheTTL (Integer): Specifies the Time-To-Live (TTL) for query caching, in seconds. This is particularly useful for adjusting the default caching duration (5 minutes) for
get listqueries. Setting a customcacheTTLallows you to fine-tune the cache lifespan to meet your needs. -
pageNumber (Integer): For paginated
get listAPI’s, this parameter selects which page of results to retrieve. The default is1, indicating the first page. To disable pagination and retrieve all results, setpageNumberto0. -
pageRowCount (Integer): In conjunction with paginated API’s, this parameter defines the number of records per page. The default value is
25. AdjustingpageRowCountallows you to control the volume of data returned in a single request.
By utilizing these common parameters, you can tailor the behavior of API requests to suit your specific requirements, ensuring optimal performance and usability of the AttendanceManagement service.
Multi Tenant Architecture
The AttendanceManagement service operates within a multi tenant architecture.
The service is designed to support multiple tenants, each with its distinct data and configuration. This architecture ensures that data is securely isolated between tenants, preventing unauthorized access and maintaining data integrity.
The service tenant is called company and identified as companyId.
Other than platform users like superAdmin, saasAdmin and saasUser that belong to the root tenant, the tenant creators(owners) and users will all be associated with an company tenant.
When users login their scope will be isolated only to include one tenant data they below. So user may acces only this logined tennat through out the session. After loging in to e specific tenant, users should include the tenant id in their request to access the tenant data. In each request they may access different tenant data if they belong them.
Key Points:
- Tenant-Specific Requests: It is imperative that each request specifies the tenant it pertains to. This is crucial because most API’s are designed to interact exclusively with objects that are part of the specified tenant sandbox.
- User Distinction: The requesting user must have a registration for that tenant. The service searches for a
companyspecific token (cookie or bearer) using the providedcompanyId in the request header. Note that to be able to login and use multiple tenant’s sites a user must register for them all. - Request Header Parameter: When making a request, include the desired
companyIdin the request header using the parameter name ``. This signals to the service which domain context to apply for the request processing. Alternatively, you can include the tenant id in the query parameters with the namecompanyId. - Root Tenant: As all multi tenant architectures this application also has a default root tenant which created automatically. If there is no tenant mark for the request, the request are assumed as to the root tenant. Root tenant is also the hub for registering tenant creating and their owner users. When users register themselves in the root tenant, an (company) will alos be created with the given data in the request body and the user will be asssociated with this new tenant record as the
tenantAdmin. - Superadmin account: A super admin account is created with the given credentials in the design so that there is an absolute user which has all rights in the root tenant and other tenants. This account is used to create and manage all other tenants in the system.
- Tenant Registration: The
AttendanceManagementservice allows for the registration of new tenants. Any user who registers himself in the root tenant through the POST /tenantowners , can create a new company publicly with the user registration. The creator user of the company record will be registred to the new tenenat with thetenantAdminrole.
- Tenant Registration: The
Implementation:
When the user logins there may be few ways for Mindbricks to recognize and set the tenant id in the session.
- Mindbricks will check the url of the login request if it matches tenant url.
- Mindbricks will check the `` has the tenant id.
- Mindbricks will check if the user is associated with a
companyin the data model. After you login a tenant successfully, ensure that your requests accurately target objects that fall within the tenant scope set during the login session. Ensure your requests are correctly formatted to include the domain sandbox information in the header. This enables theAttendanceManagementservice to accurately identify the domain context, facilitating proper access control and data management based on the user’s permissions and the specified domain.
axios({
method: 'GET',
headers: {
'': 'Your-companyId-here'
}
url: "/someroutepath",
data: {
"someData":"someData"
},
params: {
"aParam":"aParam"
}
});
By adhering to this domain sandbox model, the AttendanceManagement service maintains a secure and organized structure for handling requests across different domains, ensuring that operations are performed within the correct contextual boundaries.
Error Response
If a request encounters an issue, whether due to a logical fault or a technical problem, the service responds with a standardized JSON error structure. The HTTP status code within this response indicates the nature of the error, utilizing commonly recognized codes for clarity:
- 400 Bad Request: The request was improperly formatted or contained invalid parameters, preventing the server from processing it.
- 401 Unauthorized: The request lacked valid authentication credentials or the credentials provided do not grant access to the requested resource.
- 404 Not Found: The requested resource was not found on the server.
- 500 Internal Server Error: The server encountered an unexpected condition that prevented it from fulfilling the request.
Each error response is structured to provide meaningful insight into the problem, assisting in diagnosing and resolving issues efficiently.
{
"result": "ERR",
"status": 400,
"message": "errMsg_organizationIdisNotAValidID",
"errCode": 400,
"date": "2024-03-19T12:13:54.124Z",
"detail": "String"
}
Object Structure of a Successfull Response
When the AttendanceManagement service processes requests successfully, it wraps the requested resource(s) within a JSON envelope. This envelope not only contains the data but also includes essential metadata, such as configuration details and pagination information, to enrich the response and provide context to the client.
Key Characteristics of the Response Envelope:
-
Data Presentation: Depending on the nature of the request, the service returns either a single data object or an array of objects encapsulated within the JSON envelope.
- Creation and Update API: These API routes return the unmodified (pure) form of the data object(s), without any associations to other data objects.
- Delete API: Even though the data is removed from the database, the last known state of the data object(s) is returned in its pure form.
- Get Requests: A single data object is returned in JSON format.
- Get List Requests: An array of data objects is provided, reflecting a collection of resources.
-
Data Structure and Joins: The complexity of the data structure in the response can vary based on the API’s architectural design and the join options specified in the request. The architecture might inherently limit join operations, or they might be dynamically controlled through query parameters.
- Pure Data Forms: In some cases, the response mirrors the exact structure found in the primary data table, without extensions.
- Extended Data Forms: Alternatively, responses might include data extended through joins with tables within the same service or aggregated from external sources, such as ElasticSearch indices related to other services.
- Join Varieties: The extensions might involve one-to-one joins, resulting in single object associations, or one-to-many joins, leading to an array of objects. In certain instances, the data might even feature nested inclusions from other data objects.
Design Considerations: The structure of a API’s response data is meticulously crafted during the service’s architectural planning. This design ensures that responses adequately reflect the intended data relationships and service logic, providing clients with rich and meaningful information.
Brief Data: Certain API’s return a condensed version of the object data, intentionally selecting only specific fields deemed useful for that request. In such instances, the API documentation will detail the properties included in the response, guiding developers on what to expect.
API Response Structure
The API utilizes a standardized JSON envelope to encapsulate responses. This envelope is designed to consistently deliver both the requested data and essential metadata, ensuring that clients can efficiently interpret and utilize the response.
HTTP Status Codes:
- 200 OK: This status code is returned for successful GET, LIST, UPDATE, or DELETE operations, indicating that the request has been processed successfully.
- 201 Created: This status code is specific to CREATE operations, signifying that the requested resource has been successfully created.
Success Response Format:
For successful operations, the response includes a "status": "OK" property, signaling the successful execution of the request. The structure of a successful response is outlined below:
{
"status":"OK",
"statusCode": 200,
"elapsedMs":126,
"ssoTime":120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName":"products",
"method":"GET",
"action":"list",
"appVersion":"Version",
"rowCount":3
"products":[{},{},{}],
"paging": {
"pageNumber":1,
"pageRowCount":25,
"totalRowCount":3,
"pageCount":1
},
"filters": [],
"uiPermissions": []
}
products: In this example, this key contains the actual response content, which may be a single object or an array of objects depending on the operation performed.
Handling Errors:
For details on handling error scenarios and understanding the structure of error responses, please refer to the “Error Response” section provided earlier in this documentation. It outlines how error conditions are communicated, including the use of HTTP status codes and standardized JSON structures for error messages.
Resources
AttendanceManagement service provides the following resources which are stored in its own database as a data object. Note that a resource for an api access is a data object for the service.
AttendanceRecord resource
Resource Definition : Records a specific user's attendance for a shift (check-in/out), with status (present, absent, late, leftEarly, pending), lateness minutes, absence reason, and manager/admin notes. Enforces strict uniqueness (one record per user per shift per day) and company-level data isolation. AttendanceRecord Resource Properties
| Name | Type | Required | Default | Definition |
|---|---|---|---|---|
| userId | ID | Referenced user (employee) | ||
| shiftId | ID | Related shift | ||
| checkInTime | Date | User check-in timestamp (set on check-in) | ||
| checkOutTime | Date | User check-out timestamp (set on check-out) | ||
| status | Enum | Attendance status: present, absent, late, leftEarly, pending (checked in, not yet out) | ||
| lateByMinutes | Integer | How many minutes late (if late) | ||
| absenceReason | String | Reason for absence (manager-provided, e.g., sick, leave) | ||
| managerNote | Text | Manager/admin note (optional for manual absence management) | ||
| companyId | ID | An ID value to represent the tenant id of the company |
Enum Properties
Enum properties are represented as strings in the database. The values are mapped to their corresponding names in the application layer.
status Enum Property
Property Definition : Attendance status: present, absent, late, leftEarly, pending (checked in, not yet out)Enum Options
| Name | Value | Index |
|---|---|---|
| pending | "pending"" |
0 |
| present | "present"" |
1 |
| absent | "absent"" |
2 |
| late | "late"" |
3 |
| leftEarly | "leftEarly"" |
4 |
Business Api
Check Inattendance API
[Default create API] — This is the designated default create API for the attendanceRecord data object. Frontend generators and AI agents should use this API for standard CRUD operations.
Allows a user to check in for an assigned shift. Enforces strict one-record-per-user/shift/day, automatically determines status (present/late). Records check-in timestamp; only permitted if user assigned to shift.
API Frontend Description By The Backend Architect
Rendered as employee’s check-in button for assigned shift. Shows feedback on result (on-time/late/error). Manager/admin may impersonate check-in (override role checks).
Rest Route
The checkInAttendance API REST controller can be triggered via the following route:
/v1/check-in
Rest Request Parameters
The checkInAttendance api has got 8 regular request parameters
| Parameter | Type | Required | Population |
|---|---|---|---|
| shiftId | ID | true | request.body?.[“shiftId”] |
| userId | ID | true | request.body?.[“userId”] |
| checkInTime | Date | true | request.body?.[“checkInTime”] |
| checkOutTime | Date | false | request.body?.[“checkOutTime”] |
| status | Enum | true | request.body?.[“status”] |
| lateByMinutes | Integer | false | request.body?.[“lateByMinutes”] |
| absenceReason | String | false | request.body?.[“absenceReason”] |
| managerNote | Text | false | request.body?.[“managerNote”] |
| shiftId : ID of the shift for check-in | |||
| userId : Referenced user (employee) | |||
| checkInTime : User check-in timestamp (set on check-in) | |||
| checkOutTime : User check-out timestamp (set on check-out) | |||
| status : Attendance status: present, absent, late, leftEarly, pending (checked in, not yet out) | |||
| lateByMinutes : How many minutes late (if late) | |||
| absenceReason : Reason for absence (manager-provided, e.g., sick, leave) | |||
| managerNote : Manager/admin note (optional for manual absence management) |
REST Request To access the api you can use the REST controller with the path POST /v1/check-in
axios({
method: 'POST',
url: '/v1/check-in',
data: {
shiftId:"ID",
userId:"ID",
checkInTime:"Date",
checkOutTime:"Date",
status:"Enum",
lateByMinutes:"Integer",
absenceReason:"String",
managerNote:"Text",
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "201",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "attendanceRecord",
"method": "POST",
"action": "create",
"appVersion": "Version",
"rowCount": 1,
"attendanceRecord": {
"id": "ID",
"userId": "ID",
"shiftId": "ID",
"checkInTime": "Date",
"checkOutTime": "Date",
"status": "Enum",
"status_idx": "Integer",
"lateByMinutes": "Integer",
"absenceReason": "String",
"managerNote": "Text",
"companyId": "ID",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
}
}
Check Outattendance API
[Default update API] — This is the designated default update API for the attendanceRecord data object. Frontend generators and AI agents should use this API for standard CRUD operations.
Sets check-out timestamp and updates status (if left early), allowed only if check-in exists but no check-out. User may only check out own attendance.
API Frontend Description By The Backend Architect
Rendered as check-out button for active shift; shows result or error why not possible (e.g., already checked out, not checked in, not assigned).
Rest Route
The checkOutAttendance API REST controller can be triggered via the following route:
/v1/check-out
Rest Request Parameters
The checkOutAttendance api has got 6 regular request parameters
| Parameter | Type | Required | Population |
|---|---|---|---|
| attendanceRecordId | ID | true | request.body?.[“attendanceRecordId”] |
| checkOutTime | Date | false | request.body?.[“checkOutTime”] |
| status | Enum | true | request.body?.[“status”] |
| lateByMinutes | Integer | false | request.body?.[“lateByMinutes”] |
| absenceReason | String | false | request.body?.[“absenceReason”] |
| managerNote | Text | false | request.body?.[“managerNote”] |
| attendanceRecordId : ID of the attendance record to check out (must be of current user and not already checked out) | |||
| checkOutTime : User check-out timestamp (set on check-out) | |||
| status : Attendance status: present, absent, late, leftEarly, pending (checked in, not yet out) | |||
| lateByMinutes : How many minutes late (if late) | |||
| absenceReason : Reason for absence (manager-provided, e.g., sick, leave) | |||
| managerNote : Manager/admin note (optional for manual absence management) |
REST Request To access the api you can use the REST controller with the path POST /v1/check-out
axios({
method: 'POST',
url: '/v1/check-out',
data: {
attendanceRecordId:"ID",
checkOutTime:"Date",
status:"Enum",
lateByMinutes:"Integer",
absenceReason:"String",
managerNote:"Text",
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "attendanceRecord",
"method": "POST",
"action": "update",
"appVersion": "Version",
"rowCount": 1,
"attendanceRecord": {
"id": "ID",
"userId": "ID",
"shiftId": "ID",
"checkInTime": "Date",
"checkOutTime": "Date",
"status": "Enum",
"status_idx": "Integer",
"lateByMinutes": "Integer",
"absenceReason": "String",
"managerNote": "Text",
"companyId": "ID",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
}
}
Mark Attendanceabsent API
Manager/admin marks an employee as absent for a shift (typically after missed check-in). Can set absenceReason, and adds admin note.
API Frontend Description By The Backend Architect
For managers/admins: select user/shift, set absence reason/note. No employee self-access.
Rest Route
The markAttendanceAbsent API REST controller can be triggered via the following route:
/v1/mark-absent
Rest Request Parameters
The markAttendanceAbsent api has got 7 regular request parameters
| Parameter | Type | Required | Population |
|---|---|---|---|
| userId | ID | true | request.body?.[“userId”] |
| shiftId | ID | true | request.body?.[“shiftId”] |
| absenceReason | String | false | request.body?.[“absenceReason”] |
| managerNote | Text | false | request.body?.[“managerNote”] |
| checkOutTime | Date | false | request.body?.[“checkOutTime”] |
| status | Enum | true | request.body?.[“status”] |
| lateByMinutes | Integer | false | request.body?.[“lateByMinutes”] |
| userId : User to be marked absent | |||
| shiftId : Shift for absence | |||
| absenceReason : Reason for absence | |||
| managerNote : Manager note (internal) | |||
| checkOutTime : User check-out timestamp (set on check-out) | |||
| status : Attendance status: present, absent, late, leftEarly, pending (checked in, not yet out) | |||
| lateByMinutes : How many minutes late (if late) |
REST Request To access the api you can use the REST controller with the path POST /v1/mark-absent
axios({
method: 'POST',
url: '/v1/mark-absent',
data: {
userId:"ID",
shiftId:"ID",
absenceReason:"String",
managerNote:"Text",
checkOutTime:"Date",
status:"Enum",
lateByMinutes:"Integer",
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "attendanceRecord",
"method": "POST",
"action": "update",
"appVersion": "Version",
"rowCount": 1,
"attendanceRecord": {
"id": "ID",
"userId": "ID",
"shiftId": "ID",
"checkInTime": "Date",
"checkOutTime": "Date",
"status": "Enum",
"status_idx": "Integer",
"lateByMinutes": "Integer",
"absenceReason": "String",
"managerNote": "Text",
"companyId": "ID",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
}
}
Get Attendancerecord API
[Default get API] — This is the designated default get API for the attendanceRecord data object. Frontend generators and AI agents should use this API for standard CRUD operations.
Get an attendance record by ID; enrichment with user/shift details. Employees can see only their own; admin/manager can view any in company.
API Frontend Description By The Backend Architect
For employees: show own record only; enriched with shift info. For admins/managers: enriched with user/shift and notes fields.
Rest Route
The getAttendanceRecord API REST controller can be triggered via the following route:
/v1/attendance-records/:attendanceRecordId
Rest Request Parameters
The getAttendanceRecord api has got 1 regular request parameter
| Parameter | Type | Required | Population |
|---|---|---|---|
| attendanceRecordId | ID | true | request.params?.[“attendanceRecordId”] |
| attendanceRecordId : Attendance record ID |
REST Request To access the api you can use the REST controller with the path GET /v1/attendance-records/:attendanceRecordId
axios({
method: 'GET',
url: `/v1/attendance-records/${attendanceRecordId}`,
data: {
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "attendanceRecord",
"method": "GET",
"action": "get",
"appVersion": "Version",
"rowCount": 1,
"attendanceRecord": {
"id": "ID",
"userId": "ID",
"shiftId": "ID",
"checkInTime": "Date",
"checkOutTime": "Date",
"status": "Enum",
"status_idx": "Integer",
"lateByMinutes": "Integer",
"absenceReason": "String",
"managerNote": "Text",
"companyId": "ID",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID",
"user": {
"email": "String",
"fullname": "String",
"avatar": "String"
},
"shift": {
"shiftDate": "Date",
"startTime": "String",
"endTime": "String",
"location": "String",
"departmentId": "ID"
}
}
}
List Attendancerecords API
[Default list API] — This is the designated default list API for the attendanceRecord data object. Frontend generators and AI agents should use this API for standard CRUD operations.
Lists attendance records, filterable by user, shift, status, date. Employees see only own, admin/manager all for company. Enriches with user & shift info.
API Frontend Description By The Backend Architect
Paged list for quick view of attendance, filter/search by user, shift, status, date. Show basic status; enrich row with user & shift as appropriate. Employee may only see own.
Rest Route
The listAttendanceRecords API REST controller can be triggered via the following route:
/v1/attendance-records
Rest Request Parameters
Filter Parameters
The listAttendanceRecords api supports 3 optional filter parameters for filtering list results:
userId (ID): Referenced user (employee)
- Single:
?userId=<value> - Multiple:
?userId=<value1>&userId=<value2> - Null:
?userId=null
shiftId (ID): Related shift
- Single:
?shiftId=<value> - Multiple:
?shiftId=<value1>&shiftId=<value2> - Null:
?shiftId=null
status (Enum): Attendance status: present, absent, late, leftEarly, pending (checked in, not yet out)
- Single:
?status=<value>(case-insensitive) - Multiple:
?status=<value1>&status=<value2> - Null:
?status=null
REST Request To access the api you can use the REST controller with the path GET /v1/attendance-records
axios({
method: 'GET',
url: '/v1/attendance-records',
data: {
},
params: {
// Filter parameters (see Filter Parameters section above)
// userId: '<value>' // Filter by userId
// shiftId: '<value>' // Filter by shiftId
// status: '<value>' // Filter by status
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "attendanceRecords",
"method": "GET",
"action": "list",
"appVersion": "Version",
"rowCount": "\"Number\"",
"attendanceRecords": [
{
"id": "ID",
"userId": "ID",
"shiftId": "ID",
"checkInTime": "Date",
"checkOutTime": "Date",
"status": "Enum",
"status_idx": "Integer",
"lateByMinutes": "Integer",
"absenceReason": "String",
"managerNote": "Text",
"companyId": "ID",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID",
"user": [
{
"email": "String",
"fullname": "String",
"avatar": "String"
},
{},
{}
],
"shift": [
{
"shiftDate": "Date",
"startTime": "String",
"endTime": "String",
"location": "String",
"departmentId": "ID"
},
{},
{}
]
},
{},
{}
],
"paging": {
"pageNumber": "Number",
"pageRowCount": "NUmber",
"totalRowCount": "Number",
"pageCount": "Number"
},
"filters": [],
"uiPermissions": []
}
Authentication Specific Routes
Common Routes
Route: currentuser
Route Definition: Retrieves the currently authenticated user’s session information.
Route Type: sessionInfo
Access Route: GET /currentuser
Parameters
This route does not require any request parameters.
Behavior
- Returns the authenticated session object associated with the current access token.
- If no valid session exists, responds with a 401 Unauthorized.
// Sample GET /currentuser call
axios.get("/currentuser", {
headers: {
"Authorization": "Bearer your-jwt-token"
}
});
Success Response Returns the session object, including user-related data and token information.
{
"sessionId": "9cf23fa8-07d4-4e7c-80a6-ec6d6ac96bb9",
"userId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
"email": "user@example.com",
"fullname": "John Doe",
"roleId": "user",
"tenantId": "abc123",
"accessToken": "jwt-token-string",
...
}
Error Response 401 Unauthorized: No active session found.
{
"status": "ERR",
"message": "No login found"
}
Notes
- This route is typically used by frontend or mobile applications to fetch the current session state after login.
- The returned session includes key user identity fields, tenant information (if applicable), and the access token for further authenticated requests.
- Always ensure a valid access token is provided in the request to retrieve the session.
Route: permissions
*Route Definition*: Retrieves all effective permission records assigned to the currently authenticated user.
*Route Type*: permissionFetch
Access Route: GET /permissions
Parameters
This route does not require any request parameters.
Behavior
- Fetches all active permission records (
givenPermissionsentries) associated with the current user session. - Returns a full array of permission objects.
- Requires a valid session (
access token) to be available.
// Sample GET /permissions call
axios.get("/permissions", {
headers: {
"Authorization": "Bearer your-jwt-token"
}
});
Success Response
Returns an array of permission objects.
[
{
"id": "perm1",
"permissionName": "adminPanel.access",
"roleId": "admin",
"subjectUserId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
"subjectUserGroupId": null,
"objectId": null,
"canDo": true,
"tenantCodename": "store123"
},
{
"id": "perm2",
"permissionName": "orders.manage",
"roleId": null,
"subjectUserId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
"subjectUserGroupId": null,
"objectId": null,
"canDo": true,
"tenantCodename": "store123"
}
]
Each object reflects a single permission grant, aligned with the givenPermissions model:
**permissionName**: The permission the user has.**roleId**: If the permission was granted through a role. -**subjectUserId**: If directly granted to the user.**subjectUserGroupId**: If granted through a group.**objectId**: If tied to a specific object (OBAC).**canDo**: True or false flag to represent if permission is active or restricted.
Error Responses
- 401 Unauthorized: No active session found.
{
"status": "ERR",
"message": "No login found"
}
- 500 Internal Server Error: Unexpected error fetching permissions.
Notes
- The /permissions route is available across all backend services generated by Mindbricks, not just the auth service.
- Auth service: Fetches permissions freshly from the live database (givenPermissions table).
- Other services: Typically use a cached or projected view of permissions stored in a common ElasticSearch store, optimized for faster authorization checks.
Tip: Applications can cache permission results client-side or server-side, but should occasionally refresh by calling this endpoint, especially after login or permission-changing operations.
Route: permissions/:permissionName
Route Definition: Checks whether the current user has access to a specific permission, and provides a list of scoped object exceptions or inclusions.
Route Type: permissionScopeCheck
Access Route: GET /permissions/:permissionName
Parameters
| Parameter | Type | Required | Population |
|---|---|---|---|
| permissionName | String | Yes | request.params.permissionName |
Behavior
- Evaluates whether the current user has access to the given
permissionName. - Returns a structured object indicating:
- Whether the permission is generally granted (
canDo) - Which object IDs are explicitly included or excluded from access (
exceptions)
- Whether the permission is generally granted (
- Requires a valid session (
access token).
// Sample GET /permissions/orders.manage
axios.get("/permissions/orders.manage", {
headers: {
"Authorization": "Bearer your-jwt-token"
}
});
Success Response
{
"canDo": true,
"exceptions": [
"a1f2e3d4-xxxx-yyyy-zzzz-object1",
"b2c3d4e5-xxxx-yyyy-zzzz-object2"
]
}
- If
canDoistrue, the user generally has the permission, but not for the objects listed inexceptions(i.e., restrictions). - If
canDoisfalse, the user does not have the permission by default — but only for the objects inexceptions, they do have permission (i.e., selective overrides). - The exceptions array contains valid UUID strings, each corresponding to an object ID (typically from the data model targeted by the permission).
Copyright
All sources, documents and other digital materials are copyright of .
About Us
For more information please visit our website: .
. .