← Technical API reference

Frontend module · STATIC DECLARATIONS

Service Request Api client API reference · mansoq-web-teleicu

9 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 9 declarations come from repositories/teleicu/mansoq-web-teleicu/src/types/emr/serviceRequest/serviceRequestApi.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.listServiceRequest GET /api/v1/facility/{facilityId}/service_request/ literal
default.retrieveServiceRequest GET /api/v1/facility/{facilityId}/service_request/{serviceRequestId}/ literal
default.cancelServiceRequest POST /api/v1/facility/{facilityId}/service_request/{serviceRequestId}/cancel/ literal
default.completeServiceRequest POST /api/v1/facility/{facilityId}/service_request/{serviceRequestId}/complete/ literal
default.createServiceRequest POST /api/v1/facility/{facilityId}/service_request/ literal
default.updateServiceRequest PATCH /api/v1/facility/{facilityId}/service_request/{serviceRequestId}/ literal
default.applyActivityDefinition POST /api/v1/facility/{facilityId}/service_request/apply_activity_definition/ literal
default.setTags POST /api/v1/facility/{facilityId}/service_request/{external_id}/set_tags/ literal
default.removeTags POST /api/v1/facility/{facilityId}/service_request/{external_id}/remove_tags/ literal

default.listServiceRequest

GET /api/v1/facility/{facilityId}/service_request/. 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<ServiceRequestReadSpec>. client-side declaration; not proof of accepted server payload.

PaginatedResponse declared fields:

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

ServiceRequestReadSpec declared fields:

Field Type Required Description
version number false —
locations LocationRead[] true —
encounter EncounterRead true —
activity_definition ActivityDefinitionReadSpec true —
specimens SpecimenRead[] true —
observations ObservationRead[] false —
diagnostic_reports DiagnosticReportRead[] true —
created_by UserReadMinimal true —
updated_by UserReadMinimal true —
created_date string true —
updated_at string true —
requester UserReadMinimal false —
tags TagConfig[] true —

Composed/inherited schema references: BaseServiceRequestSpec. 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.retrieveServiceRequest

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

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

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

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

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

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

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

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

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

POST /api/v1/facility/{facilityId}/service_request/. 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.

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

ServiceRequestCreateSpec declared fields:

Field Type Required Description
encounter string true —
locations string[] true —
requester string true —

Composed/inherited schema references: BaseServiceRequestSpec. 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.updateServiceRequest

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

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

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

ServiceRequestUpdateSpec declared fields:

Field Type Required Description
encounter string true —
locations string[] true —

Composed/inherited schema references: BaseServiceRequestSpec. 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.applyActivityDefinition

POST /api/v1/facility/{facilityId}/service_request/apply_activity_definition/. 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.

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

ServiceRequestApplyActivityDefinitionSpec declared fields:

Field Type Required Description
encounter string true —
activity_definition string true —
service_request Omit<BaseServiceRequestSpec, "id" | "requester"> & object 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.

default.setTags

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

Path parameters: facilityId, external_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.setTags.request declared fields:

Field Type Required Description
tags string[] true —

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

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

Path parameters: facilityId, external_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.removeTags.request declared fields:

Field Type Required Description
tags string[] true —

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