Skip to main content

Response Models

Audience​

Developers, QA engineers, support engineers, security engineers, solution architects, and implementation partners.

Reference Content​

This page records source-verified Workforce Scheduling API behavior and boundaries.

Summary​

The API has two main response families.

Native response pattern​

Native shift-policy operations use the shared generic envelope. Success carries a success flag, message, data, optional validation errors, and correlation context according to the shared contract. Native list and mutation successes return HTTP 200. Known failures use the same envelope.

Compatibility response pattern​

Compatibility endpoints return bare DTOs, lists, or error values. They do not use the standard envelope. Successful delete returns plain text. This preserves existing client behavior.

Shared operational responses​

Service information uses the standard envelope around a shared service-information contract. Health output is produced by the health-check framework.

Frontend tolerance​

The frontend policy loader tolerates either an enveloped payload or a bare payload, while shift and weekly-off consumers expect compatibility-shaped bodies.

Classification​

Dual response patterns are Transitional. A unified contract would be a breaking change for existing compatibility consumers.

Source References​

  • microservices/src/attendance-service/Api/AttendanceDirectEndpoints.cs
  • microservices/src/attendance-service/Api/AttendanceCompatibilityEndpoints.cs
  • microservices/src/contracts/Common/ApiResponse.cs
  • microservices/src/shared-kernel/Extensions/EndpointRouteBuilderExtensions.cs

See Also​

Keywords​

  • Workforce Scheduling API
  • Shift endpoints
  • Attendance policy API

Revision Information​

  • Status: Draft
  • Last reviewed: 2026-07-20
  • Next review: 2026-10-20