Skip to content

Link camera to organisation

Request

Link a camera to an organisation.

Security
api_key
Bodyapplication/json
namestring
serialNumberstringrequired
siteIdstring, (uuid)required
curl -i -X POST \
  https://coreapi.hoxton.ai/_mock/v1/cameras \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "serialNumber": "string",
    "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1"
  }'

Responses

OK.

Bodyapplication/json
cameraPositionIdstring, (uuid)
cameraStatusstring or nullread-only
Enum:"offline""online""not_recording""lagging""not_uploading"
claimedAtstring, (date-time)
direction1Aliasstring
direction2Aliasstring
encodedFramesProportionnumber or null, (float64), >= 0read-only

The number of frames encoded over the expected number of frames in the last 2 minutes.

idstring, (uuid)
isOnlineboolean or null
lastSeenAtstring or null, (date-time)
lastVideoAtstring or null, (date-time)read-only
namestring
networkTransmitRatenumber or null, (uint64), >= 0read-only

The rate in bytes/second the camera sends information over the network at.

organisationIdstring, (uuid)read-only
serialNumberstringread-only
siteIdstring, (uuid)
statestring
Enum:"running""decommissioned""paused"
videoBacklognumber or null, (uint64), >= 0

The number of milliseconds of video the camera is waiting to upload.

videoUploadLatencynumber or null, >= 0read-only

The number of milliseconds it took the latest video uploaded to be uploaded.

Response
{
  "cameraPositionId": "37eacd70-df6f-462c-b57e-ba61d0ee7150",
  "cameraStatus": "offline",
  "claimedAt": "2019-08-24T14:15:22Z",
  "direction1Alias": "string",
  "direction2Alias": "string",
  "encodedFramesProportion": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "isOnline": true,
  "lastSeenAt": "2019-08-24T14:15:22Z",
  "lastVideoAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "networkTransmitRate": 0,
  "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  "serialNumber": "string",
  "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  "state": "running",
  "videoBacklog": 0,
  "videoUploadLatency": 0
}