{"schemaVersion":"1.0","sourceCommit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca","sourceVisibility":"private","article":{"id":"api-mansoq-abdm-hip-views-patientsmslink-0462552b","title":"Hip Views.Patient Sms Link API reference · mansoq-abdm","summary":"Static source contract for Hip Views.Patient Sms Link: 1 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** at `/api/{installed_plugin_prefix}/patients/{patient_id}/abha/sms-link`. 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}/patients/{patient_id}/abha/sms-link` | post | explicit Django path/view declaration |"},{"title":"post · POST","body":"**POST /api/{installed_plugin_prefix}/patients/{patient_id}/abha/sms-link** — action `post`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| path | patient_id | UUID | true |\n| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |\n\n**body validation: SmsLinkBody**. Declared fields below; inherited fields are retained in the schema inventory.\n\n| Field | Type | Required | Constraints |\n| --- | --- | --- | --- |\n| facility_id | str | true | No extra constraint extracted |\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.\n\n**Explicit response statuses in observed code:** dynamic status. Other branches/framework exception handling may differ.\n\n**Declared refusal/error evidence:** ValidationError (dynamic detail; inspect source)."},{"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/platform/mansoq-abdm/backend/src/abdm/urls.py","line":49,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-abdm/backend/src/abdm/hip/views.py","line":240,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-abdm/backend/src/abdm/hip/views.py","line":231,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}],"related":["it-api-contract","it-api-auth","security-rcm-roles"],"verification":"Static API contract — behavior review pending","version":"f6e9f05f76d4","apiReferenceIds":["backend-path-33c573250462552b","backend-path-33c573250462552b:POST:post"]},"backend":{"resources":[{"id":"backend-path-33c573250462552b","declaredPath":"patients/<uuid:patient_id>/abha/sms-link","dynamicPath":false,"source":{"path":"repositories/platform/mansoq-abdm/backend/src/abdm/urls.py","line":49,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"conditions":[],"kind":"view","view":"hip_views.PatientSmsLink","classId":"repositories/platform/mansoq-abdm:abdm.hip.views.PatientSmsLink","actionMapping":null,"operationIds":["backend-path-33c573250462552b:POST:post"],"path":"/api/{installed_plugin_prefix}/patients/{patient_id}/abha/sms-link","mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","reviewStatus":"direct route enumerated; behavioral review pending"}],"operations":[{"id":"backend-path-33c573250462552b:POST:post","resourceId":"backend-path-33c573250462552b","repository":"repositories/platform/mansoq-abdm","boundary":"optional-plugin/local-service","method":"POST","path":"/api/{installed_plugin_prefix}/patients/{patient_id}/abha/sms-link","declaredPattern":"patients/<uuid:patient_id>/abha/sms-link","action":"post","viewset":"hip_views.PatientSmsLink","classId":"repositories/platform/mansoq-abdm:abdm.hip.views.PatientSmsLink","detail":null,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/platform/mansoq-abdm/backend/src/abdm/urls.py","line":49,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/platform/mansoq-abdm/backend/src/abdm/hip/views.py","line":240,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"explicit Django path/view declaration","decoratorStatus":null,"decoratorPolicy":{},"methodEvidenceIds":["repositories/platform/mansoq-abdm/backend/src/abdm/hip/views.py:240:post"],"schemaIds":{"body validation":"repositories/platform/mansoq-abdm:abdm.hip.views.SmsLinkBody"},"classPermissionEvidence":[{"kind":"permission_classes","declaration":["IsAuthenticated"],"source":{"path":"repositories/platform/mansoq-abdm/backend/src/abdm/hip/views.py","line":238,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"patient_id","in":"path","type":"UUID","required":true,"source":{"path":"repositories/platform/mansoq-abdm/backend/src/abdm/urls.py","line":49,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"installed_plugin_prefix","in":"deployment mount","type":"deployment-selected mount prefix","required":true,"source":{"path":"repositories/platform/mansoq-abdm/backend/src/abdm/urls.py","line":49,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]}],"methodEvidence":[{"id":"repositories/platform/mansoq-abdm/backend/src/abdm/hip/views.py:240:post","name":"post","owner":"repositories/platform/mansoq-abdm:abdm.hip.views.PatientSmsLink","summary":"","source":{"path":"repositories/platform/mansoq-abdm/backend/src/abdm/hip/views.py","line":240,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[{"name":"patient_id","type":"unspecified","required":true,"source":{"path":"repositories/platform/mansoq-abdm/backend/src/abdm/hip/views.py","line":240,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"parametersRead":[],"permissionChecks":[],"declaredErrors":[{"exception":"ValidationError","message":null,"dynamicMessage":true,"source":{"path":"repositories/platform/mansoq-abdm/backend/src/abdm/hip/views.py","line":245,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"exception":"ValidationError","message":null,"dynamicMessage":true,"source":{"path":"repositories/platform/mansoq-abdm/backend/src/abdm/hip/views.py","line":250,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"explicitResponseStatuses":[{"value":null,"symbol":null,"source":{"path":"repositories/platform/mansoq-abdm/backend/src/abdm/hip/views.py","line":251,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"conditions":[],"schemaIds":["repositories/platform/mansoq-abdm:abdm.hip.views.SmsLinkBody"],"schemaUsages":[{"purpose":"body validation","schemaId":"repositories/platform/mansoq-abdm:abdm.hip.views.SmsLinkBody","source":{"path":"repositories/platform/mansoq-abdm/backend/src/abdm/hip/views.py","line":243,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"}],"schemas":[{"id":"repositories/platform/mansoq-abdm:abdm.hip.views.SmsLinkBody","name":"SmsLinkBody","source":{"path":"repositories/platform/mansoq-abdm/backend/src/abdm/hip/views.py","line":231,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"kind":"Python declared schema/model evidence","fields":[{"name":"facility_id","type":"str","required":true,"hasDefault":false,"source":{"path":"repositories/platform/mansoq-abdm/backend/src/abdm/hip/views.py","line":232,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}}],"validation":[],"baseTypes":["BaseModel"],"reviewStatus":"declared fields extracted; runtime validation review pending","referencedSchemaIds":[]}],"frameworkSettings":[]},"frontend":{"operations":[],"schemas":[]},"services":{"operations":[]},"boundaries":[]}