← Technical API reference

Backend resource · STATIC DECLARATIONS

Camera API reference · mansoq-teleicu-gateway

Static source contract for Camera: 8 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-gateway at /api/{installed_plugin_prefix}/. 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}/status status @action declaration
GET /api/{installed_plugin_prefix}/presets presets @action declaration
POST /api/{installed_plugin_prefix}/set_preset set_preset @action declaration
POST /api/{installed_plugin_prefix}/gotoPreset go_to_preset @action declaration
POST /api/{installed_plugin_prefix}/absoluteMove absolute_move @action declaration
POST /api/{installed_plugin_prefix}/relativeMove relative_move @action declaration
POST /api/{installed_plugin_prefix}/snapshotAtLocation snapshot_at_location @action declaration
GET /api/{installed_plugin_prefix}/cameras/status camera_statuses @action declaration

status · GET

GET /api/{installed_plugin_prefix}/status — action status. 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
query hostname not declared at read site direct indexing; validation may be upstream
query port not declared at read site direct indexing; validation may be upstream
query username not declared at read site direct indexing; validation may be upstream
query password not declared at read site direct indexing; validation may be upstream

decorator responses: StatusResponseModel. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
position CameraAssetStatusResponse true No extra constraint extracted
moveStatus MoveStatusResponse true No extra constraint extracted
error str true 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.

Explicit response statuses in observed code: status.HTTP_200_OK. Other branches/framework exception handling may differ.

Declared refusal/error evidence: ValidationError (dynamic detail; inspect source).

presets · GET

GET /api/{installed_plugin_prefix}/presets — action presets. 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
query hostname not declared at read site direct indexing; validation may be upstream
query port not declared at read site direct indexing; validation may be upstream
query username not declared at read site direct indexing; validation may be upstream
query password not declared at read site direct indexing; validation may be upstream

decorator responses: PresetsResponse. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
presets Dict[str, int] true 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.

Explicit response statuses in observed code: status.HTTP_200_OK. Other branches/framework exception handling may differ.

Declared refusal/error evidence: ValidationError (dynamic detail; inspect source).

set_preset · POST

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

body validation: CameraAssetPresetRequest. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
hostname str true No extra constraint extracted
username str true No extra constraint extracted
password str true No extra constraint extracted
port int true No extra constraint extracted
useSecure Optional[bool] false No extra constraint extracted
preset int false No extra constraint extracted

decorator request: CameraAssetPresetRequest. 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.

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.

Explicit response statuses in observed code: status.HTTP_200_OK. Other branches/framework exception handling may differ.

go_to_preset · POST

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

body validation: CameraAssetPresetRequest. 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.

decorator request: CameraAssetPresetRequest. 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.

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.

Explicit response statuses in observed code: status.HTTP_200_OK, status.HTTP_404_NOT_FOUND. Other branches/framework exception handling may differ.

absolute_move · POST

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

body validation: CameraAssetMoveRequest. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
hostname str true No extra constraint extracted
username str true No extra constraint extracted
password str true No extra constraint extracted
port int true No extra constraint extracted
useSecure Optional[bool] false No extra constraint extracted
x float true No extra constraint extracted
y float true No extra constraint extracted
zoom float true No extra constraint extracted

decorator request: CameraAssetMoveRequest. 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.

decorator responses: MovementResponse. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
result MovementResponseMessage true 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.

Explicit response statuses in observed code: status.HTTP_200_OK. Other branches/framework exception handling may differ.

relative_move · POST

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

body validation: CameraAssetMoveRequest. 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.

decorator request: CameraAssetMoveRequest. 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.

decorator responses: MovementResponse. 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.

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.

Explicit response statuses in observed code: status.HTTP_200_OK. Other branches/framework exception handling may differ.

snapshot_at_location · POST

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

body validation: CameraAssetMoveRequest. 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.

decorator request: CameraAssetMoveRequest. 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.

decorator responses: SanpshotResponse. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
status str true No extra constraint extracted
uri str true 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.

Explicit response statuses in observed code: status.HTTP_200_OK. Other branches/framework exception handling may differ.

camera_statuses · GET

GET /api/{installed_plugin_prefix}/cameras/status — action camera_statuses. 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

decorator responses: StatusResponse. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
time datetime true No extra constraint extracted
status dict[str, str] true 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.

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.