MANSOQ Knowledge
← Technical API reference

Frontend module · STATIC DECLARATIONS

Product Api client API reference · mansoq-hmis-web

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-hmis-web/src/types/inventory/product/productApi.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.listProduct GET /api/v1/facility/{facilityId}/product/ literal
default.retrieveProduct GET /api/v1/facility/{facilityId}/product/{productId}/ literal
default.createProduct POST /api/v1/facility/{facilityId}/product/ literal
default.updateProduct PUT /api/v1/facility/{facilityId}/product/{productId}/ literal

default.listProduct

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

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

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

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

PaginatedResponse declared fields:

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

ProductRead declared fields:

Field Type Required Description
product_knowledge ProductKnowledgeBase true —
charge_item_definition ChargeItemDefinitionBase false —

Composed/inherited schema references: ProductBase. 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.retrieveProduct

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

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

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

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

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

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

ProductCreate declared fields:

Field Type Required Description
product_knowledge string true —
charge_item_definition string false —
extensions Record<string, unknown> true —

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

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

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

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

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

ProductUpdate declared fields:

Field Type Required Description
charge_item_definition string false —
product_knowledge string true —
extensions Record<string, unknown> true —

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

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