Attendance API Response and Error Model
Summary
Direct, compatibility, and foundation surfaces intentionally use different response conventions.
Audience
Frontend and backend developers, QA and support engineers, and implementation partners.
Reference Content
| Source outcome | Direct response | Compatibility response |
|---|---|---|
| Success | 200 with ApiResponse<T>: success, message, data, optional correlationId, optional errors | Usually 200 with bare DTO, array, string, or compatibility object |
| Validation / domain / argument failure | 400 failure envelope | 400 bare error value or text |
| Missing tenant | 400 failure envelope with tenant error category | 400 bare text |
| Not found | 404 failure envelope | 404 bare error value |
| Conflict | 409 failure envelope | Compatibility translation generally returns 400 |
| Forbidden application result | 403 failure envelope | 403 bare error value or empty body depending on family |
| Payroll period locked | 403 through reopen approval result | 403 bare error value |
| Authentication challenge | Requires deployment-level confirmation | Requires deployment-level confirmation |
| Unhandled failure | Framework-level failure; public body is not specified | Framework-level failure; public body is not specified |
| External dependency unavailable | No distinct public status is confirmed | No distinct public status is confirmed |
The API does not implement RFC Problem Details as its documented contract. Direct success example: {"success":true,"message":"Success","data":[],"correlationId":"example-correlation"}. Direct error example: {"success":false,"message":"Request failed.","data":null}. Compatibility examples are documented per family because shapes vary.
Source References
microservices/src/attendance-service/Api/AttendanceDirectEndpoints.csmicroservices/src/attendance-service/Api/AttendanceCompatibilityEndpoints.csmicroservices/src/attendance-service/Application/Common/Cqrs.csmicroservices/src/contracts/Common/ApiResponse.csmicroservices/src/attendance-service/Api/ShiftPolicyCompatEndpoints.cs
Related Articles
See Also
Keywords
- Attendance API
- Attendance API Response and Error Model
Revision Information
- Status: Draft
- Last reviewed: 2026-07-15
- Review cycle: Quarterly