Relay Webservice

PTZ status

Returns ptz status

post/api/relay/ptzStatus

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/relay/ptzStatus
  • 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

thirdPartyCameraUuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "thirdPartyCameraUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

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
xpositionPermyriadinteger nullable

Current X-axis position in permyriad units

ypositionPermyriadinteger nullable

Current Y-axis position in permyriad units

zpositionPermyriadinteger nullable

Current Z-axis position in permyriad units

Example response

{
  "xpositionPermyriad": 5000,
  "ypositionPermyriad": 5000,
  "zpositionPermyriad": 5000
}

Changes

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