MANSOQ Frontend module · STATIC DECLARATIONS
Location Api client API reference · mansoq-hmis-web
13 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 13 declarations come from repositories/teleicu/mansoq-hmis-web/src/types/location/locationApi.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.list | GET | /api/v1/facility/{facility_id}/location/ |
literal |
| default.get | GET | /api/v1/facility/{facility_id}/location/{id}/ |
literal |
| default.create | POST | /api/v1/facility/{facility_id}/location/ |
literal |
| default.update | PUT | /api/v1/facility/{facility_id}/location/{id}/ |
literal |
| default.delete | DELETE | /api/v1/facility/{facility_id}/location/{id}/ |
literal |
| default.getOrganizations | GET | /api/v1/facility/{facility_id}/location/{id}/organizations |
literal |
| default.addOrganization | POST | /api/v1/facility/{facilityId}/location/{id}/organizations_add/ |
literal |
| default.removeOrganization | POST | /api/v1/facility/{facilityId}/location/{id}/organizations_remove/ |
literal |
| default.listAssociations | GET | /api/v1/facility/{facility_external_id}/location/{location_external_id}/association/ |
literal |
| default.createAssociation | POST | /api/v1/facility/{facility_external_id}/location/{location_external_id}/association/ |
literal |
| default.getAssociation | GET | /api/v1/facility/{facility_external_id}/location/{location_external_id}/association/{external_id}/ |
literal |
| default.updateAssociation | PUT | /api/v1/facility/{facility_external_id}/location/{location_external_id}/association/{external_id}/ |
literal |
| default.deleteAssociation | DELETE | /api/v1/facility/{facility_external_id}/location/{location_external_id}/association/{external_id}/ |
literal |
default.list
GET /api/v1/facility/{facility_id}/location/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: facility_id. 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<LocationRead>. client-side declaration; not proof of accepted server payload.
PaginatedResponse declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| count | number | true | — |
| results | TItem[] | true | — |
LocationRead declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| has_children | boolean | true | — |
| parent | LocationRead | false | — |
| current_encounter | EncounterRead | false | — |
| sort_index | number | true | — |
| system_availability_status | SystemAvailabilityStatus | true | — |
Composed/inherited schema references: LocationBase. 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.get
GET /api/v1/facility/{facility_id}/location/{id}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: facility_id, id. Transport strings are declared here; semantic identifier types require the server contract.
response type: LocationDetail. client-side declaration; not proof of accepted server payload.
LocationDetail declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| has_children | boolean | true | — |
| organizations | FacilityOrganizationRead[] | true | — |
| sort_index | number | true | — |
| system_availability_status | SystemAvailabilityStatus | true | — |
Composed/inherited schema references: LocationBase. 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.create
POST /api/v1/facility/{facility_id}/location/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: facility_id. Transport strings are declared here; semantic identifier types require the server contract.
request type: LocationWrite. client-side declaration; not proof of accepted server payload.
LocationWrite declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | false | — |
| parent | string | false | — |
| organizations | string[] | true | — |
| mode | LocationMode | true | — |
Composed/inherited schema references: LocationBase. Exact generic composition is retained in the structured reference and requires server-side confirmation.
response type: LocationDetail. 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/{facility_id}/location/{id}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: facility_id, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: LocationWrite. client-side declaration; not proof of accepted server payload.
response type: LocationDetail. 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/{facility_id}/location/{id}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: facility_id, 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.
default.getOrganizations
GET /api/v1/facility/{facility_id}/location/{id}/organizations. typed route object; literal. no exact statically resolved backend match in scanned contracts.
Path parameters: facility_id, id. 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.
FacilityOrganizationRead declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| parent | FacilityOrganizationParent | false | — |
| active | boolean | true | — |
| level_cache | number | true | — |
| has_children | boolean | true | — |
| created_at | string | true | — |
| updated_at | string | true | — |
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.addOrganization
POST /api/v1/facility/{facilityId}/location/{id}/organizations_add/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: facilityId, 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.addOrganization.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| organization | string | true | — |
response type: LocationDetail. 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.removeOrganization
POST /api/v1/facility/{facilityId}/location/{id}/organizations_remove/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: facilityId, 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.removeOrganization.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| organization | string | true | — |
response type: LocationDetail. 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.listAssociations
GET /api/v1/facility/{facility_external_id}/location/{location_external_id}/association/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: facility_external_id, location_external_id. Transport strings are declared here; semantic identifier types require the server contract.
response type: PaginatedResponse<LocationAssociation>. client-side declaration; not proof of accepted server payload.
LocationAssociation declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| meta | Record<string, any> | true | — |
| id | string | null | true | — |
| encounter | EncounterRead | true | — |
| start_datetime | string | true | — |
| end_datetime | string | null | true | — |
| status | LocationAssociationStatus | true | — |
| created_by | string | null | true | — |
| updated_by | string | 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.createAssociation
POST /api/v1/facility/{facility_external_id}/location/{location_external_id}/association/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: facility_external_id, location_external_id. Transport strings are declared here; semantic identifier types require the server contract.
request type: LocationAssociationRequest. client-side declaration; not proof of accepted server payload.
LocationAssociationRequest declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| meta | Record<string, any> | false | — |
| encounter | string | true | — |
| start_datetime | string | true | — |
| end_datetime | string | false | — |
| status | LocationAssociationStatus | true | — |
| location | string | true | — |
response type: LocationAssociation. 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.getAssociation
GET /api/v1/facility/{facility_external_id}/location/{location_external_id}/association/{external_id}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: facility_external_id, location_external_id, external_id. Transport strings are declared here; semantic identifier types require the server contract.
response type: LocationAssociationRead. client-side declaration; not proof of accepted server payload.
LocationAssociationRead declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| start_datetime | string | true | — |
| location | LocationRead | true | — |
| status | LocationAssociationStatus | true | — |
| end_datetime | string | false | — |
Composed/inherited schema references: LocationRead, LocationAssociationStatus. 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.updateAssociation
PUT /api/v1/facility/{facility_external_id}/location/{location_external_id}/association/{external_id}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: facility_external_id, location_external_id, external_id. Transport strings are declared here; semantic identifier types require the server contract.
request type: LocationAssociationUpdate. client-side declaration; not proof of accepted server payload.
LocationAssociationUpdate declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
Composed/inherited schema references: LocationAssociationRequest. Exact generic composition is retained in the structured reference and requires server-side confirmation.
response type: LocationAssociation. 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.deleteAssociation
DELETE /api/v1/facility/{facility_external_id}/location/{location_external_id}/association/{external_id}/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.
Path parameters: facility_external_id, location_external_id, 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.
- repositories/teleicu/mansoq-hmis-web/src/types/location/locationApi.ts:13
- repositories/teleicu/mansoq-hmis-web/src/types/location/locationApi.ts:21
- repositories/teleicu/mansoq-hmis-web/src/types/location/locationApi.ts:26
- repositories/teleicu/mansoq-hmis-web/src/types/location/locationApi.ts:32
- repositories/teleicu/mansoq-hmis-web/src/types/location/locationApi.ts:38
- repositories/teleicu/mansoq-hmis-web/src/types/location/locationApi.ts:43
- repositories/teleicu/mansoq-hmis-web/src/types/location/locationApi.ts:48
- repositories/teleicu/mansoq-hmis-web/src/types/location/locationApi.ts:54
- repositories/teleicu/mansoq-hmis-web/src/types/location/locationApi.ts:60
- repositories/teleicu/mansoq-hmis-web/src/types/location/locationApi.ts:65
- repositories/teleicu/mansoq-hmis-web/src/types/location/locationApi.ts:71
- repositories/teleicu/mansoq-hmis-web/src/types/location/locationApi.ts:76
- repositories/teleicu/mansoq-hmis-web/src/types/location/locationApi.ts:82
- repositories/teleicu/mansoq-hmis-web/src/Utils/request/types.ts:66
- repositories/teleicu/mansoq-hmis-web/src/types/location/location.ts:47
- repositories/teleicu/mansoq-hmis-web/src/types/location/location.ts:39
- repositories/teleicu/mansoq-hmis-web/src/types/location/location.ts:58
- repositories/teleicu/mansoq-hmis-web/src/types/facilityOrganization/facilityOrganization.ts:25
- repositories/teleicu/mansoq-hmis-web/src/types/location/locationApi.ts:52
- repositories/teleicu/mansoq-hmis-web/src/types/location/locationApi.ts:58
- repositories/teleicu/mansoq-hmis-web/src/types/location/association.ts:22
- repositories/teleicu/mansoq-hmis-web/src/types/location/association.ts:33
- repositories/teleicu/mansoq-hmis-web/src/types/location/association.ts:14
- repositories/teleicu/mansoq-hmis-web/src/types/location/association.ts:42