Camera Webservice

Create protected shared video wall

Share a password protected video wall

post/api/camera/createProtectedSharedVideoWall

Request

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

expirationTimeSecsinteger nullable

Expiration time in seconds

invertScheduleboolean nullable

Whether to invert the schedule

passwordstring nullable

Password to protect the shared video wall

scheduleUuidstring RUUID nullable

base 64 (url-safe) uuid string

videoWallUuidstring RUUID nullable

base 64 (url-safe) uuid string

vodEnabledboolean nullable

Whether to enable video on demand

Example request

{
  "expirationTimeSecs": 86400,
  "password": "mypassword123",
  "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "videoWallUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "vodEnabled": true
}

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

URL for accessing the shared video wall

sharedLiveVideoStreamUuidstring RUUID nullable

base 64 (url-safe) uuid string

warningMsgstring nullable

Example response

{
  "sharedLiveVideoStreamUrl": "https://share.rhombussystems.com/videowall/abc123",
  "sharedLiveVideoStreamUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

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