Facility Organization Api client API reference · mansoq-hmis-web

Client contract scope

These 12 declarations come from repositories/teleicu/mansoq-hmis-web/src/types/facilityOrganization/facilityOrganizationApi.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

default.list

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

PaginatedResponse declared fields:

FacilityOrganizationRead declared fields:

Composed/inherited schema references: FacilityOrganizationBase. 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.listMine

GET /api/v1/facility/{facilityId}/organizations/mine/. 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: PaginatedResponse<FacilityOrganizationRead>. 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.get

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

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

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

POST /api/v1/facility/{facilityId}/organizations/. 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: FacilityOrganizationCreate. client-side declaration; not proof of accepted server payload.

FacilityOrganizationCreate declared fields:

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

response type: FacilityOrganizationRead. 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/facility/{facilityId}/organizations/{organizationId}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

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

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

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

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

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

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

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.listUsers

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

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

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

FacilityOrganizationUserRole declared fields:

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.assignUser

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

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

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

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

Path parameters: facilityId, organizationId, userRoleId. 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.updateUserRole.request declared fields:

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

DELETE /api/v1/facility/{facilityId}/organizations/{organizationId}/users/{userRoleId}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

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

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

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.addFavorite

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

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

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.removeFavorite

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

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

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.