← Technical API reference

Backend resource · STATIC DECLARATIONS

Preset Encounter Camera API reference · mansoq-teleicu-devices

Static source contract for Preset Encounter Camera: 2 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-teleicu-devices at /api/{installed_plugin_prefix}/preset_encounter_cameras/{encounter_external_id}/. 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}/preset_encounter_cameras/{encounter_external_id}/ list declared/inherited method
GET /api/{installed_plugin_prefix}/preset_encounter_cameras/{encounter_external_id}/{external_id}/ retrieve declared/inherited method

list · GET

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

Path and deployment-context parameters:

Location Parameter Type Required
path encounter_external_id string/default converter true
deployment mount installed_plugin_prefix deployment-selected mount prefix true

response: DeviceListSpec. 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
identifier str | None false No extra constraint extracted
status DeviceStatusChoices true No extra constraint extracted
availability_status DeviceAvailabilityStatusChoices true No extra constraint extracted
manufacturer str | None false No extra constraint extracted
manufacture_date datetime | None false No extra constraint extracted
expiration_date datetime | None false No extra constraint extracted
lot_number str | None false No extra constraint extracted
serial_number str | None false No extra constraint extracted
registered_name str true No extra constraint extracted
user_friendly_name str | None false No extra constraint extracted
model_number str | None false No extra constraint extracted
part_number str | None false No extra constraint extracted
contact list[ContactPoint] false No extra constraint extracted
care_type str | None false No extra constraint extracted
mansoq_metadata dict false No extra constraint extracted

Observed authorization checks: can_read_devices_on_location. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: You do not have permission to get devices of this location..

retrieve · GET

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

Path and deployment-context parameters:

Location Parameter Type Required
path encounter_external_id string/default converter true
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: DeviceRetrieveSpec. 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
identifier str | None false No extra constraint extracted
status DeviceStatusChoices true No extra constraint extracted
availability_status DeviceAvailabilityStatusChoices true No extra constraint extracted
manufacturer str | None false No extra constraint extracted
manufacture_date datetime | None false No extra constraint extracted
expiration_date datetime | None false No extra constraint extracted
lot_number str | None false No extra constraint extracted
serial_number str | None false No extra constraint extracted
registered_name str true No extra constraint extracted
user_friendly_name str | None false No extra constraint extracted
model_number str | None false No extra constraint extracted
part_number str | None false No extra constraint extracted
contact list[ContactPoint] false No extra constraint extracted
care_type str | None false No extra constraint extracted
mansoq_metadata dict false No extra constraint extracted
current_encounter dict | None false No extra constraint extracted
current_location dict true No extra constraint extracted
created_by dict | None false No extra constraint extracted
updated_by dict | None false No extra constraint extracted
managing_organization dict | None false No extra constraint extracted

Observed authorization checks: can_read_devices_on_location. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: You do not have permission to get devices of this location..

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.