Backend resource · STATIC DECLARATIONS

Communication API reference · mansoq-nhcx

Static source contract for Communication: 3 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-nhcx at /api/{installed_plugin_prefix}/communication/. 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
POST	`/api/{installed_plugin_prefix}/communication/`	create	declared/inherited method
GET	`/api/{installed_plugin_prefix}/communication/{external_id}/`	retrieve	declared/inherited method
POST	`/api/{installed_plugin_prefix}/communication/{external_id}/send/`	send	@action declaration

create · POST

POST /api/{installed_plugin_prefix}/communication/ — action create. 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

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

Location	Field	Declared/inferred read type	Requiredness evidence
body	`form_submission`	not declared at read site	not established

request: CommunicationCreateSpec. 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
created_date	datetime \| None	false	No extra constraint extracted
modified_date	datetime \| None	false	No extra constraint extracted
status	CommunicationStatusChoices \| None	false	No extra constraint extracted
priority	CommunicationPriorityChoices \| None	false	No extra constraint extracted
category	list[ValueSetBoundCoding[NHCX_COMMUNICATION_CATEGORY_VALUESET.slug]]	false	No extra constraint extracted
payload	list[CommunicationPayloadSpec]	false	min_length: 1
based_on	UUID4	true	No extra constraint extracted

response: CommunicationRetrieveSpec. 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
created_date	datetime \| None	false	No extra constraint extracted
modified_date	datetime \| None	false	No extra constraint extracted
status	str	true	No extra constraint extracted
priority	str \| None	false	No extra constraint extracted
category	list[dict]	false	No extra constraint extracted
sent	datetime \| None	false	No extra constraint extracted
payload	list[dict]	false	No extra constraint extracted
based_on	UUID4	true	No extra constraint extracted
part_of	UUID4	true	No extra constraint extracted
about	UUID4	true	No extra constraint extracted
created_by	dict \| None	false	No extra constraint extracted
updated_by	dict \| None	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.

retrieve · GET

GET /api/{installed_plugin_prefix}/communication/{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: CommunicationRetrieveSpec. 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.

send · POST

POST /api/{installed_plugin_prefix}/communication/{external_id}/send/ — action send. 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: CommunicationRetrieveSpec. 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.

Explicit response statuses in observed code: status.HTTP_200_OK. 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.

Pinned source evidence

Links require access to the private source repository.