Get

Function

This API is used to get parameter for Event Settings(cloud dedicated) > Event Setting.

Request Message

None.

Sampel:

POST /API/Event/ChnSmart/Get HTTP/1.1
{
    "version": "1.0",
    "data": {}
}

Response Message

Table 1

ParameterRangeTypeDescription
channel_infoJSON ObjectChannel Info Object,see Table 2 for more information
agreed_to_agreementboolWhether to agree with the machine vision face algorithm protocol

Table 2

Channel Info Object

ParameterRangeTypeDescription
CH1Json ObjectChannel Object,see Table 3 for more information
IP_CH1Json Object
WIFI_CH1Json Object

Table 3

ParameterRangeTypeDescription
channel_namestringChannel name
abilitiesarraySupported intelligence,see Table 4 for more information

Table 4

ParameterRangeTypeDescription
title"Target Detection",
"Vehicle Intelligence",
"Behavior Analysis",
"Statistics Analysis",
"Normal Event"
stringIntelligent partition module
ability_infoarrayIntelligence capability information。see Table 5 for more information

Table 5

ParameterRangeTypeDescription
agreement_face_flagboolWhether to agree with the machine vision face algorithm protocol
state"On","Off"stringIntelligent switch status
ability"FaceDetection",
"HumanVehicle",
"LicensePlate",
"LineCrossing",
"Intrusion",
"Intrusion",
"ExitRegion",
"ObjectDetection",
"CrossCounting",
"CrossCounting",
"QueueLength",
"CrowdDensity",
"RareSound",
"MotionDetection",
"VideoTampering"
stringCorresponding intelligence
pagesarrayIntelligently supported capability interface。see Table 6 for more information
mutual_abilityarrayIntelligent functions are mutually exclusive。see Table 7 for more information

Table 6

ParameterRangeTypeDescription
title"Settings",
"Plan",
"Alarm Linkage"
stringIntelligent supported interface titles
page"smart_setting",
"smart_plan",
"smart_alarm_linkage"
stringIntelligent supported interface field

Table 7

ParameterRangeTypeDescription
channel"CH1"...stringMutually exclusive intelligent channel
ability"FaceDetection",
"HumanVehicle",
"LicensePlate",
"LineCrossing",
"Intrusion",
"Intrusion",
"ExitRegion",
"ObjectDetection",
"CrossCounting",
"CrossCounting",
"QueueLength",
"CrowdDensity",
"RareSound",
"MotionDetection",
"VideoTampering",
"back_light",
"exposure_mode",
"shutter_limit",
"image_mode"
"H264+",
"H265+",
"HumanDetection",
"WanderDetection",
"ParcelDetection",
"PIR"
stringCorresponds to mutually exclusive intelligent

