Skip to main content
Skip table of contents

Camera management. VMS Billing API

Synchronizes the user's cameras by user login.

POST/api/v1/billing/user/manage/cameras

Headers

Accept

application/json

Body

json

JSON
{
    "login": "user@mail.com",
    "camera_ids": [
        1,
        2,
        3
    ],
    "camera_external_ids": [
        26,
        "27",
        28
    ],
    "public_group_external_ids": [
        7
    ],
    "private_group_external_ids": [
        {
            "key": "test",
            "group_external_id": 8
        }
    ]
}

loginrequired

string

User login

camera_idsrequired

array

List of camera IDs from VMS database

camera_external_idsrequired

array

List of camera IDs that were specified when creating the camera

public_group_external_idsrequired

array

List of public camera group IDs

private_group_external_idsrequired

array

List of private camera group IDs

private_group_external_ids.*required

array

Array of key and identifier of a private group of cameras

private_group_external_ids.*.keyrequired

string

Access key to a private camera group

private_group_external_ids.*.group_external_idrequired

string|int

Private camera group ID

Response

204

Successful response

422

Returns a JSON object with an error. Validation

JSON
{
    "message": "There will be no informative message here",
    "errors": {
        "any_key": [
            "The reason for the error will be described here."
        ]
    }
}

Example

JSON
curl -k --location --request POST 'https://vms.local/api/v1/billing/user/manage/cameras' \
--header 'Accept:application/json' \
--header 'Content-Type: application/json \
--data-raw '{
    "login": "user@mail.com",
    "camera_ids": [
        1,
        2,
        3
    ],
    "camera_external_ids": [
        26,
        "27",
        28
    ],
    "public_group_external_ids": [
        7
    ],
    "private_group_external_ids": [
        {
            "key": "test",
            "group_external_id": 8
        }
    ]
}'
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.