Versions Compared

Old Version 1

changes.mady.by.user Alina Luchkina

Saved on

compared with

New Version 2

changes.mady.by.user Alena Kniazeva

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GET http://IP A-address:port/prefix/camera/list − list—get all available original sources (cameras) of Axxon-a domain. 

The returned VIDEOSOURCEID identifiers will have VIDEOSOURCEID identifiers will have the format as follows "HOSTNAME/ObjectType.Id/Endpoint.Name". Friendly name and other related meta data metadata will also be received.

ParameterRequiredDescription
limitNoDetermines the maximum number of returned results, the default value is 1000
.
next_pageNoThe value of the nextPageToken parameter, which will be in the response if the request returns not all
the
results. It is used to get the following values
.
filterNo

Allows getting a subset of the results in accordance with the filter. Currently, it can have the HOSTNAME or VIDEOSOURCEID values

.

Note
titleAttention!

If Office is specified as the Server name, then the GET http://IP-address:port/prefix/camera/list?filter=Office request will receive all video cameras of the Office Server.


group_idsNo

List of the group identifiers to which the cameras should belong (see Get list of groups and their contents). It is possible to specify several identifiers using the separator "|". For example:

Code Block
http://localhost:80/camera/list?group_ids=6af92229-43ff-0347-9dae-081bf9835733|b48111eb-64c5-294c-a69c-4adb07c954d1

In this case, the response will contain all

the

cameras that belong at least to one of the specified groups

.

Sample request:

GET GET http://127.0.0.1:80/camera/list?filter=Server1

Sample response:

Expand
titleClick to expand...


