获取围栏列表 - 平台接口

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

Authorization

string

必需

login成功返回的token

Body 参数application/json

page

number

分页,从零开始

必需

pageSize

number

分页大小

必需

filter

object

过滤条件

可选

match

string

可选

模糊匹配 ID/名称/描述

status

number

可选

0:全部，1：启用，2：禁用

includePuId

string

可选

根据是否包含某个设备id过滤

示例

{
    "page": 0,
    "pageSize": 0,
    "filter": {
        "match": "string",
        "status": 0,
        "includePuId": "string"
    }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://192.168.88.32:9781/bvcsp/v1/platffence/list' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "page": 0,
    "pageSize": 0,
    "filter": {
        "match": "string",
        "status": 0,
        "includePuId": "string"
    }
}'

返回响应

🟢200成功

application/json

Body

code

enum<integer>

错误码

必需

枚举值:

012357468916101112131415171819

msg

string

结果描述

必需

pageInfo

object (pageInfo)

分页,从零开始

可选

page

number

分页,从零开始

必需

pageSize

number

分页大小

必需

totalCount

number

条目总数

必需

data

array[object (platffence_info) {13}]

组列表

可选

id

string

ID

必需

name

string

名称

必需

desc

string

描述

可选

creator

string

创建者ID

可选

createTime

number

创建时间

可选

beginTime

number

可选

开始时间，UTC时间戳，精确到秒，-1表示不限开始时间

endTime

number

可选

结束时间，UTC时间戳，精确到秒，-1表示不限结束时间

status

enum<number>

启用状态

可选

枚举值:

012

actionType

enum<number>

围栏行为

可选

枚举值:

012

fenceType

enum<number>

围栏类型

可选

枚举值:

12

radius

number

可选

半径，类型为“圆形”时有效，单位：厘米

coords

array [object {2}]

可选

坐标集，类型为“多边形”时有效

alarmTimes

array [object {6}]

可选

每天报警时间段，最多支持 6个

示例

{
    "code": 0,
    "msg": "string",
    "pageInfo": {
        "page": 0,
        "pageSize": 0,
        "totalCount": 0
    },
    "data": [
        {
            "id": "string",
            "name": "string",
            "desc": "string",
            "creator": "string",
            "createTime": 0,
            "beginTime": 0,
            "endTime": 0,
            "status": 0,
            "actionType": 0,
            "fenceType": 1,
            "radius": 0,
            "coords": [
                {
                    "lat": 0,
                    "lng": 0
                }
            ],
            "alarmTimes": [
                {
                    "hourBegin": 0,
                    "minuteBegin": 0,
                    "secondBegin": 0,
                    "hourEnd": 0,
                    "minuteEnd": 0,
                    "secondEnd": 0
                }
            ]
        }
    ]
}