Versions Compared

Key

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

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

The returned VIDEOSOURCEID identifiers will have the format as follows "HOSTNAME/ObjectType.Id/Endpoint.Name". Friendly name and other related meta data 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

getitng

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 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 http://127.0.0.1:80/camera/list?filter=Server1

...

Expand
titleClick to expand...


Code Block
{
    "cameras": [
        {
            "archives": [
                {
                    "accessPoint": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
                    "default": true,
                    "isEmbedded": false,
                    "storage": "hosts/Server1/MultimediaStorage.AliceBlue/MultimediaStorage",
                    "storageDisplayName": "AliceBlue"
                }
            ],
            "audioStreams": [
                {
                    "accessPoint": "hosts/Server1/DeviceIpint.1/SourceEndpoint.audio:0",
                    "isActivated": false
                }
            ],
            "azimuth": "0,000000",
            "comment": "",
            "detectors": [
                {
                    "accessPoint": "hosts/Server1/AVDetector.1/EventSupplier",
                    "displayName": "Motion detection",
                    "events": [
                        "MotionDetected",
                        "MotionMask",
                        "TargetList"
                    ],
                    "parentDetector": "",
                    "type": "unknown"
                }
            ],
            "displayId": "1",
            "displayName": "Camera 1",
            "groups": [
                "e2f20843-7ce5-d04c-8a4f-826e8b16d39c"
            ],
            "ipAddress": "0.0.0.0",
            "isActivated": true,
            "latitude": "0,000000",
            "longitude": "0,000000",
            "model": "Virtual several streams",
            "offlineDetectors": [],
            "ptzs": [],
            "textSources": [],
            "vendor": "AxxonSoft",
            "videoStreams": [
                {
                    "accessPoint": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0"
                },
                {
                    "accessPoint": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:1"
                }
            ]
        },
        {



ParameterDescription
archives

List of archives to which the camera is connected.

audioStreams

Audio stream.

commentCommentary.
detectorsList of created detection tools.
displayIdFriendly name.
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 is activated,

pointMove

Point&Click support,

areaZoom

Areazoom support.

textSourcesEvent sources.
vendorVendor.
videoStreamsVideo streams.