Relay Webservice

Get third party camera discovery scan status

Returns the progress of the current/most-recent third-party camera discovery run in the org, so clients can show progress and distinguish not-started, in-progress, and complete (including complete-with-zero-cameras).

post/api/relay/getThirdPartyCameraDiscoveryScanStatus

Request

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

RelayGetThirdPartyCameraDiscoveryScanStatusWSRequest required

Request object for getting the progress of the current/most-recent third-party camera discovery run in the organization.

Response

OK

camerasFoundinteger nullable

Number of cameras discovered so far in this run.

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

Whether discovery has ever been run for this org. When false, all other fields are unset/zero.

inProgressboolean nullable

Whether a discovery run is still in progress (at least one Relay scan outstanding and the run is not stale).

nvrCountinteger nullable

Total number of Relays (NVRs) this run is scanning.

pendingCountinteger nullable

Number of Relays whose scan has not yet finished. Zero means the run is complete.

scanIdstring nullable

Opaque id of the run, so clients can tell if a newer run superseded theirs.

startedMsinteger nullable

Epoch millis when the run started.

warningMsgstring nullable

Changes

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