Code Block
{
    "cameras" :
    [
        {
            "accessPoint" : "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
            "archives" : [],
            "audioStreams" :
            [
                {
                    "accessPoint" : "hosts/Server1/DeviceIpint.1/SourceEndpoint.audio:0",
                    "isActivated" : false
                }
            ],
            "azimuth" : "0",
            "camera_access" : "CAMERA_ACCESS_FULL",
            "comment" : "",
            "detectors" : [],
            "displayId" : "1",
            "displayName" : "Street",
            "enabled" : true,
            "groups" :
            [
                "e2f20843-7ce5-d04c-8a4f-826e8b16d39c"
            ],
            "ipAddress" : "0.0.0.0",
            "isActivated" : true,
            "latitude" : "0",
            "longitude" : "0",
            "model" : "TestDevice",
            "offlineDetectors" : [],
            "panomorph" : false,
            "ptzs" :
            [
                {
                    "accessPoint" : "hosts/Server1/DeviceIpint.1/TelemetryControl.0",
                    "areaZoom" : false,
                    "focus" :
                    {
                        "isAbsolute" : false,
                        "isAuto" : false,
                        "isContinous" : true,
                        "isRelative" : false
                    },
                    "iris" :
                    {
                        "isAbsolute" : false,
                        "isAuto" : false,
                        "isContinous" : true,
                        "isRelative" : false
                    },
                    "is_active" : true,
                    "move" :
                    {
                        "isAbsolute" : false,
                        "isAuto" : false,
                        "isContinous" : true,
                        "isRelative" : false
                    },
                    "pointMove" : false,
                    "zoom" :
                    {
                        "isAbsolute" : false,
                        "isAuto" : false,
                        "isContinous" : true,
                        "isRelative" : false
                    }
                }
            ],
            "rays" :
            [
                {
                    "accessPoint" : "hosts/Server1/DeviceIpint.1/EventSupplier.ray0:0",
                    "displayId" : "1.0.0",
                    "displayName" : "Ray",
                    "enabled" : true,
                    "isActivated" : true
                },
                {
                    "accessPoint" : "hosts/Server1/DeviceIpint.1/EventSupplier.ray0:1",
                    "displayId" : "1.0.1",
                    "displayName" : "Ray",
                    "enabled" : true,
                    "isActivated" : true
                }
            ],
            "textSources" : [],
            "vendor" : "Virtual",
            "videoStreams" :
            [
                {
                    "accessPoint" : "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0"
                }
            ]
        },
        {
            "accessPoint" : "hosts/Server1/DeviceIpint.2/SourceEndpoint.video:0:0",
            "archives" :
            [
                {
                    "accessPoint" : "hosts/Server1/DeviceIpint.2/SourceEndpoint.video:0:0",
                    "default" : false,
                    "incomplete" : truefalse,
                    "isEmbedded" : false,
                    "storage" : "hosts/Server1/MultimediaStorage.AliceBlue/MultimediaStorage",
                    "storageDisplayName" : "AliceBlue"
                }
            ],
            "audioStreams" :
            [
                {
                    "accessPoint" : "hosts/Server1/DeviceIpint.12/SourceEndpoint.audio:0",
                    "isActivated" : falsetrue
                }
            ],
            "azimuth" : "0,000000",
            "camera_access" : "CAMERA_ACCESS_FULL",
            "comment" : "",
            "detectors" :
            [
                {
                    "accessPoint" : "hosts/Server1/AVDetector.1/EventSupplier",
                    "displayName" : "MotionFace detection",
                    "events" :
                    [
                        "MotionDetectedTargetList",
                        "MotionMaskfaceAppeared",
                    ],
    "TargetList"
                "isActivated" :   ]false,
                    "parentDetector" : "",
                    "type" : "unknownTvaFaceDetector"
                }
            ],
            "displayId" : "12",
            "displayName" : "Camera 1"Hall",
            "enabled" : true,
            "groups" :
            [
                "e2f20843-7ce5-d04c-8a4f-826e8b16d39c"
            ],
            "ipAddress" : "0.0.0.0",
            "isActivated" : true,
            "latitude" : "0,00000078.2379",
            "longitude" : "0,00000015.4466",
            "model" : "Virtual several streams",
            "offlineDetectors" : [],
            "panomorph" : false,
            "ptzs" : [],
            "rays" : [],
            "textSources" : [],
            "vendor" : "AxxonSoftVirtual",
            "videoStreams" :
            [
                {
                    "accessPoint" : "hosts/Server1/DeviceIpint.12/SourceEndpoint.video:0:0"
                },
                {
                    "accessPoint" : "hosts/Server1/DeviceIpint.12/SourceEndpoint.video:0:1"
                }
            ]
        }
    ],
    "search_meta_data" :
    [
        {
            "matches" :
            [
                6,
                7,
                8,
                9,
                10,
                11,
                12
            ],
            "score" : 0
        },
        {
            "matches" :
            [
                6,
                7,
                8,
                9,
                10,
                11,
                12
            ],
            "score" : 0
        }
    ]
}



ParameterParameter description
ParameterDescription
archives

List of archives to which the camera is connected

.

audioStreams

Audio stream

.

comment
Commentary.
Comment
camera_access

Access rights to the camera, where:

  • CAMERA_ACCESS_FULL—full access,
  • CAMERA_ACCESS_ONLY_ARCHIVE—archive only,
  • CAMERA_ACCESS_MONITORING_ON_PROTECTION—monitoring on protection,
  • CAMERA_ACCESS_MONITORING—monitoring,
  • CAMERA_ACCESS_ARCHIVE—monitoring/archive,
  • CAMERA_ACCESS_MONITORING_ARCHIVE_MANAGE—monitoring/archive/manage
detectorsList of created detection tools
.
displayIdFriendly
name.
identifier
displayNameName
.
groups

List of groups to which the camera belongs

.

ipAddressIP
Address.
address
isActivated

True

−

—the object is enabled, False

−

—the object is disabled

.

azimuth, latitude, longitude

The coordinates of the camera. Depending on the Server localization, the parameter values can be separated by either a period or a comma

.

modelModel
.
ptzs

PTZ devices, where:

  • is_active
–
  • —indicates whether the PTZ
 object
  • object is activated,
  • pointMove
–
–
.
textSourcesEvent sources
.
vendorVendor
.
videoStreamsVideo streams
.