MANSOQ Knowledge
← Technical API reference

Frontend module · STATIC DECLARATIONS

Report Api client API reference · mansoq-web-teleicu

4 client route/call declarations with path parameters, named payload/response types and source references. Exact server acceptance and permissions require the matched backend contract.

Static API contract — behavior review pending. Source baseline f6e9f05f76d4.

Enable JavaScript to inspect structured operation, parameter, schema and permission evidence. Download this reference and its evidence.

Client contract scope

These 4 declarations come from repositories/teleicu/mansoq-web-teleicu/src/types/emr/report/reportApi.ts. Client types and noAuth flags describe the caller; they do not authorize a server action. Dynamic paths and missing backend matches are retained as review work, not repaired into invented endpoints.

Operation map

Client method HTTP method Path pattern Resolution
default.createReport POST /api/v1/template_reports/generate/ literal
default.retrieveReport GET /api/v1/template_reports/{id}/ literal
default.listReports GET /api/v1/template_reports/ literal
default.archiveReport POST /api/v1/template_reports/{id}/archive/ literal

default.createReport

POST /api/v1/template_reports/generate/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

request type: ReportGenerateCreate. client-side declaration; not proof of accepted server payload.

ReportGenerateCreate declared fields:

Field Type Required Description
template_id string true —
associating_id string true —
output_format string true —
options string true —
force boolean true —
status_check boolean false —

response type: object. client-side declaration; not proof of accepted server payload.

default.createReport.response declared fields:

Field Type Required Description
status string true —
detail string false —

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.retrieveReport

GET /api/v1/template_reports/{id}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: id. Transport strings are declared here; semantic identifier types require the server contract.

response type: ReportRead. client-side declaration; not proof of accepted server payload.

ReportRead declared fields:

Field Type Required Description
signed_url string true —
read_signed_url string true —
internal_name string true —

Composed/inherited schema references: ReportReadList. Exact generic composition is retained in the structured reference and requires server-side confirmation.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.listReports

GET /api/v1/template_reports/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Declared default query fields: associating_id (string), upload_completed (string). These are defaults observed at this route object, not an exhaustive query allowlist.

response type: PaginatedResponse<ReportReadList>. client-side declaration; not proof of accepted server payload.

PaginatedResponse declared fields:

Field Type Required Description
count number true —
results TItem[] true —

ReportReadList declared fields:

Field Type Required Description
template Partial<TemplateBase> true —
report_type string true —
associating_id string true —
archived_by UserBase true —
archived_datetime string true —
archive_reason string false —
upload_completed boolean true —
is_archived boolean true —
created_date string true —
extension string true —
uploaded_by UserReadMinimal true —
mime_type string true —

Composed/inherited schema references: ReportBase. Exact generic composition is retained in the structured reference and requires server-side confirmation.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.archiveReport

POST /api/v1/template_reports/{id}/archive/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: id. Transport strings are declared here; semantic identifier types require the server contract.

request type: object. client-side declaration; not proof of accepted server payload.

default.archiveReport.request declared fields:

Field Type Required Description
archive_reason string true —

response type: ReportReadList. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

Pinned source evidence

Links require access to the private source repository.