{"schemaVersion":"1.0","sourceCommit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca","sourceVisibility":"private","article":{"id":"api-mansoq-abdm-teleicu-abhanumberviewset-fa21a20f","title":"Abha Number API reference · mansoq-abdm-teleicu","summary":"Static source contract for Abha Number: 2 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.","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":"Declared route and availability","body":"This resource is declared in **mansoq-abdm-teleicu** at `/api/{installed_plugin_prefix}/abha_number/`. 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."},{"title":"Operation map","body":"| Method | Path | Action | Evidence |\n| --- | --- | --- | --- |\n| POST | `/api/{installed_plugin_prefix}/abha_number/` | create | standard external DRF mixin; library behavior review pending |\n| GET | `/api/{installed_plugin_prefix}/abha_number/{pk}/` | retrieve | standard external DRF mixin; library behavior review pending |"},{"title":"create · POST","body":"**POST /api/{installed_plugin_prefix}/abha_number/** — action `create`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |\n\n**serializer: AbhaNumberSerializer**. Declared fields below; inherited fields are retained in the schema inventory.\n\n| Field | Type | Required | Constraints |\n| --- | --- | --- | --- |\n| id | serializers.CharField | framework default | read_only: true |\n| patient | serializers.UUIDField | false | required: false; allow_null: true |\n| new | serializers.BooleanField | framework default | read_only: true |\n| date_of_birth | serializers.CharField | framework default | read_only: true |\n\n**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.\n\n**Class policy declarations:** permission_classes: IsAuthenticated."},{"title":"retrieve · GET","body":"**GET /api/{installed_plugin_prefix}/abha_number/{pk}/** — action `retrieve`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |\n| path | pk | router lookup string; semantic ID validation requires handler/schema review | true |\n\n**serializer: AbhaNumberSerializer**. Declared fields below; inherited fields are retained in the schema inventory.\n\nThe declared field table is shown at its first occurrence in this reference; this operation links the same schema.\n\n**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.\n\n**Class policy declarations:** permission_classes: IsAuthenticated."},{"title":"Integration review checklist","body":"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."}],"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-abdm-teleicu/abdm/urls.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/viewsets/abha_number.py","line":15,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/serializers/abha_number.py","line":8,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}],"related":["it-api-contract","it-api-auth","security-rcm-roles"],"verification":"Static API contract — behavior review pending","version":"f6e9f05f76d4","apiReferenceIds":["backend-resource-5dd41d67fa21a20f","backend-resource-5dd41d67fa21a20f:POST:create","backend-resource-5dd41d67fa21a20f:GET:retrieve"]},"backend":{"resources":[{"id":"backend-resource-5dd41d67fa21a20f","localPrefix":"abha_number","viewset":"AbhaNumberViewSet","classId":"repositories/teleicu/mansoq-abdm-teleicu:abdm.api.viewsets.abha_number.AbhaNumberViewSet","basename":"abdm__abha_number","source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/urls.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"conditions":[],"repository":"repositories/teleicu/mansoq-abdm-teleicu","classSource":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/viewsets/abha_number.py","line":15,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"description":"","path":"/api/{installed_plugin_prefix}/abha_number/","mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","operationIds":["backend-resource-5dd41d67fa21a20f:POST:create","backend-resource-5dd41d67fa21a20f:GET:retrieve"],"unresolvedViewset":false,"reviewStatus":"registered resource enumerated; behavioral review pending"}],"operations":[{"id":"backend-resource-5dd41d67fa21a20f:POST:create","resourceId":"backend-resource-5dd41d67fa21a20f","repository":"repositories/teleicu/mansoq-abdm-teleicu","boundary":"optional-plugin/local-service","method":"POST","path":"/api/{installed_plugin_prefix}/abha_number/","declaredPattern":"/api/{installed_plugin_prefix}/abha_number/","action":"create","viewset":"AbhaNumberViewSet","classId":"repositories/teleicu/mansoq-abdm-teleicu:abdm.api.viewsets.abha_number.AbhaNumberViewSet","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/urls.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":null,"registrationConditions":[],"evidenceKind":"standard external DRF mixin; library behavior review pending","methodEvidenceIds":[],"schemaIds":{"serializer":"repositories/teleicu/mansoq-abdm-teleicu:abdm.api.serializers.abha_number.AbhaNumberSerializer"},"classPermissionEvidence":[{"kind":"permission_classes","declaration":["IsAuthenticated"],"source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/viewsets/abha_number.py","line":23,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"installed_plugin_prefix","in":"deployment mount","type":"deployment-selected mount prefix","required":true,"source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/urls.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]},{"id":"backend-resource-5dd41d67fa21a20f:GET:retrieve","resourceId":"backend-resource-5dd41d67fa21a20f","repository":"repositories/teleicu/mansoq-abdm-teleicu","boundary":"optional-plugin/local-service","method":"GET","path":"/api/{installed_plugin_prefix}/abha_number/{pk}/","declaredPattern":"/api/{installed_plugin_prefix}/abha_number/{pk}/","action":"retrieve","viewset":"AbhaNumberViewSet","classId":"repositories/teleicu/mansoq-abdm-teleicu:abdm.api.viewsets.abha_number.AbhaNumberViewSet","detail":true,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/urls.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":null,"registrationConditions":[],"evidenceKind":"standard external DRF mixin; library behavior review pending","methodEvidenceIds":[],"schemaIds":{"serializer":"repositories/teleicu/mansoq-abdm-teleicu:abdm.api.serializers.abha_number.AbhaNumberSerializer"},"classPermissionEvidence":[{"kind":"permission_classes","declaration":["IsAuthenticated"],"source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/viewsets/abha_number.py","line":23,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"installed_plugin_prefix","in":"deployment mount","type":"deployment-selected mount prefix","required":true,"source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/urls.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"pk","in":"path","type":"router lookup string; semantic ID validation requires handler/schema review","required":true,"source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/urls.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]}],"methodEvidence":[],"schemas":[{"id":"repositories/teleicu/mansoq-abdm-teleicu:abdm.api.serializers.abha_number.AbhaNumberSerializer","name":"AbhaNumberSerializer","source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/serializers/abha_number.py","line":8,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"kind":"Python declared schema/model evidence","fields":[{"name":"id","type":"serializers.CharField","required":"framework default","hasDefault":false,"constraints":{"read_only":true},"source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/serializers/abha_number.py","line":9,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"patient","type":"serializers.UUIDField","required":false,"hasDefault":false,"constraints":{"required":false,"allow_null":true},"source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/serializers/abha_number.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"new","type":"serializers.BooleanField","required":"framework default","hasDefault":false,"constraints":{"read_only":true},"source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/serializers/abha_number.py","line":18,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"date_of_birth","type":"serializers.CharField","required":"framework default","hasDefault":false,"constraints":{"read_only":true},"source":{"path":"repositories/teleicu/mansoq-abdm-teleicu/abdm/api/serializers/abha_number.py","line":19,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"validation":[],"baseTypes":["serializers.ModelSerializer"],"reviewStatus":"declared fields extracted; runtime validation review pending","referencedSchemaIds":[]}],"frameworkSettings":[]},"frontend":{"operations":[],"schemas":[]},"services":{"operations":[]},"boundaries":[]}