Appearance
创建平台围栏V2.0
接口说明
为设备imei创建一个平台围栏信息(围栏最多可创建1000个,围栏最多关联设备数量300个,每个设备只能关联50围栏,围栏不可以包含特殊字符,围栏名称不可以重复 )
请求URL
本接口通用参数里面method的值为jimi.open.plat.fence.createPlatFence
HTTP请求方式
POST
请求参数
(1)通用参数
参见: 通用参数
(2)私有参数
| 参数名 | 参数类型 | 是否必须 | 默认值 | 描述 |
|---|---|---|---|---|
| access_token | String | 是 | 访问令牌,表明其是一个合法第三方 | |
| imei | String | 是 | 设备imei号 (多个imei用英文逗号隔开) (不传值就不要传参数) | |
| fence_name | String | 是 | 围栏名称 | |
| fence_shape | String | 是 | 围栏形状(circle/polygon) | |
| radius | Double | 否 | 围栏半径 (200~999900;单位:米) (不传值就不要传参数) | |
| description | String | 否 | 围栏描述 (不传值就不要传参数) | |
| status | String | 否 | in-进围栏 out-出围栏 all-进出都有 (不传值就不要传参数) | |
| geom | String | 无 | 坐标点集合 (多边形:纬度经度以逗号分隔,多个地点以'|'分隔,如:22.581714259546697,113.89460067944759|22.57323797629247,113.92341832019817 (需转码)圆形:22.57540001979625,113.88814802356858行政围栏不传) 注:纬度在前经度在后 | |
| map_type | String | 是 | 地图类型(baidu/google) 注:google不支持行政围栏 | |
| scale | int | 是 | 缩放级别(3~19) | |
| adm_area_code | String | 无 | 行政区域码 (创建行政围栏必传) (不传值就不要传参数) |
返回值
| 参数 | 类型 | 描述 |
|---|---|---|
| code | Int | 返回码: 0: 正确返回 其它: 失败。参考错误码说明 |
| message | String | 如果code不为0,会有相应的错误信息提示 |
| result | String | 返回的数据,成功后返回围栏id |
正确返回示例:
js
{
"code": 0,
"message": "success",
"result": "d6994043f62f4e99afebe8c1b93643b4"
}错误返回示例:
js
{
"code": 12014,
"message": "围栏最多关联设备数量300个",
"result": null
}
{
"code": 12015,
"message": "行政区域编码不存在",
"result": null
}
{
"code": 12016,
"message": "创建行政围栏暂不支持google坐标系",
"result": null
}
{
"code": 12017,
"message": "imei不存在",
"result": [
"202204121424999"
]
}
{
"code": 12018,
"message": "当前围栏名称已存在",
"result": null
}
{
"code": 12020,
"message": "创建圆形围栏需指定半径以及坐标数据!",
"result": null
}
{
"code": 12021,
"message": "创建多边形围栏需指定坐标数据,且坐标点至少不低于三个!",
"result": null
}
{
"code": 12022,
"message": "围栏形状无效",
"result": null
}