Go to documentation repository
Documentation for Axxon One 2.0. Documentation for other versions of Axxon One is available too.
Previous page
Next page
On this page:
Get information about device
{
"method": "axxonsoft.bl.config.ConfigurationService.ListUnits",
"data": {
"unit_uids": [
"hosts/Server1/DeviceIpint.10"
]
}
}
Response example:
The units field properties contain the following information:
- device name,
- manufacturer,
- device model,
- IP address,
- port,
- firmware,
- login and password,
- geolocation data.
The child objects of the device (video channels, streams, microphones, speakers, telemetry, sensors and relays) will be indicated in child units.
Get device information by access point
You can get information by access point for archives, detection tools and video cameras.
Example of a request to get information about the archive by access point:
{
"method":"axxonsoft.bl.config.ConfigurationService.ListUnitsByAccessPoints",
"data":{
"access_points": ["hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0"]
}
}
Response example:
{
"units": [
{
"uid": "hosts/Server1/DeviceIpint.1/VideoChannel.0",
"display_id": "0",
"type": "VideoChannel",
"display_name": "",
"access_point": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
"properties": []
}
}
where
- uid—Server where the device was created;
- type—device type.
Example of a request to get information about the detection tool by access point:
{
"method":"axxonsoft.bl.config.ConfigurationService.ListUnitsByAccessPointsStream",
"data":{
"access_points": ["hosts/Server1/AVDetector.1/EventSupplier"]
}
}
Response example:
--ngpboundary
Content-Type: application/json; charset=utf-8
Content-Length: 24703
{
"units": [
{
"uid": "hosts/Server1/AVDetector.1",
"display_id": "1",
"type": "AVDetector",
"display_name": "Object tracker",
"access_point": "hosts/Server1/AVDetector.1/EventSupplier",
"properties": []
}
}
Note
- ListUnitsByAccessPointsStream can transfer more data in multiple packets, unlike ListUnitsByAccessPoints, which transfers data in a single packet.
ListUnitsByAccessPointsStream may not be suitable for Web-Clients that do not work with streaming services.
Get information about device child objects
Request example for getting information about a video channel:
{
"method":"axxonsoft.bl.config.ConfigurationService.ListUnits",
"data":{
"unit_uids":["hosts/Server1/DeviceIpint.10/VideoChannel.0"]
}
}
Response:
The properties contain the video parameters, the child ones contain streams and detection tools, if created.
Change the configuration
Adding the device
Adding a virtual video camera without settings:
where uid is the Server where the device is created.
As a result, a camera with a child microphone, an embedded archive and a sensor will be created. All child objects except the video channel will be turned off.
{
"failed": [],
"added": ["hosts/Server1/DeviceIpint.199"]
}
where 199 is the id of the created device.
Note
In some cases, the id of the created device may not coincide with the specified value of display_id in the request.
Creating the object tracker
{
"method":"axxonsoft.bl.config.ConfigurationService.ChangeConfig",
"data":{
"added": {
"uid": "hosts/Server1",
"units": {
"type": "AVDetector",
"properties": [
{
"id": "display_name",
"value_string": "Object tracker"
},
{
"id": "input",
"value_string": "Video",
"properties": [
{
"id": "camera_ref",
"value_string": "hosts/Server1/DeviceIpint.200/SourceEndpoint.video:0:0",
"properties": [
{
"id": "streaming_id",
"value_string": "hosts/Server1/DeviceIpint.200/SourceEndpoint.video:0:0"
}
]
},
{
"id": "detector",
"value_string": "SceneDescription"
}
]
}
]
}
}
}
}
Creating the motion in area detection tool under the object tracker
{
"method":"axxonsoft.bl.config.ConfigurationService.ChangeConfig",
"data":{
"added": {
"uid": "hosts/Server1",
"units": {
"type": "AppDataDetector",
"properties": [
{
"id": "display_name",
"value_string": "AppDataDetectorMoveInZone"
},
{
"id": "input",
"value_string": "TargetList",
"properties": [
{
"id": "camera_ref",
"value_string": "hosts/Server1/DeviceIpint.200/SourceEndpoint.video:0:0",
"properties": [
{
"id": "streaming_id",
"value_string": "hosts/Server1/AVDetector.1/SourceEndpoint.vmda"
}
]
},
{
"id": "detector",
"value_string": "MoveInZone"
}
]
}
]
}
}
}
}
Changing a video folder for a virtual camera
{
"method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
"data": {
"changed": [
{
"uid": "hosts/Server1/DeviceIpint.199/VideoChannel.0/Streaming.0",
"type": "Streaming",
"properties": [
{
"id": "folder",
"value_string": "D:/Video"
}
],
"opaque_params": []
}
]
}
}
Enabling/disabling the object
Each unit contains an enabled property.
Enabling the microphone:
{
"method":"axxonsoft.bl.config.ConfigurationService.ChangeConfig",
"data":{
"changed":[{
"uid": "hosts/Server1/DeviceIpint.10/Microphone.0",
"type": "Microphone",
"properties": [ {
"id": "enabled",
"value_bool": true
} ],
"units":[]
}]
}
}
Removing the device
{
"method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
"data": {
"removed": [
{
"uid": "hosts/Server1/DeviceIpint.199"
}
]
}
}
Overview
Content Tools