← Technical API reference

Backend resource · STATIC DECLARATIONS

Beneficiary API reference · mansoq-kutumba

Static source contract for Beneficiary: 1 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.

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.

Declared route and availability

This resource is declared in mansoq-kutumba at /api/{installed_plugin_prefix}/beneficiary/. plugin/local mount; actual prefix and enablement require deployment verification A registered path and an indexed handler do not prove deployment availability, user permission or production readiness.

Operation map

Method Path Action Evidence
POST /api/{installed_plugin_prefix}/beneficiary/lookup/ lookup @action declaration

lookup · POST

Lookup beneficiary data by Ration Card number.

Request body: { "rc_number": "110399147990" }

Returns family member data from Karnataka Kutumba system.

POST /api/{installed_plugin_prefix}/beneficiary/lookup/ — action lookup. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true

Observed authorization checks: can_create_patient. Helper/queryset evidence is included; this is not proof of complete security review.

Class policy declarations: permission_classes: IsAuthenticated.

Explicit response statuses in observed code: status.HTTP_200_OK, status.HTTP_503_SERVICE_UNAVAILABLE, status.HTTP_400_BAD_REQUEST. Other branches/framework exception handling may differ.

Declared refusal/error evidence: PermissionDenied: You do not have permission to look up Kutumba beneficiaries.

Integration review checklist

Confirm the installed route and full schema; review authentication, organization/facility scoping, all accepted fields, value-state and date/time semantics, idempotency, pagination, response/exception branches and the allowed correction/reversal workflow. Test positive and negative cases with synthetic data. This source reference does not establish external certification or replace an illustrated user procedure.

Pinned source evidence

Links require access to the private source repository.