Skip to content

创建平台围栏

接口说明

为设备imei创建一个平台围栏信息(一次最多传200个imei;围栏名称不可包含特殊字符;围栏名称不可重复)

请求URL

本接口通用参数里面method的值为jimi.open.plat.fence.create

HTTP请求方式

POST

请求参数

(1)通用参数
参见: 通用参数
(2)私有参数

参数名参数类型是否必须默认值描述
access_tokenString访问令牌,表明其是一个合法第三方
imeisString设备imei号,可传多个imei,英文逗号分隔
fence_nameString围栏名称
fence_shapeStringcircle围栏形状(非行政区域围栏只能为circle——圆,行政区域围栏——polygon)
statusStringin-进围栏,out-出围栏,all-进出都有
lngdouble经度
latdouble纬度
radiusdouble围栏半径(200~999900;单位:米)
map_typeString地图类型(baidu)
scaleint缩放级别(3~19)
area_flagString是否是行政区域围栏:1-是(注:行政区域围栏area参数必填,且围栏名称会使用自动生成的名称)
stay_time_in_numint长时间不进天数,有值且值不为0则视为启用长时间不进告警配置
stay_time_out_numint长时间不出天数,有值且值不为0则视为启用长时间不出告警配置
areaString行政区域,格式为:山东省/济南市/历下区

返回值

参数类型描述
codeInt返回码:
0: 正确返回
其它: 失败。参考错误码说明
messageString如果code不为0,会有相应的错误信息提示
resultString返回的数据,成功后返回围栏序号

result参数列表:

参数类型描述
imeisString设备IMEI集合
fenceNameString电子围栏名称
fenceIdString平台围栏ID

正确返回示例:

js
{
  "code": 0,
  "message": "成功",
  "result": {
      "imeis": "456789123456801",
      "fenceName": "11111111111",
      "fenceId": "0f566e9d9e0b4a2499832cd158b0c63b",
    }
}

错误返回示例:

js
{
  "code": 12008,
  "message": "围栏超过创建个数",
  "result": null
}