{"schemaVersion":"1.0","sourceCommit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca","sourceVisibility":"private","article":{"id":"api-client-mansoq-hmis-web-src-types-base-batch-batchapi-ts","title":"Batch Api client API reference · mansoq-hmis-web","summary":"1 client route/call declarations with path parameters, named payload/response types and source references. Exact server acceptance and permissions require the matched backend contract.","module":"IT & integrations","roles":["IT administrator","Developer","Integration engineer"],"facilities":["All configured facility types"],"kind":"reference","minutes":3,"prerequisites":["Use the API contract from the installed deployment and an authorized synthetic test environment.","Confirm facility/organization scope, action permissions and optional app enablement.","This reference is static source evidence; complete payload, authorization, failure and end-to-end review remains recorded as pending."],"steps":[],"sections":[{"title":"Client contract scope","body":"These 1 declarations come from **repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batchApi.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."},{"title":"Operation map","body":"| Client method | HTTP method | Path pattern | Resolution |\n| --- | --- | --- | --- |\n| batchApi.batchRequest | POST | `/api/v1/batch_requests/` | literal |"},{"title":"batchApi.batchRequest","body":"**POST /api/v1/batch_requests/**. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.\n\n**request type:** `BatchRequestBody`. client-side declaration; not proof of accepted server payload.\n\n**BatchRequestBody declared fields:**\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| requests | Array<object> | true | — |\n\n**response type:** `BatchRequestResponse`. client-side declaration; not proof of accepted server payload.\n\n**BatchRequestResponse declared fields:**\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| results | BatchRequestResult<T>[] | true | — |\n\n**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."}],"troubleshooting":[{"problem":"A declared route is unavailable or a request is rejected","solution":"Compare the installed revision, actual API schema, optional plugin mount, HTTP-method restrictions and recorded validation/permission evidence. Do not bypass a refusal or send a production transaction to test documentation."}],"sources":[{"path":"repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batchApi.ts","line":7,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batch.ts","line":11,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batch.ts","line":7,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}],"related":["it-api-contract","it-api-auth","security-rcm-roles"],"verification":"Static API contract — behavior review pending","version":"f6e9f05f76d4","apiReferenceIds":["frontend-operation-af50e9be0fde89bf16"]},"backend":{"resources":[],"operations":[],"methodEvidence":[],"schemas":[],"frameworkSettings":[]},"frontend":{"operations":[{"id":"frontend-operation-af50e9be0fde89bf16","repository":"repositories/teleicu/mansoq-hmis-web","apiModule":"repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batchApi.ts","operationKey":"batchApi.batchRequest","method":"POST","path":"/api/v1/batch_requests/","resolution":"literal","originOmitted":false,"source":{"path":"repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batchApi.ts","line":7,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"description":"","pathParameters":[],"declaredQueryParameters":[],"request":{"type":"BatchRequestBody","schemaIds":["repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batch.ts#BatchRequestBody"],"source":{"path":"repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batchApi.ts","line":11,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"reviewStatus":"client-side declaration; not proof of accepted server payload"},"response":{"type":"BatchRequestResponse","schemaIds":["repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batch.ts#BatchRequestResponse"],"source":{"path":"repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batchApi.ts","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"reviewStatus":"client-side declaration; not proof of accepted server payload"},"query":null,"clientNoAuth":null,"contractKind":"typed route object","reviewStatus":"client contract extracted; runtime behavior and authorization review pending","backendOperationIds":["backend-resource-5e3f5697b08a1a0f:POST:create","backend-resource-58220de8741942de:POST:create"],"sourceFamily":"alternative/legacy frontend source","backendMatchStatus":"multiple static method/path matches across source registrations; installed target and boundary require review"}],"schemas":[{"id":"repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batch.ts#BatchRequestBody","name":"BatchRequestBody","kind":"InterfaceDeclaration","description":"","source":{"path":"repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batch.ts","line":11,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"typeParameters":["T"],"fields":[{"name":"requests","type":"Array<object>","required":true,"readOnly":false,"hasInitializer":false,"description":"","source":{"path":"repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batch.ts","line":12,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"schemaIds":[]}],"baseSchemaIds":[],"reviewStatus":"declared TypeScript fields extracted; server payload/validation review pending","baseTypes":[]},{"id":"repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batch.ts#BatchRequestResponse","name":"BatchRequestResponse","kind":"InterfaceDeclaration","description":"","source":{"path":"repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batch.ts","line":7,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"typeParameters":["T"],"fields":[{"name":"results","type":"BatchRequestResult<T>[]","required":true,"readOnly":false,"hasInitializer":false,"description":"","source":{"path":"repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batch.ts","line":8,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"schemaIds":["repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batch.ts#BatchRequestResult"]}],"baseSchemaIds":[],"reviewStatus":"declared TypeScript fields extracted; server payload/validation review pending","baseTypes":[]},{"id":"repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batch.ts#BatchRequestResult","name":"BatchRequestResult","kind":"InterfaceDeclaration","description":"","source":{"path":"repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batch.ts","line":1,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"typeParameters":["T"],"fields":[{"name":"reference_id","type":"string","required":true,"readOnly":false,"hasInitializer":false,"description":"","source":{"path":"repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batch.ts","line":2,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"schemaIds":[]},{"name":"data","type":"T","required":false,"readOnly":false,"hasInitializer":false,"description":"","source":{"path":"repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batch.ts","line":3,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"schemaIds":[]},{"name":"status_code","type":"number","required":true,"readOnly":false,"hasInitializer":false,"description":"","source":{"path":"repositories/teleicu/mansoq-hmis-web/src/types/base/batch/batch.ts","line":4,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"schemaIds":[]}],"baseSchemaIds":[],"reviewStatus":"declared TypeScript fields extracted; server payload/validation review pending","baseTypes":[]}]},"services":{"operations":[]},"boundaries":[]}