← Technical API reference

Frontend module · STATIC DECLARATIONS

Resource Request Api client API reference · mansoq-hmis-web

6 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 6 declarations come from repositories/teleicu/mansoq-hmis-web/src/types/resourceRequest/resourceRequestApi.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.get GET /api/v1/resource/{resourceRequestId}/ literal
default.list GET /api/v1/resource/ literal
default.create POST /api/v1/resource/ literal
default.update PUT /api/v1/resource/{resourceRequestId}/ literal
resourceRequestCommentApi.list GET /api/v1/resource/{resourceRequestId}/comment/ literal
resourceRequestCommentApi.create POST /api/v1/resource/{resourceRequestId}/comment/ literal

default.get

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

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

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

ResourceRequestRead declared fields:

Field Type Required Description
approving_facility FacilityRead | null true —
related_patient PatientRead | null true —
assigned_to UserReadMinimal | null true —
created_by UserReadMinimal | null true —
updated_by UserReadMinimal | null true —

Composed/inherited schema references: ResourceRequestListRead. 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.list

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

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

PaginatedResponse declared fields:

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

ResourceRequestListRead declared fields:

Field Type Required Description
id string true —
origin_facility FacilityRead true —
assigned_facility FacilityRead | null true —
created_date string true —
modified_date string true —

Composed/inherited schema references: ResourceRequestBase. 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.create

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

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

ResourceRequestCreate declared fields:

Field Type Required Description
origin_facility string true —
approving_facility string | null true —
assigned_facility string | null true —
related_patient string | null true —
assigned_to string | null true —

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

response type: ResourceRequestRead. 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.

default.update

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

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

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

response type: ResourceRequestRead. 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.

resourceRequestCommentApi.list

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

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

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

CommentRead declared fields:

Field Type Required Description
id string true —
created_by UserReadMinimal true —
created_date string true —
comment string true —

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.

resourceRequestCommentApi.create

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

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

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

CommentCreate declared fields:

Field Type Required Description
comment string true —

response type: CommentRead. 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.