← Technical API reference

Frontend module · STATIC DECLARATIONS

Role Api client API reference · mansoq-web

5 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 5 declarations come from repositories/platform/mansoq-web/src/types/emr/role/roleApi.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.listRoles GET /api/v1/role/ literal
default.createRole POST /api/v1/role/ literal
default.getRole GET /api/v1/role/{external_id}/ literal
default.updateRole PUT /api/v1/role/{external_id}/ literal
default.deleteRole DELETE /api/v1/role/{external_id}/ literal

default.listRoles

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

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

PaginatedResponse declared fields:

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

RoleRead declared fields:

Field Type Required Description
permissions Permission[] true —

Composed/inherited schema references: RoleBase. 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.createRole

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

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

RoleCreate declared fields:

Field Type Required Description
permissions string[] true —

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

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

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

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

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

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

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

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

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

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

Path parameters: external_id. 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.

Pinned source evidence

Links require access to the private source repository.