Recruitment API Response and Error Model

Summary

Recruitment uses direct DTOs and collections, a lightweight application Result type, anonymous message errors, file results, and one shared service-info envelope.

Audience

Developers, QA and support engineers, implementation partners, architects, and security reviewers working with Recruitment APIs.

Reference Content

Confirmed response styles

Source behavior	HTTP representation
Successful Result<T>	200 with the value directly
Validation result	400 with a message object
Missing resource	404 with a message object
Conflict result	409 with a message object
Direct query	200 DTO, array, or aggregate object
Download	File response or 404 message
CSV export	Text response with CSV media type
Service root	Shared ApiResponse<T> envelope
Missing tenant exception	400 message object

Result<T> is an internal application type, not a serialized wrapper. ApiResponse<T> is confirmed only for the service-root response. ProblemDetails, a uniform forbidden response, and a global exception contract are Not implemented.

Requires confirmation

Production exposure, authorization policy, ownership, compatibility parity, operational limits, and version governance require confirmation.

Source References

• microservices/src/recruitment-service/Api/EndpointResults.cs
• microservices/src/recruitment-service/Application/Common/Cqrs.cs
• microservices/src/recruitment-service/Api/RecruitmentEndpoints.cs
• microservices/src/shared-kernel/Extensions/EndpointRouteBuilderExtensions.cs
• microservices/src/contracts/Common/ApiResponse.cs

Related Articles

• Recruitment API documentation
• Recruitment technical documentation

See Also

• Recruitment module
• Recruitment business documentation

Keywords

• Recruitment API
• Response and Error Model

Revision Information

• Status: Draft
• Last reviewed: 2026-07-16
• Review cycle: Quarterly