Helpdesk API DTO Catalog
Audience
Developers, frontend engineers, QA, support and architects.
Summary
The endpoint source declares 29 public Helpdesk request/response records: 14 request records and 15 response records. Private joins, anonymous objects, multipart form data and shared service-information types are not counted as Helpdesk DTO declarations.
Reference Content
| DTO | Purpose | Direction | Verified validation | Source path |
|---|---|---|---|---|
CreateTicketDto | Ticket creation input | Request | Title value object; category/priority existence; requester fallback | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
AssignTicketDto | Assignment input | Request | No positive/existence validation for assignee; optional text trimmed | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
CreateCommentDto | Comment input | Request | Body required; author fallbacks; internal flag accepted | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
ChangeStatusDto | Generic lifecycle input | Request | Status must parse to defined enum; note optional | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
ResolveTicketDto | Resolution input | Request | Resolution text optional | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
CloseTicketDto | Closure input | Request | Note optional | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
ReopenTicketDto | Reopen input | Request | Reason optional | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
SlaBreachDto | Manual breach input | Request | Due time optional; matching active policy required | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
SlaCheckDto | SLA scan input | Request | Entire body and as-of time optional | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
SlaCheckResultDto | SLA scan counts | Response | Server constructed | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
EscalateTicketDto | Escalation input | Request | Reason required; nonpositive level defaults to one | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
CreateCategoryDto | Category creation input | Request | Name required; description optional; active defaults true | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
CreatePriorityDto | Priority creation input | Request | Name required; unknown level defaults Medium; rank minimum defaults | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
CreateSlaPolicyDto | SLA policy creation input | Request | Name required; target defaults Resolution; bounded positive duration | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
DashboardReportDto | Dashboard summary | Response | Server-calculated counts/duration | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
SlaReportDto | Per-SLA report row | Response | Server projection | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
AgentLoadReportDto | Per-assignee workload row | Response | Server grouping | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
CategorySummaryReportDto | Per-category summary row | Response | Server grouping | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
HrModuleRecordDto | Legacy-shaped record mutation input | Request | Create requires title; update uses title value object; permissive defaults | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
HrStatusDto | Legacy-shaped status input | Request | Status must parse to defined enum | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
CompatRecordDto | Legacy-shaped ticket projection | Response | Server mapping with numeric compatibility identity | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
TicketDto | Canonical ticket summary | Response | Server mapping | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
TicketDetailDto | Ticket with assignments/comments/attachments | Response | Server mapping from included entity graph | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
CategoryDto | Category projection | Response | Server mapping | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
PriorityDto | Priority projection | Response | Server mapping | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
SlaPolicyDto | SLA policy projection | Response | Server mapping | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
AssignmentDto | Assignment-history projection | Response | Server mapping | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
CommentDto | Comment projection | Response | Server mapping | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
AttachmentDto | Attachment metadata projection | Response | Server mapping | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
Non-DTO response shapes
Health data, manual SLA breach and escalation use anonymous response objects. Error messages also use anonymous objects. Attachment download returns a file result; deletion returns no content. The root service-information endpoint uses shared contract types outside the Helpdesk endpoint file.
Contract limitation
The employee form sends category and priority names while CreateTicketDto requires identifiers. Gateway forwarding does not transform this body.
Requires confirmation
DTO evolution policy, nullability expectations for external consumers, generated OpenAPI schemas, compatibility retirement and gateway contract translation require confirmation.
Source References
microservices/src/helpdesk-service/Api/HelpdeskEndpoints.csmicroservices/src/shared-kernel/Extensions/EndpointRouteBuilderExtensions.cs
Related Articles
See Also
Keywords
Helpdesk DTO, request model, response model, compatibility record.
Revision Information
- Status: Draft
- Last reviewed: 2026-07-20
- Next review: 2026-10-20