Getting a list of all Axxon PSIM objects

General request format:

GET http://IP address:port/web2/secure/configuration/all?pageItems={pageItems}&page={page}&{objectClass}={objectClass}&{objectId}={objectId}

Request parameters:

Parameter	Required	Description
pageItems	No	Specifies the number of objects displayed on the page. The value must be greater than 0, by default page=1000. The page parameter only applies when the pageItems parameter is specified
page	No	Specifies the page number displayed as a result of the request. The value must be greater than 0, by default pageItems=1
objectClass	No	Identifier of an object class. Example: GRELE, MACRO, CAM
objectId	No	Object class and object Id, separated by a colon. Examples: CAM:1, GRAY:5, PEOPLE_COUNTER:1

Attention!

If there are many objects in the system (>1000), you must use a page-by-page display.

All objects are processed page by page until an empty array is received.

Request example:

GET http://127.0.0.1:8085/web2/secure/configuration/all

Response example:

The request returns the list of the following objects with states:

list of all cameras with the identifiers of the corresponding microphones, speakers, PTZ devices, presets, as well as monitors and displays on which the cameras are displayed;
list of all displays and monitors on which the cameras are displayed;
list of all cameras, added to the maps;
list of sensors;
list of relays;
list of macros;
list of RTSP servers with ports used, cameras added;
list of areas and regions;
map with all layers;
user;
list of video input devices.

XML:

This XML file does not appear to have any style information associated with it. The document tree is shown below.
<baseObjects>
<MACRO>
<extId>1</extId>
<id>MACRO:1</id>
<name>Command 1</name>
<state>
<id>normal</id>
<type>NORMAL</type>
</state>
<type>MACRO</type>
</MACRO>
<baseObject>
<displayId>1</displayId>
<extId>1</extId>
<id>DISPLAY:1</id>
<name>Disp 1</name>
<state>
<id>normal</id>
<type>NORMAL</type>
</state>
<type>DISPLAY</type>
</baseObject>
<CAM>
<displayId>1</displayId>
<extId>5</extId>
<id>CAM:5</id>
<monitorId>1</monitorId>
<name>Camera 5</name>
<regionId/>
<state>
<fullState>ALARMED,ARMED</fullState>
<id>alarmed</id>
<type>ALARM</type>
</state>
<type>CAM</type>
<additionalInfo/>
<linkedObjects/>
<micId/>
<presets/>
<speakerId/>
<telemetryId/>
</CAM>
<CAM>
<displayId>1</displayId>
<extId>6</extId>
<id>CAM:6</id>
<monitorId>1</monitorId>
<name>Camera 6</name>
<regionId/>
<state>
<fullState>ALARMED,ARMED</fullState>
<id>alarmed</id>
<type>ALARM</type>
</state>
<type>CAM</type>
<additionalInfo/>
<linkedObjects/>
<micId/>
<presets/>
<speakerId/>
<telemetryId/>
</CAM>
<MACRO>
<extId>2</extId>
<id>MACRO:2</id>
<name>Command 2</name>
<state>
<id>normal</id>
<type>NORMAL</type>
</state>
<type>MACRO</type>
</MACRO>
<CAM>
<displayId>1</displayId>
<extId>3</extId>
<id>CAM:3</id>
<monitorId>1</monitorId>
<name>Camera 3</name>
<regionId/>
<state>
<fullState>ALARMED,ARMED</fullState>
<id>alarmed</id>
<type>ALARM</type>
</state>
<type>CAM</type>
<additionalInfo/>
<linkedObjects/>
<micId/>
<presets/>
<speakerId/>
<telemetryId/>
</CAM>
<SLAVE>
<extId>A-ZHASHUEV</extId>
<id>SLAVE:A-ZHASHUEV</id>
<name>LOCALHOST</name>
<state>
<fullState>CONNECTED</fullState>
<id>connected</id>
<type>NORMAL</type>
</state>
<type>SLAVE</type>
</SLAVE>
<CAM>
<displayId>1</displayId>
<extId>4</extId>
<id>CAM:4</id>
<monitorId>1</monitorId>
<name>Camera 4</name>
<regionId/>
<state>
<fullState>ALARMED,ARMED</fullState>
<id>alarmed</id>
<type>ALARM</type>
</state>
<type>CAM</type>
<additionalInfo/>
<linkedObjects/>
<micId/>
<presets/>
<speakerId/>
<telemetryId/>
</CAM>
<CAM>
<displayId>1</displayId>
<extId>1</extId>
<id>CAM:1</id>
<monitorId>1</monitorId>
<name>Camera 1</name>
<regionId/>
<state>
<fullState>DISARMED</fullState>
<id>connected</id>
<type>NORMAL</type>
</state>
<type>CAM</type>
<additionalInfo/>
<linkedObjects/>
<micId/>
<presets/>
<speakerId/>
<telemetryId/>
</CAM>
<baseObject>
<extId>1</extId>
<id>MAP:1</id>
<name/>
<state>
<type>NORMAL</type>
</state>
<type>MAP</type>
</baseObject>
<CAM>
<displayId>1</displayId>
<extId>2</extId>
<id>CAM:2</id>
<monitorId>1</monitorId>
<name>Camera 2</name>
<regionId/>
<state>
<fullState>ARMED</fullState>
<id>armed</id>
<type>NORMAL</type>
</state>
<type>CAM</type>
<additionalInfo/>
<linkedObjects/>
<micId/>
<presets/>
<speakerId/>
<telemetryId/>
</CAM>
<baseObject>
<extId>1</extId>
<id>MAPLAYER:1</id>
<name/>
<state>
<type>NORMAL</type>
</state>
<type>MAPLAYER</type>
</baseObject>
<baseObject>
<displayId>1</displayId>
<extId>1</extId>
<id>MONITOR:1</id>
<monitorId>1</monitorId>
<name>Layer 1</name>
<state>
<id>normal</id>
<type>NORMAL</type>
</state>
<type>MONITOR</type>
</baseObject>
</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 description of the <id>, <type> and <fullState> parameters see in State of a specific object
type	Object type
Specific parameters
cams	List of cameras added to the RTSP Server separated by a semicolon
port	Port used by the 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). The parameter has non-zero value if: An external map is used for the layer background (see Configuring the external Map server), or The layer is tied to geo coordinates (see Configuring map binding to coordinate grid)
longitude	Longitude (object coordinate). The parameter has non-zero value if: An external map is used for the layer background (see Configuring the external Map server), or The layer is tied to geo coordinates (see Configuring map binding to coordinate grid)
monitorId	For camera: ID of the monitor to which the camera is added. If there are several IDs, they are separated by a semicolon
monitorName	For monitor: name of the monitor
geo_angle	For camera: viewing angle (see Configuring the camera viewing angle display on the Map)
additionalInfo	For camera: the value of the Additional info field
linkedObjects	For camera: list of connected objects, separated by comma
micId	For camera: the ID of the connected microphone
presets	For camera: preset list
speakerId	For camera: the ID of the connected speaker
telemetryId	For camera: the ID of the PTZ control panel
displayId	For interface objects: display ID. If there are several IDs, they are separated by a semicolon
displayName	For display: display name
camList	For monitor: IDs of cameras added to the monitor separated by a semicolon

Page tree

Documentation for Axxon PSIM 1.0.0-1.0.1.

General request format:

Request parameters:

Request example:

Response example:

Response parameters: