MANSOQ Backend resource · STATIC DECLARATIONS
Notification Template API reference · mansoq-im-wrapper
Static source contract for Notification Template: 7 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-im-wrapper at /api/{installed_plugin_prefix}/notification-templates/. 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}/notification-templates/ |
list | declared/inherited method |
| GET | /api/{installed_plugin_prefix}/notification-templates/{external_id}/ |
retrieve | declared/inherited method |
| POST | /api/{installed_plugin_prefix}/notification-templates/{external_id}/toggle_active/ |
toggle_active | @action declaration |
| POST | /api/{installed_plugin_prefix}/notification-templates/sync/ |
sync | @action declaration |
| POST | /api/{installed_plugin_prefix}/notification-templates/{external_id}/set_variable_mapping/ |
set_variable_mapping | @action declaration |
| GET | /api/{installed_plugin_prefix}/notification-templates/{external_id}/schema/ |
variable_schema | @action declaration |
| POST | /api/{installed_plugin_prefix}/notification-templates/{external_id}/preview_variable_mapping/ |
preview_variable_mapping | @action declaration |
list · GET
GET /api/{installed_plugin_prefix}/notification-templates/ — action list. 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 |
response: NotificationTemplateReadSpec. Declared fields below; inherited fields are retained in the schema inventory.
| Field | Type | Required | Constraints |
|---|---|---|---|
| meta | dict | false | No extra constraint extracted |
| id | UUID4 | None | false | No extra constraint extracted |
| name | str | true | No extra constraint extracted |
| slug | str | true | No extra constraint extracted |
| provider | str | true | No extra constraint extracted |
| category | str | true | No extra constraint extracted |
| approval_status | str | true | No extra constraint extracted |
| is_active | bool | true | No extra constraint extracted |
| language_code | str | None | false | No extra constraint extracted |
| payload | dict[str, Any] | None | false | No extra constraint extracted |
| variable_mapping | dict[str, Any] | None | false | No extra constraint extracted |
| parameter_format | str | true | No extra constraint extracted |
| created_date | datetime.datetime | None | false | No extra constraint extracted |
| modified_date | datetime.datetime | None | false | No extra constraint extracted |
Observed authorization checks: can_read_notification_template. Helper/queryset evidence is included; this is not proof of complete security review.
Declared refusal/error evidence: PermissionDenied: You do not have permission to view notification templates..
retrieve · GET
GET /api/{installed_plugin_prefix}/notification-templates/{external_id}/ — action retrieve. 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 |
| path | external_id | router lookup string; semantic ID validation requires handler/schema review | true |
response: NotificationTemplateReadSpec. 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.
Observed authorization checks: can_read_notification_template. Helper/queryset evidence is included; this is not proof of complete security review.
Declared refusal/error evidence: PermissionDenied: You do not have permission to view notification templates.; PermissionDenied: You do not have permission to view this notification template..
toggle_active · POST
POST /api/{installed_plugin_prefix}/notification-templates/{external_id}/toggle_active/ — action toggle_active. 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 |
| path | external_id | router lookup string; semantic ID validation requires handler/schema review | true |
decorator responses: NotificationTemplateReadSpec. 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.
Observed authorization checks: can_manage_notification_template, can_read_notification_template. Helper/queryset evidence is included; this is not proof of complete security review.
Declared refusal/error evidence: PermissionDenied: You do not have permission to manage this notification template.; PermissionDenied: You do not have permission to view notification templates..
sync · POST
POST /api/{installed_plugin_prefix}/notification-templates/sync/ — action sync. 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_manage_notification_template, can_read_notification_template. Helper/queryset evidence is included; this is not proof of complete security review.
Explicit response statuses in observed code: 202. Other branches/framework exception handling may differ.
Declared refusal/error evidence: PermissionDenied: You do not have permission to sync notification templates.; PermissionDenied: You do not have permission to view notification templates..
set_variable_mapping · POST
POST /api/{installed_plugin_prefix}/notification-templates/{external_id}/set_variable_mapping/ — action set_variable_mapping. 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 |
| path | external_id | router lookup string; semantic ID validation requires handler/schema review | true |
Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):
| Location | Field | Declared/inferred read type | Requiredness evidence |
|---|---|---|---|
| body | variable_mapping |
not declared at read site | not established |
decorator responses: NotificationTemplateReadSpec. 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.
Observed authorization checks: can_manage_notification_template, can_read_notification_template. Helper/queryset evidence is included; this is not proof of complete security review.
Explicit response statuses in observed code: 400. Other branches/framework exception handling may differ.
Declared refusal/error evidence: PermissionDenied: You do not have permission to manage this notification template.; ValidationError: variable_mapping must be an object.; PermissionDenied: You do not have permission to view notification templates..
variable_schema · GET
Browsable field schema for this template's variable_mapping, unioned across every trigger that renders it. Empty groups when no trigger is linked yet.
GET /api/{installed_plugin_prefix}/notification-templates/{external_id}/schema/ — action variable_schema. 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 |
| path | external_id | router lookup string; semantic ID validation requires handler/schema review | true |
Observed authorization checks: can_read_notification_template. Helper/queryset evidence is included; this is not proof of complete security review.
Declared refusal/error evidence: PermissionDenied: You do not have permission to view this notification template.; PermissionDenied: You do not have permission to view notification templates..
preview_variable_mapping · POST
Renders an unsaved variable_mapping draft against a preview stub of the linked context, using the same resolve_variable() a real send uses.
POST /api/{installed_plugin_prefix}/notification-templates/{external_id}/preview_variable_mapping/ — action preview_variable_mapping. 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 |
| path | external_id | router lookup string; semantic ID validation requires handler/schema review | true |
Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):
| Location | Field | Declared/inferred read type | Requiredness evidence |
|---|---|---|---|
| body | variable_mapping |
not declared at read site | not established |
Observed authorization checks: can_manage_notification_template, can_read_notification_template. Helper/queryset evidence is included; this is not proof of complete security review.
Declared refusal/error evidence: PermissionDenied: You do not have permission to manage this notification template.; ValidationError: variable_mapping must be an object.; PermissionDenied: You do not have permission to view notification templates..
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.
- repositories/platform/mansoq-im-wrapper/src/mansoq_im_wrapper/urls.py:15
- repositories/platform/mansoq-im-wrapper/src/mansoq_im_wrapper/api/viewsets.py:103
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:168
- repositories/platform/mansoq-im-wrapper/src/mansoq_im_wrapper/api/viewsets.py:107
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:161
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:330
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:158
- repositories/platform/mansoq-im-wrapper/src/mansoq_im_wrapper/api/spec.py:16
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:83
- repositories/platform/mansoq-im-wrapper/src/mansoq_im_wrapper/api/viewsets.py:118
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:325
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:77
- repositories/platform/mansoq-im-wrapper/src/mansoq_im_wrapper/api/viewsets.py:128
- repositories/platform/mansoq-im-wrapper/src/mansoq_im_wrapper/api/viewsets.py:143
- repositories/platform/mansoq-im-wrapper/src/mansoq_im_wrapper/api/viewsets.py:158
- repositories/platform/mansoq-im-wrapper/src/mansoq_im_wrapper/api/viewsets.py:185
- repositories/platform/mansoq-im-wrapper/src/mansoq_im_wrapper/api/viewsets.py:203