Go to documentation repository
Documentation for Intellect 4.11.0-4.11.3. Documentation for other versions of Intellect is available too.
Previous page Next page
General request format:
GET http://IP-address:port/web2/secure/configuration?pageItems={pageItems}&page={page}
Request parameters:
| Parameter | Is required | Description |
|---|---|---|
| pageItems | No | Sets the page number displayed as a result of the request. pageItems > 0. By default, pageItems=1. |
| page | No | Sets the number of objects displayed on the page. page > 0. By default, page=1000. |
Attention!
If there are many objects in the system (>1000) they are to be displayed by pages.
Processing of all objects is performed page by pare until an empty array is received.
Request example:
GET http://127.0.0.1:8085/web2/secure/configuration
Response example:
The request returns the list of the following objects with states:
- cameras added to the Web-server with IDs of linked microphones, dynamics, PTZ devices, presets (see also Selecting and configuring cameras for the Web-server module).
- cameras added to maps selected for Web Server 2.0 are returned – see Selecting maps.
- sensors;
- relays;
- macros;
- RTSP servers with ports used, cameras added;
- list of zones and regions.
JSON:
[
{
"id": "1",
"name": "Zone 1",
"regions": [
{
"id": "1.1",
"zoneId": "1",
"name": "Region 1.1",
"zoneDescription": "Zone description"
}
]
},
{
"id": "2",
"name": "Zone 2",
"regions": [
{
"id": "2.1",
"zoneId": "2",
"name": "Region 2.1",
"zoneDescription": "Zone description"
}
]
}
]
XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<baseObjects>
<CAM>
<displayId>1</displayId>
<displayName>Display 1</displayName>
<extId>5</extId>
<id>CAM:5</id>
<monitorId>1</monitorId>
<monitorName>Monitor 1</monitorName>
<name>Камера 5</name>
<regionDescription>Region description</regionDescription>
<regionId>2.1</regionId>
<regionName>Region 2.1</regionName>
<state>
<fullState>DISARMED</fullState>
<id>connected</id>
<type>NORMAL</type>
</state>
<type>CAM</type>
<zoneId>2</zoneId>
<zoneName>Zone 2</zoneName>
<additionalInfo></additionalInfo>
<micId></micId>
<presets/>
<speakerId></speakerId>
<telemetryId></telemetryId>
</CAM>
</baseObjects>
Response parameters:
| Parameter | Description |
|---|---|
| General parameters | |
extId | Object ID |
id | Object type and ID in the format TYPE:ID |
name | Object name |
state | Object state. The <id> and <type> parameters show the state in the API terms, see State of a specific object fir details. |
type | Object type |
| Specific parameters | |
cams | List of cameras added to the RTSP Server with semicolon as a separator. |
port | Port used by RTSP Server |
| regionDescription | Region description |
regionId | ID of the region to which the object is added |
| regionName | Region name |
| zoneId | ID of the zone to which the object is added |
| zoneName | Zone name |
| latitide | Latitude (object coordinate if geo binding is configured). |
| longitude | Longitude (object coordinate if geo binding is configured). |
| monitorId | For camera: ID of the monitor to which the camera is added. |
| monitorName | For camera: name of the monitor to which the camera is added. |
| geo_angle | For camera: viewing angle (for camera, see Configuring the camera viewing angle display on the Map) |
| additionalInfo | For camera: the Additional info field value |
| micId | For camera: the ID of the associated microphone. |
| presets | For camera: preset list. |
| speakerId | For camera: the ID of the associated speaker. |
| telemetryId | For camera: the ID of the PTZ control panel. |
| displayId | For interface objects: display ID. |
| displayName | For interface objects: display name. |
Overview
Content Tools