Video Webservice

Create shared timelapse group

Share multiple timelapses in one link

post/api/video/createSharedTimelapseGroup

Request

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

descriptionstring nullable

Description for the shared timelapse group

expirationTimeSecsinteger nullable

Expiration time in seconds for the shared group

plaintextPasswordstring nullable

Plaintext password for the shared timelapse group

timelapseUuidsstring[] nullable

List of timelapse UUIDs to include in the shared group

titlestring nullable

Title for the shared timelapse group

Example request

{
  "description": "Shared timelapse for security review",
  "expirationTimeSecs": 86400,
  "plaintextPassword": "securePassword123",
  "timelapseUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "title": "Security Review"
}

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

Share URL for the timelapse group

uuidstring RUUID nullable

base 64 (url-safe) uuid string

warningMsgstring nullable

Example response

{
  "shareUrl": "https://example.com/share/timelapse/12345",
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

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