MANSOQ Frontend module · STATIC DECLARATIONS
Api client API reference · mansoq-hcx-fe
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/teleicu/mansoq-hcx-fe/src/api.tsx. 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 |
|---|---|---|---|
| routes.hcx.claims.list | GET | /api/hcx/claim/ |
literal |
| routes.hcx.claims.create | POST | /api/hcx/claim/ |
literal |
| routes.hcx.claims.get | GET | /api/hcx/claim/{external_id}/ |
literal |
| routes.hcx.claims.update | PUT | /api/hcx/claim/{external_id}/ |
literal |
| routes.hcx.claims.partialUpdate | PATCH | /api/hcx/claim/{external_id}/ |
literal |
| routes.hcx.claims.delete | DELETE | /api/hcx/claim/{external_id}/ |
literal |
| routes.hcx.claims.listPMJYPackages | GET | /api/hcx/pmjy_packages/ |
literal |
| routes.hcx.claims.makeClaim | POST | /api/hcx/make_claim/ |
literal |
| routes.hcx.communications.list | GET | /api/hcx/communication/ |
literal |
| routes.hcx.communications.create | POST | /api/hcx/communication/ |
literal |
| routes.hcx.communications.get | GET | /api/hcx/communication/{external_id}/ |
literal |
| routes.hcx.communications.update | PUT | /api/hcx/communication/{external_id}/ |
literal |
| routes.hcx.communications.partialUpdate | PATCH | /api/hcx/communication/{external_id}/ |
literal |
| routes.hcx.communications.delete | DELETE | /api/hcx/communication/{external_id}/ |
literal |
| routes.hcx.communications.send | POST | /api/hcx/send_communication/ |
literal |
routes.hcx.claims.list
GET /api/hcx/claim/. typed route object; literal. no exact statically resolved backend match in scanned contracts.
response type: PaginatedResponse<HCXClaimModel>. client-side declaration; not proof of accepted server payload.
HCXClaimModel declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | false | — |
| consultation | string | true | — |
| consultation_object | ConsultationModel | false | — |
| policy | string | true | — |
| policy_object | HCXPolicyModel | false | — |
| items | HCXItemModel[] | false | — |
| total_claim_amount | number | false | — |
| total_amount_approved | number | false | — |
| use | HCXClaimUse | false | — |
| status | HCXClaimStatus | false | — |
| priority | HCXClaimPriority | false | — |
| type | HCXClaimType | false | — |
| outcome | HCXClaimOutcome | false | — |
| error_text | string | false | — |
| created_by | UserBareMinimum | false | — |
| last_modified_by | UserBareMinimum | false | — |
| created_date | string | false | — |
| modified_date | string | 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.
routes.hcx.claims.create
POST /api/hcx/claim/. typed route object; literal. no exact statically resolved backend match in scanned contracts.
request type: object. client-side declaration; not proof of accepted server payload.
routes.hcx.claims.create.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| policy | string | true | — |
| items | object[] | true | — |
| consultation | string | true | — |
| use | "preauthorization" | "claim" | true | — |
response type: HCXClaimModel. 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.
routes.hcx.claims.get
GET /api/hcx/claim/{external_id}/. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.
Path parameters: external_id. Transport strings are declared here; semantic identifier types require the server contract.
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.
routes.hcx.claims.update
PUT /api/hcx/claim/{external_id}/. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.
Path parameters: external_id. Transport strings are declared here; semantic identifier types require the server contract.
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.
routes.hcx.claims.partialUpdate
PATCH /api/hcx/claim/{external_id}/. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.
Path parameters: external_id. Transport strings are declared here; semantic identifier types require the server contract.
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.
routes.hcx.claims.delete
DELETE /api/hcx/claim/{external_id}/. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.
Path parameters: external_id. Transport strings are declared here; semantic identifier types require the server contract.
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.
routes.hcx.claims.listPMJYPackages
GET /api/hcx/pmjy_packages/. typed route object; literal. no exact statically resolved backend match in scanned contracts.
response type: PMJAYPackageItem[]. client-side declaration; not proof of accepted server payload.
PMJAYPackageItem declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | false | — |
| code | string | false | — |
| price | number | false | — |
| package_name | string | 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.
routes.hcx.claims.makeClaim
POST /api/hcx/make_claim/. typed route object; literal. no exact statically resolved backend match in scanned contracts.
request type: object. client-side declaration; not proof of accepted server payload.
routes.hcx.claims.makeClaim.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| claim | 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.
routes.hcx.communications.list
GET /api/hcx/communication/. typed route object; literal. no exact statically resolved backend match in scanned contracts.
response type: PaginatedResponse<HCXCommunicationModel>. client-side declaration; not proof of accepted server payload.
HCXCommunicationModel declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | false | — |
| identifier | string | false | — |
| claim | string | false | — |
| claim_object | HCXClaimModel | false | — |
| content | object[] | false | — |
| created_by | string | null | false | — |
| last_modified_by | string | null | false | — |
| created_date | string | false | — |
| modified_date | string | 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.
routes.hcx.communications.create
POST /api/hcx/communication/. typed route object; literal. no exact statically resolved backend match in scanned contracts.
request type: object. client-side declaration; not proof of accepted server payload.
routes.hcx.communications.create.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| claim | string | true | — |
| content | object[] | true | — |
response type: HCXCommunicationModel. 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.
routes.hcx.communications.get
GET /api/hcx/communication/{external_id}/. typed route object; literal. no exact statically resolved backend match in scanned contracts.
Path parameters: external_id. Transport strings are declared here; semantic identifier types require the server contract.
response type: HCXCommunicationModel. 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.
routes.hcx.communications.update
PUT /api/hcx/communication/{external_id}/. typed route object; literal. no exact statically resolved backend match in scanned contracts.
Path parameters: external_id. Transport strings are declared here; semantic identifier types require the server contract.
response type: HCXCommunicationModel. 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.
routes.hcx.communications.partialUpdate
PATCH /api/hcx/communication/{external_id}/. typed route object; literal. no exact statically resolved backend match in scanned contracts.
Path parameters: external_id. Transport strings are declared here; semantic identifier types require the server contract.
response type: HCXCommunicationModel. 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.
routes.hcx.communications.delete
DELETE /api/hcx/communication/{external_id}/. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.
Path parameters: external_id. Transport strings are declared here; semantic identifier types require the server contract.
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.
routes.hcx.communications.send
POST /api/hcx/send_communication/. typed route object; literal. no exact statically resolved backend match in scanned contracts.
request type: object. client-side declaration; not proof of accepted server payload.
routes.hcx.communications.send.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| communication | string | true | — |
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-hcx-fe/src/api.tsx:11
- repositories/teleicu/mansoq-hcx-fe/src/api.tsx:17
- repositories/teleicu/mansoq-hcx-fe/src/api.tsx:34
- repositories/teleicu/mansoq-hcx-fe/src/api.tsx:39
- repositories/teleicu/mansoq-hcx-fe/src/api.tsx:44
- repositories/teleicu/mansoq-hcx-fe/src/api.tsx:49
- repositories/teleicu/mansoq-hcx-fe/src/api.tsx:54
- repositories/teleicu/mansoq-hcx-fe/src/api.tsx:60
- repositories/teleicu/mansoq-hcx-fe/src/api.tsx:69
- repositories/teleicu/mansoq-hcx-fe/src/api.tsx:75
- repositories/teleicu/mansoq-hcx-fe/src/api.tsx:88
- repositories/teleicu/mansoq-hcx-fe/src/api.tsx:94
- repositories/teleicu/mansoq-hcx-fe/src/api.tsx:100
- repositories/teleicu/mansoq-hcx-fe/src/api.tsx:106
- repositories/teleicu/mansoq-hcx-fe/src/api.tsx:111
- repositories/teleicu/mansoq-hcx-fe/src/types.ts:43
- repositories/teleicu/mansoq-hcx-fe/src/api.tsx:20
- repositories/teleicu/mansoq-hcx-fe/src/components/PMJAYProcedurePackageAutocomplete.tsx:13
- repositories/teleicu/mansoq-hcx-fe/src/api.tsx:63
- repositories/teleicu/mansoq-hcx-fe/src/types.ts:5
- repositories/teleicu/mansoq-hcx-fe/src/api.tsx:79
- repositories/teleicu/mansoq-hcx-fe/src/api.tsx:115