Sample:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "result": "success",
    "data": {
        "channel_info": {
            "CH1": {
                "channel_name": "Camera",
                "abilities": [
                    {
                        "title": "Target Detection",
                        "ability_info": [
                            {
                                "agreement_face_flag": true,
                                "state": "On",
                                "ability": "FaceDetection",
                                "pages": [
                                    {
                                        "title": "Settings",
                                        "page": "smart_setting"
                                    },
                                    {
                                        "title": "Plan",
                                        "page": "smart_plan"
                                    },
                                    {
                                        "title": "Alarm Linkage",
                                        "page": "smart_alarm_linkage"
                                    }
                                ],
                                "mutual_ability": []
                            },
                            {
                                "ability": "HumanVehicle",
                                "state": "Off",
                                "pages": [
                                    {
                                        "title": "Settings",
                                        "page": "smart_setting"
                                    },
                                    {
                                        "title": "Plan",
                                        "page": "smart_plan"
                                    },
                                    {
                                        "title": "Alarm Linkage",
                                        "page": "smart_alarm_linkage"
                                    }
                                ],
                                "mutual_ability": [{
                                    "channel": "CH1",
                                    "ability": ["FaceDetection"]
                                }]
                            }
                        ]
                    },
                    {
                        "title": "Behavior Analysis",
                        "ability_info": [
                            {
                                "ability": "LineCrossing",
                                "state": "Off",
                                "pages": [
                                    {
                                        "title": "Settings",
                                        "page": "smart_setting"
                                    },
                                    {
                                        "title": "Plan",
                                        "page": "smart_plan"
                                    },
                                    {
                                        "title": "Alarm Linkage",
                                        "page": "smart_alarm_linkage"
                                    }
                                ],
                                "mutual_ability": [{
                                    "channel": "CH1",
                                    "ability": ["FaceDetection"]
                                }]
                            },
                            {
                                "ability": "Intrusion",
                                "state": "Off",
                                "pages": [
                                    {
                                        "title": "Settings",
                                        "page": "smart_setting"
                                    },
                                    {
                                        "title": "Plan",
                                        "page": "smart_plan"
                                    },
                                    {
                                        "title": "Alarm Linkage",
                                        "page": "smart_alarm_linkage"
                                    }
                                ],
                                "mutual_ability": [{
                                    "channel": "CH1",
                                    "ability": ["FaceDetection"]
                                }]
                            },
                            {
                                "ability": "EnterRegion",
                                "state": "Off",
                                "pages": [
                                    {
                                        "title": "Settings",
                                        "page": "smart_setting"
                                    },
                                    {
                                        "title": "Plan",
                                        "page": "smart_plan"
                                    },
                                    {
                                        "title": "Alarm Linkage",
                                        "page": "smart_alarm_linkage"
                                    }
                                ],
                                "mutual_ability": [{
                                    "channel": "CH1",
                                    "ability": ["FaceDetection"]
                                }]
                            },
                            {
                                "ability": "ExitRegion",
                                "state": "Off",
                                "pages": [
                                    {
                                        "title": "Settings",
                                        "page": "smart_setting"
                                    },
                                    {
                                        "title": "Plan",
                                        "page": "smart_plan"
                                    },
                                    {
                                        "title": "Alarm Linkage",
                                        "page": "smart_alarm_linkage"
                                    }
                                ],
                                "mutual_ability": [{
                                    "channel": "CH1",
                                    "ability": ["FaceDetection"]
                                }]
                            },
                            {
                                "ability": "ObjectDetection",
                                "state": "Off",
                                "pages": [
                                    {
                                        "title": "Settings",
                                        "page": "smart_setting"
                                    },
                                    {
                                        "title": "Plan",
                                        "page": "smart_plan"
                                    },
                                    {
                                        "title": "Alarm Linkage",
                                        "page": "smart_alarm_linkage"
                                    }
                                ],
                                "mutual_ability": [{
                                    "channel": "CH1",
                                    "ability": ["FaceDetection"]
                                }]
                            }
                        ]
                    },
                    {
                        "title": "Statistics Analysis",
                        "ability_info": [
                            {
                                "ability": "CrossCounting",
                                "state": "Off",
                                "pages": [
                                    {
                                        "title": "Settings",
                                        "page": "smart_setting"
                                    },
                                    {
                                        "title": "Plan",
                                        "page": "smart_plan"
                                    },
                                    {
                                        "title": "Alarm Linkage",
                                        "page": "smart_alarm_linkage"
                                    }
                                ],
                                "mutual_ability": [{
                                    "channel": "CH1",
                                    "ability": ["FaceDetection"]
                                }]
                            },
                            {
                                "ability": "HeatMap",
                                "state": "Off",
                                "pages": [{
                                    "title": "Settings",
                                    "page": "smart_setting"
                                }],
                                "mutual_ability": []
                            },
                            {
                                "ability": "QueueLength",
                                "state": "Off",
                                "pages": [
                                    {
                                        "title": "Settings",
                                        "page": "smart_setting"
                                    },
                                    {
                                        "title": "Plan",
                                        "page": "smart_plan"
                                    },
                                    {
                                        "title": "Alarm Linkage",
                                        "page": "smart_alarm_linkage"
                                    }
                                ],
                                "mutual_ability": [{
                                    "channel": "CH1",
                                    "ability": ["FaceDetection"]
                                }]
                            },
                            {
                                "ability": "CrowdDensity",
                                "state": "Off",
                                "pages": [
                                    {
                                        "title": "Settings",
                                        "page": "smart_setting"
                                    },
                                    {
                                        "title": "Plan",
                                        "page": "smart_plan"
                                    },
                                    {
                                        "title": "Alarm Linkage",
                                        "page": "smart_alarm_linkage"
                                    }
                                ],
                                "mutual_ability": [{
                                    "channel": "CH1",
                                    "ability": ["FaceDetection"]
                                }]
                            },
                            {
                                "ability": "RareSound",
                                "state": "Off",
                                "pages": [
                                    {
                                        "title": "Settings",
                                        "page": "smart_setting"
                                    },
                                    {
                                        "title": "Plan",
                                        "page": "smart_plan"
                                    },
                                    {
                                        "title": "Alarm Linkage",
                                        "page": "smart_alarm_linkage"
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "title": "Normal Event",
                        "ability_info": [{
                            "ability": "MotionDetection",
                            "state": "On",
                            "pages": [
                                {
                                    "title": "Settings",
                                    "page": "smart_setting"
                                },
                                {
                                    "title": "Plan",
                                    "page": "smart_plan"
                                },
                                {
                                    "title": "Alarm Linkage",
                                    "page": "smart_alarm_linkage"
                                }
                            ],
                            "mutual_ability": []
                        }]
                    }
                ]
            },
            "CH2": {
                "channel_name": "Camera",
                "abilities": [
                    {
                        "title": "Thermal",
                        "ability_info": [
                            {
                                "ability": "FireDetection",
                                "state": "Off",
                                "pages": [
                                    {
                                        "title": "Settings",
                                        "page": "smart_setting"
                                    },
                                    {
                                        "title": "Plan",
                                        "page": "smart_plan"
                                    },
                                    {
                                        "title": "Alarm Linkage",
                                        "page": "smart_alarm_linkage"
                                    }
                                ]
                            },
                            {
                                "ability": "TemperatureMeasurement",
                                "state": "On",
                                "pages": [
                                    {
                                        "title": "Settings",
                                        "page": "smart_setting"
                                    },
                                    {
                                        "title": "Area",
                                        "page": "smart_area"
                                    },
                                    {
                                        "title": "Plan",
                                        "page": "smart_plan"
                                    },
                                    {
                                        "title": "Alarm Linkage",
                                        "page": "smart_alarm_linkage"
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "title": "Target Detection",
                        "ability_info": [{
                            "ability": "HumanVehicle",
                            "state": "Off",
                            "pages": [
                                {
                                    "title": "Settings",
                                    "page": "smart_setting"
                                },
                                {
                                    "title": "Plan",
                                    "page": "smart_plan"
                                },
                                {
                                    "title": "Alarm Linkage",
                                    "page": "smart_alarm_linkage"
                                }
                            ],
                            "mutual_ability": [{
                                "channel": "CH1",
                                "ability": ["FaceDetection"]
                            }]
                        }]
                    },
                    {
                        "title": "Behavior Analysis",
                        "ability_info": [
                            {
                                "ability": "LineCrossing",
                                "state": "Off",
                                "pages": [
                                    {
                                        "title": "Settings",
                                        "page": "smart_setting"
                                    },
                                    {
                                        "title": "Plan",
                                        "page": "smart_plan"
                                    },
                                    {
                                        "title": "Alarm Linkage",
                                        "page": "smart_alarm_linkage"
                                    }
                                ],
                                "mutual_ability": [{
                                    "channel": "CH1",
                                    "ability": ["FaceDetection"]
                                }]
                            },
                            {
                                "ability": "Intrusion",
                                "state": "Off",
                                "pages": [
                                    {
                                        "title": "Settings",
                                        "page": "smart_setting"
                                    },
                                    {
                                        "title": "Plan",
                                        "page": "smart_plan"
                                    },
                                    {
                                        "title": "Alarm Linkage",
                                        "page": "smart_alarm_linkage"
                                    }
                                ],
                                "mutual_ability": [{
                                    "channel": "CH1",
                                    "ability": ["FaceDetection"]
                                }]
                            },
                            {
                                "ability": "EnterRegion",
                                "state": "Off",
                                "pages": [
                                    {
                                        "title": "Settings",
                                        "page": "smart_setting"
                                    },
                                    {
                                        "title": "Plan",
                                        "page": "smart_plan"
                                    },
                                    {
                                        "title": "Alarm Linkage",
                                        "page": "smart_alarm_linkage"
                                    }
                                ],
                                "mutual_ability": [{
                                    "channel": "CH1",
                                    "ability": ["FaceDetection"]
                                }]
                            },
                            {
                                "ability": "ExitRegion",
                                "state": "Off",
                                "pages": [
                                    {
                                        "title": "Settings",
                                        "page": "smart_setting"
                                    },
                                    {
                                        "title": "Plan",
                                        "page": "smart_plan"
                                    },
                                    {
                                        "title": "Alarm Linkage",
                                        "page": "smart_alarm_linkage"
                                    }
                                ],
                                "mutual_ability": [{
                                    "channel": "CH1",
                                    "ability": ["FaceDetection"]
                                }]
                            }
                        ]
                    }
                ]
            }
        },
        "agreed_to_agreement": true
    }
}

Error Code

See Response Messages Body and Common error_code for more information.