Relay Webservice

Assign multi-facet third party camera to NVR

Assign a multi-sensor third party camera to an NVR as one camera with multiple video facets (gated on the multiFacetThirdPartyCameraEnabled org flag)

post/api/relay/assignThirdPartyMultiFacetCameraToNVR

Request

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

discoveredCameraMacAddressstring nullable

MAC address of the discovered multi-sensor camera to assign

locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

namestring nullable

Name for the multi-facet third-party camera

nvruuidstring RUUID nullable

base 64 (url-safe) uuid string

rtspUrlsstring[] nullable

Ordered RTSP URLs, one per sensor/lens; index 0 -> VIDEO_0 (primary), index 1 -> VIDEO_1, ...

Example request

{
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "name": "Loading Dock Bispectrum",
  "nvruuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

deviceUuidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

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

Number of video facets (streams) bound to the camera

warningMsgstring nullable

Example response

{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0"
}

Changes

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