MANSOQ Frontend module · STATIC DECLARATIONS
Organization Api client API reference · mansoq-web
15 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 15 declarations come from repositories/platform/mansoq-web/src/types/organization/organizationApi.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.listMine | GET | /api/v1/organization/mine/ |
literal |
| default.list | GET | /api/v1/organization/ |
literal |
| default.create | POST | /api/v1/organization/ |
literal |
| default.update | PUT | /api/v1/organization/{id}/ |
literal |
| default.manageManagingOrganization | POST | /api/v1/organization/{id}/managing_organization/ |
literal |
| default.delete | DELETE | /api/v1/organization/{id}/ |
literal |
| default.get | GET | /api/v1/organization/{id}/ |
literal |
| default.listUsers | GET | /api/v1/organization/{id}/users/ |
literal |
| default.assignUser | POST | /api/v1/organization/{id}/users/ |
literal |
| default.updateUserRole | PUT | /api/v1/organization/{id}/users/{userRoleId}/ |
literal |
| default.removeUserRole | DELETE | /api/v1/organization/{id}/users/{userRoleId}/ |
literal |
| default.listPatients | GET | /api/v1/patient/ |
literal |
| default.accessibleRoleOrganizations | GET | /api/v1/organization/accessible_role_organizations/ |
literal |
| default.getPublicOrganizations | GET | /api/v1/govt/organization/ |
literal |
| default.getPublicOrganization | GET | /api/v1/govt/organization/{id}/ |
literal |
default.listMine
GET /api/v1/organization/mine/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
response type: PaginatedResponse<Organization>. client-side declaration; not proof of accepted server payload.
PaginatedResponse declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| count | number | true | — |
| results | TItem[] | true | — |
Organization declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| name | string | true | — |
| description | string | false | — |
| org_type | org_type | true | — |
| level_cache | number | true | — |
| has_children | boolean | true | — |
| active | boolean | true | — |
| parent | OrganizationParent | false | — |
| created_at | string | true | — |
| updated_at | string | true | — |
| metadata | Metadata | null | true | — |
| permissions | string[] | true | — |
| managing_organizations | OrganizationParent[] | false | — |
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/organization/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
response type: PaginatedResponse<Organization>. 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/organization/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
request type: OrganizationCreate. client-side declaration; not proof of accepted server payload.
OrganizationCreate declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | true | — |
| description | string | false | — |
| org_type | OrgType | true | — |
| parent_id | string | false | — |
response type: Organization. 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/organization/{id}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: id. Transport strings are declared here; semantic identifier types require the server contract.
request type: OrganizationUpdate. client-side declaration; not proof of accepted server payload.
OrganizationUpdate declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | false | — |
| description | string | false | — |
| org_type | OrgType | false | — |
| parent_id | string | false | — |
response type: Organization. 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.manageManagingOrganization
POST /api/v1/organization/{id}/managing_organization/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: 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.manageManagingOrganization.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| organization | string | true | — |
| action | "add" | "remove" | true | — |
response type: Record<string, never>. 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/organization/{id}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: id. 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.get
GET /api/v1/organization/{id}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: id. Transport strings are declared here; semantic identifier types require the server contract.
response type: Organization. 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/organization/{id}/users/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: id. Transport strings are declared here; semantic identifier types require the server contract.
response type: PaginatedResponse<OrganizationUserRole>. client-side declaration; not proof of accepted server payload.
OrganizationUserRole declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| user | UserReadMinimal | true | — |
| role | RoleRead | 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.assignUser
POST /api/v1/organization/{id}/users/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: 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.assignUser.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| user | string | true | — |
| role | string | true | — |
response type: OrganizationUserRole. 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/organization/{id}/users/{userRoleId}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: id, 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:
| Field | Type | Required | Description |
|---|---|---|---|
| user | string | true | — |
| role | string | true | — |
response type: OrganizationUserRole. 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/organization/{id}/users/{userRoleId}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: id, userRoleId. 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.listPatients
GET /api/v1/patient/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
response type: PaginatedResponse<PatientRead>. client-side declaration; not proof of accepted server payload.
PatientRead declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| geo_organization | Organization | false | — |
| created_by | UserReadMinimal | false | — |
| updated_by | UserReadMinimal | false | — |
| instance_identifiers | PatientIdentifier[] | true | — |
| facility_identifiers | PatientIdentifier[] | true | — |
| extensions | Record<string, Record<string, unknown>> | false | — |
Composed/inherited schema references: PatientListRead, Permissions. 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.accessibleRoleOrganizations
GET /api/v1/organization/accessible_role_organizations/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
response type: PaginatedResponse<AccessibleRoleOrganization>. client-side declaration; not proof of accepted server payload.
AccessibleRoleOrganization declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| organization | Organization | true | — |
| role | RoleBase | null | 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.getPublicOrganizations
GET /api/v1/govt/organization/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
response type: PaginatedResponse<Organization>. 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.getPublicOrganization
GET /api/v1/govt/organization/{id}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: id. Transport strings are declared here; semantic identifier types require the server contract.
response type: Organization. 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.
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:18
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:23
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:28
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:34
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:40
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:46
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:52
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:57
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:62
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:68
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:74
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:79
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:84
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:89
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:94
- repositories/platform/mansoq-web/src/Utils/request/types.ts:66
- repositories/platform/mansoq-web/src/types/organization/organization.ts:37
- repositories/platform/mansoq-web/src/types/organization/organization.ts:53
- repositories/platform/mansoq-web/src/types/organization/organization.ts:31
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:44
- repositories/platform/mansoq-web/src/types/organization/organization.ts:60
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:66
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:72
- repositories/platform/mansoq-web/src/types/emr/patient/patient.ts:51
- repositories/platform/mansoq-web/src/types/organization/organizationApi.ts:12