Health Facility API reference · mansoq-abdm-teleicu

Declared route and availability

This resource is declared in mansoq-abdm-teleicu at /api/{installed_plugin_prefix}/health_facility/. 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

list · GET

GET /api/{installed_plugin_prefix}/health_facility/ — action list. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

serializer: HealthFacilitySerializer. Declared fields below; inherited fields are retained in the schema inventory.

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.

create · POST

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

Path and deployment-context parameters:

serializer: HealthFacilitySerializer. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

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.

retrieve · GET

GET /api/{installed_plugin_prefix}/health_facility/{facility__external_id}/ — action retrieve. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

serializer: HealthFacilitySerializer. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

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.

update · PUT

PUT /api/{installed_plugin_prefix}/health_facility/{facility__external_id}/ — action update. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

serializer: HealthFacilitySerializer. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

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.

partial_update · PATCH

PATCH /api/{installed_plugin_prefix}/health_facility/{facility__external_id}/ — action partial_update. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

serializer: HealthFacilitySerializer. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

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.

register_service · POST

POST /api/{installed_plugin_prefix}/health_facility/{facility__external_id}/register_service/ — action register_service. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

serializer: HealthFacilitySerializer. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

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: 400. Other branches/framework exception handling may differ.

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.