← Technical API reference

Backend resource · STATIC DECLARATIONS

Hiu Views.Patient Consent Requests API reference · mansoq-abdm

Static source contract for Hiu Views.Patient Consent Requests: 2 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-abdm at /api/{installed_plugin_prefix}/patients/{patient_id}/abha/consent-requests. 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
GET /api/{installed_plugin_prefix}/patients/{patient_id}/abha/consent-requests get explicit Django path/view declaration
POST /api/{installed_plugin_prefix}/patients/{patient_id}/abha/consent-requests post explicit Django path/view declaration

get · GET

GET /api/{installed_plugin_prefix}/patients/{patient_id}/abha/consent-requests — action get. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path patient_id UUID true
deployment mount installed_plugin_prefix deployment-selected mount prefix true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query facility not declared at read site not established

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

Class policy declarations: permission_classes: IsAuthenticated.

post · POST

POST /api/{installed_plugin_prefix}/patients/{patient_id}/abha/consent-requests — action post. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path patient_id UUID true
deployment mount installed_plugin_prefix deployment-selected mount prefix true

body validation: ConsentRequestBody. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
facility_id str true No extra constraint extracted
purpose_code str false No extra constraint extracted
hi_types list[str] false No extra constraint extracted
date_from str false No extra constraint extracted
date_to str false No extra constraint extracted
data_erase_at str false No extra constraint extracted
hip_id str false No extra constraint extracted
hip_name str false No extra constraint extracted

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

Class policy declarations: permission_classes: IsAuthenticated.

Explicit response statuses in observed code: dynamic status. Other branches/framework exception handling may differ.

Declared refusal/error evidence: ValidationError (dynamic detail; inspect source); _plug_error (dynamic detail; inspect source).

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.