Camera Webservice

PTZ move

Move a first-party mechanical PTZ camera by permyriad delta

post/api/camera/ptzMove

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/camera/ptzMove
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

cameraUuidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

xmovementPermyriadinteger nullable

X-axis movement in permyriad units

ymovementPermyriadinteger nullable

Y-axis movement in permyriad units

zmovementPermyriadinteger nullable

Z-axis movement in permyriad units

Example request

{
  "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "xmovementPermyriad": 1000,
  "ymovementPermyriad": 1000,
  "zmovementPermyriad": 1000
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.