# Range

## Function

This API is used to get the parameter range of Event Settings(cloud dedicated) > Alarm Linkage.

> Note:

> The Range provides reference information for client UI input limits and API request limits. When sending Get and Set requests, the parameters must be strictly limited according to the Range, otherwise the request may be rejected by the device.

## Request Message

None.

#### Table 1

Parameter | Range | Type | Description
--- | --- | --- | ---
channel | "CH1"... | string | Corresponding intelligent channel
abilities | "FaceDetection", "HumanVehicle", "LicensePlate", "LineCrossing", "Intrusion", "Intrusion", "ExitRegion", "ObjectDetection", "CrossCounting", "CrossCounting", "QueueLength", "CrowdDensity", "RareSound", "MotionDetection", "VideoTampering" | array | Current intelligence
oper_type | "get_default_data" | string | Whether to get the default value for smart
voice_prompts_select_datasame | "CH1"…"CHx" The channels supported by the device. | string array | Channels that require synchronized voice broadcast (cloud only).

Sampel：

    POST /API/Event/AlarmLinkage/Range HTTP/1.1

    {
        "version": "1.0",
        "data": {
            "channel": "CH1",
            "ability": "FaceDetection",
            "oper_type": "get_default_data"
        }
    }

## Response Message

### Parameter Description

#### Table 2

Parameter | Range | Type | Description
--- | --- | --- | ---
channel_info |  | JSON Object | Channel Info Object,see Table 3 for more information
default_timeout |  | int | The default timeout is

#### Table 3

Channel Info Object

Parameter | Range | Type | Description
--- | --- | --- | ---
CH1 |  | Json Object | Channel Object,see Table 4 for more information
IP_CH1 |  | Json Object |
WIFI_CH1 |  | Json Object |

#### Table 4

Channel Object

Parameter | Range | Type | Description
--- | --- | --- | ---
record_enable |  | bool | Record channel switch.
post_recording | "0", "5", "10", "20", "30" | string | Video delay time.
alarm_out | "Local->1"…"Local->x" "IP_CH1->1"…"IP_CHx->x" The number of channels depends on the functionality of the device. | string array | Alarm output channel. The array member represents an alert output channel as a string. Local->1: enable, null: disable.
latch_time | "5","10","20","40" | string | Alarm output time.
io_output |  | bool | I/O alarm switch
send_email |  | bool | Switch of sending mails.
ftp_picture_upload |  | bool | FTP upload switch of channel capture.
ftp_video_upload | true false | bool | The channel video FTP upload switch is
siren |  | bool | alarm linkage switch.
deterrence |  | bool | Alarm light linkage switch.
btn_get_default_data |  | bool | Shows whether the Get Default button
mutual_exclusion | "PID", "LineCrossing", "ObjectDetection", "PVD", "FaceDetection", "CrossCounting", "MotionDetection", "CrowdDensity", "QueueLength", "LicensePlate", "RareSound", "HeatMap", "LPD_Enhance", "exposure_mode", "back_light", "Intrusion", "EnterRegion", "ExitRegion", "IT_FireDetect_str", "IT_TempMeas_str", "image_mode", "shutter_limit", "H264+", "H265+" | string | 264/265 and event intelligent mutual exclusion (cloud specific).
tracking_link |  | bool | Enable automatic tracking for the dome camera.
tracking_link_btns |  | object array | see Table 5 for more information.
ptz_linkage_disable |  | bool | disable the ptz linkage page
ptz_linkage_settings |  | object | see Table 6 for more information.

#### Table 5

Parameter | Parameter | Type | Description
--- | --- | --- | ---
title | "Tracking" | string |
page | "ai_tracking" | string |

#### Table 6

Parameter | Parameter | Type | Description
--- | --- | --- | ---
ptz_linkage_chn |  | array | ptz linkage channel.
ptz_linkage_data |  | array | ptz linkage data.
preset_dwell_time | [min:max] | int | preset dwell time minimum time 1(min),maximum time20(max).
ptz_linkage_num |  | int | number of tracks
ptz_linkage_name | "Mode_Preset", "Mode_Trace", "Mode_Pattern_Scan" | array | preset name.

> Tips:

> The response message of the Range request may not contain all the fields in the above table, and the fields not included indicate that the device does not support this parameter configuration.

