Skip to main content
POST
/
api
/
relay
/
ptzStatus
PTZ status
curl --request POST \
  --url https://api2.rhombussystems.com/api/relay/ptzStatus \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "thirdPartyCameraUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>",
  "xpositionPermyriad": 5000,
  "ypositionPermyriad": 5000,
  "zpositionPermyriad": 5000
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for getting PTZ status of a camera.

​
thirdPartyCameraUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object containing PTZ status of a camera.

​
error
boolean | null
​
errorMsg
string | null
​
warningMsg
string | null
​
xpositionPermyriad
integer<int32> | null

Current X-axis position in permyriad units

Example:

5000

​
ypositionPermyriad
integer<int32> | null

Current Y-axis position in permyriad units

Example:

5000

​
zpositionPermyriad
integer<int32> | null

Current Z-axis position in permyriad units

Example:

5000