Skip to main content

Helpdesk API Response Models

Audience​

Developers, frontend engineers, QA and support.

Summary​

Helpdesk operations return bare DTOs/lists or anonymous objects rather than one uniform API envelope. Only shared service information uses the shared response envelope.

Reference Content​

Canonical reads and mutations commonly return 200 with a DTO/list. Creation usually returns 201 with a location and DTO, except compatibility creation returns 200. Attachment deletion returns 204. Download returns a file result. Not-found responses vary between message objects and empty bodies.

Validation/tenant exceptions are mapped to a message object. Document dependency failures use framework problem details. Framework health uses its native response. This response diversity is source-verified and should not be normalized in documentation.

Lifecycle-changing operations also persist outbox events, but those records are not part of the synchronous HTTP response.

Requires confirmation​

A standard response envelope, correlation exposure, error identifiers and consistency between canonical/compatibility operations require confirmation.

Source References​

  • microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs
  • microservices/src/helpdesk-service/Program.cs
  • microservices/src/shared-kernel/Extensions/EndpointRouteBuilderExtensions.cs

See Also​

Keywords​

API response, created response, problem details, file result, response envelope.

Revision Information​

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