Sample:

    HTTP/1.1 200 OK
    Content-Type: application/json

    {
        "result": "success",
        "data": {
            "default_timeout": 30000,
            "channel_info": {
                "type": "object",
                "items": {"CH1": {
                    "type": "object",
                    "items": {
                        "record_enable": {"type": "bool"},
                        "post_recording": {
                            "type": "string",
                            "items": [
                                "0",
                                "5",
                                "10",
                                "20",
                                "30"
                            ]
                        },
                        "alarm_out": {
                            "type": "array",
                            "min_size": 0,
                            "max_size": 1,
                            "items": {
                                "type": "string",
                                "items": ["Local->1"]
                            }
                        },
                        "latch_time": {
                            "type": "string",
                            "items": [
                                "5",
                                "10",
                                "20",
                                "30"
                            ]
                        },
                        "io_output": {"type": "bool"},
                        "send_email": {"type": "bool"},
                        "ftp_picture_upload": {"type": "bool"},
                        "ftp_video_upload": {"type": "bool"},
                        "siren": {"type": "bool"},
                        "deterrence": {"type": "bool"},
                        "btn_get_default_data": true,
                        "ptz_linkage": {"type": "bool"},
                        "ptz_linkage_disable": false,
                        "voice_prompts_select_datasame": {
                            "type": "array",
                            "min_size": 0,
                            "max_size": 8,
                            "items": [
                                {
                                    "type": "string",
                                    "items": [
                                        "CH1",
                                        "CH2",
                                        "CH3",
                                        "CH4"
                                    ]
                                },
                                {
                                    "type": "string",
                                    "items": ["CH5"]
                                },
                                {
                                    "type": "string",
                                    "items": ["CH6"]
                                }
                            ]
                        },
                        "ptz_linkage_settings": {
                            "type": "object",
                            "items": {"CH8": {
                                "type": "object",
                                "items": {
                                    "ptz_linkage_chn": {
                                        "type": "array",
                                        "min_size": 0,
                                        "max_size": 32,
                                        "items": {
                                            "type": "string",
                                            "items": ["CH8"]
                                        }
                                    },
                                    "ptz_linkage_name": {
                                        "type": "array",
                                        "min_size": 0,
                                        "max_size": 3,
                                        "items": {
                                            "type": "string",
                                            "items": [
                                                "Mode_Preset",
                                                "Mode_Trace",
                                                "Mode_Pattern_Scan"
                                            ]
                                        }
                                    },
                                    "preset_dwell_time": {
                                        "type": "int32",
                                        "min": 1,
                                        "max": 20,
                                        "default_value": 5
                                    },
                                    "ptz_linkage_num": {
                                        "type": "int32",
                                        "min": 1,
                                        "max": 255,
                                        "ranges": [
                                            [
                                                1,
                                                2,
                                                3,
                                                4,
                                                5,
                                                6,
                                                7,
                                                8,
                                                9,
                                                10,
                                                11,
                                                12,
                                                13,
                                                14,
                                                15,
                                                16,
                                                17,
                                                18,
                                                19,
                                                20,
                                                21,
                                                22,
                                                23,
                                                24,
                                                25,
                                                26,
                                                27,
                                                28,
                                                29,
                                                30,
                                                31,
                                                32,
                                                33,
                                                34,
                                                35,
                                                36,
                                                37,
                                                38,
                                                39,
                                                40,
                                                41,
                                                42,
                                                43,
                                                44,
                                                45,
                                                46,
                                                47,
                                                48,
                                                49,
                                                50,
                                                51,
                                                52,
                                                53,
                                                54,
                                                55,
                                                56,
                                                57,
                                                58,
                                                59,
                                                60,
                                                61,
                                                62,
                                                63,
                                                64,
                                                65,
                                                66,
                                                67,
                                                68,
                                                69,
                                                70,
                                                71,
                                                72,
                                                73,
                                                74,
                                                75,
                                                76,
                                                77,
                                                78,
                                                79,
                                                80,
                                                81,
                                                82,
                                                83,
                                                84,
                                                85,
                                                86,
                                                87,
                                                88,
                                                89,
                                                90,
                                                91,
                                                92,
                                                93,
                                                94,
                                                95,
                                                96,
                                                97,
                                                98,
                                                99,
                                                100,
                                                101,
                                                102,
                                                103,
                                                104,
                                                105,
                                                106,
                                                107,
                                                108,
                                                109,
                                                110,
                                                111,
                                                112,
                                                113,
                                                114,
                                                115,
                                                116,
                                                117,
                                                118,
                                                119,
                                                120,
                                                121,
                                                122,
                                                123,
                                                124,
                                                125,
                                                126,
                                                127,
                                                128,
                                                129,
                                                130,
                                                131,
                                                132,
                                                133,
                                                134,
                                                135,
                                                136,
                                                137,
                                                138,
                                                139,
                                                140,
                                                141,
                                                142,
                                                143,
                                                144,
                                                145,
                                                146,
                                                147,
                                                148,
                                                149,
                                                150,
                                                151,
                                                152,
                                                153,
                                                154,
                                                155,
                                                156,
                                                157,
                                                158,
                                                159,
                                                160,
                                                161,
                                                162,
                                                163,
                                                164,
                                                165,
                                                166,
                                                167,
                                                168,
                                                169,
                                                170,
                                                171,
                                                172,
                                                173,
                                                174,
                                                175,
                                                176,
                                                177,
                                                178,
                                                179,
                                                180,
                                                181,
                                                182,
                                                183,
                                                184,
                                                185,
                                                186,
                                                187,
                                                188,
                                                189,
                                                190,
                                                191,
                                                192,
                                                193,
                                                194,
                                                195,
                                                196,
                                                197,
                                                198,
                                                199,
                                                200,
                                                201,
                                                202,
                                                203,
                                                204,
                                                205,
                                                206,
                                                207,
                                                208,
                                                209,
                                                210,
                                                211,
                                                212,
                                                213,
                                                214,
                                                215,
                                                216,
                                                217,
                                                218,
                                                219,
                                                220,
                                                221,
                                                222,
                                                223,
                                                224,
                                                225,
                                                226,
                                                227,
                                                228,
                                                229,
                                                230,
                                                231,
                                                232,
                                                233,
                                                234,
                                                235,
                                                236,
                                                237,
                                                238,
                                                239,
                                                240,
                                                241,
                                                242,
                                                243,
                                                244,
                                                245,
                                                246,
                                                247,
                                                248,
                                                249,
                                                250,
                                                251,
                                                252,
                                                253,
                                                254,
                                                255
                                            ],
                                            [
                                                1,
                                                2,
                                                3,
                                                4
                                            ],
                                            [
                                                1,
                                                2,
                                                3,
                                                4
                                            ]
                                        ]
                                    }
                                }
                            }}
                        }
                    }
                }}
            }
        }
    }

## Error Code

See Response Messages Body and Common error_code for more information.