1. 主数据API

API列表

编号 API名称 路径 版本
1.1 主数据项目列表 /v1/iot/master-data/project/page 1.0
1.2 主数据项目添加 /v1/iot/master-data/project/add 1.0
2.1 主数据楼栋列表 /v1/iot/master-data/build/list 1.0
3.1 主数据单元列表 /v1/iot/master-data/unit/list 1.0
4.1 主数据楼层列表 /v1/iot/master-data/floor/list 1.0
5.1 主数据房屋列表 /v1/iot/master-data/house/list 1.0
6.1 主数据公共区域列表 /v1/iot/master-data/pubArea/list 1.0
6.2 主数据车场区域列表 /v1/iot/master-data/park/list 1.0
7.1 空间对照表下载 /v1/iot/master-data/space/export 1.0
8.1 主数据客户分页 /v1/iot/master-data/customer/page 1.0
8.2 主数据员工分页 /v1/iot/master-data/employee/page 1.0
8.3 主数据客户详情 /v1/iot/master-data/customer/detail 1.0
8.4 主数据人脸 /v1/iot/master-data/face 1.0
9.1 边端重构二期主数据客户分页 /v1/iot/master-data/main/customer/page 1.0
9.2 边端重构二期主数据员工分页 /v1/iot/master-data/main/employee/page 1.0
9.3 边端重构二期主数据空间分页 /v1/iot/master-data/main/spce/page 1.0

API调用

1.1: 主数据项目列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/master-data/project/page

方法：POST

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

{
    "pageSize": 10,
    "pageNo": 1,
    "projectId": 1003837,
    "projectName": "xxx"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
projectName body string y 项目名称
projectId body string y 项目id
status body string y 关联组织状态 0未 1已
biz_id body int y 组织id
region body string y 省市区
regionId body int y 省市区id
deviceCount body int y 设备数量
houseCount body int y 房屋数量
buildCount body int y 房屋数量
carPortCount body int y 车位数量
structureArea body int y 建筑面积
longitude body int y 经度
latitude body int y 维度
返回结果示例
{
    "code": 200,
    "data": {
        "total": 1,
        "pages": 1,
        "records": [
            {
                "address": "佛山市顺德区北滘镇北滘新城新基路城区中学旁",
                "city": "佛山市",
                "deviceCount": 9,
                "carPortCount": 0,
                "latitude": 23.0,
                "region_id": null,
                "description": null,
                "updateTime": null,
                "structureArea": 297747.67,
                "projectArea": 104436.89,
                "province": "广东省",
                "createTime": "2020-08-27 09:51:11",
                "bizId": null,
                "houseCount": 3840,
                "buildCount": 3840,
                "id": 369,
                "projectName": "美的翰诚花园（旧）",
                "region": "顺德区",
                "projectId": 369,
                "longitude": 113.0,
                "status": 0
            }
        ],
        "pageNo": 1,
        "pageSize": 10
    },
    "message": "success"
}

API调用

1.2: 主数据项目添加

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/master-data/project/add

方法：POST

请求参数

名称 位置 类型 必填 描述
projectName body string y 项目名称
biz_id body int y 组织id

请求Body描述(非Form表单数据)

  {
    "biz_id": 1,
    "projectName": "虚拟项目B",
    "status": 1              
  }

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
    },
    "message": "success"
}

API调用

2.1: 主数据楼栋列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/master-data/build/list

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body string y 项目id

请求Body描述(非Form表单数据)

{
"projectId": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
buildName body string 是 楼栋名称
isUnit body int 是 有无单元 0无1有
返回结果示例
{
    "code": 200,
    "data": {
        "records": [
            {
                "buildName": "1栋",
                "areaId": 1,
                "createTime": "2020-08-18 10:03:12",
                "isUnit": 1,
                "description": null,
                "buildId": 1,
                "updateTime": "2020-08-18 10:03:14",
                "projectId": 1,
                "status": 1
            },
            {
                "buildName": "2栋",
                "areaId": 1,
                "createTime": "2020-08-18 10:03:30",
                "isUnit": 1,
                "description": null,
                "buildId": 2,
                "updateTime": "2020-08-18 10:03:32",
                "projectId": 1,
                "status": null
            }
        ]
    },
    "message": "success"
}

API调用

3.1: 主数据单元列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/master-data/unit/list

方法：POST

请求参数

名称 位置 类型 必填 描述
buildId body string n 楼栋id
projectId body string n 项目id

请求Body描述(非Form表单数据)

{  
"buildId":1, 
"projectId":1
 }

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
unitName body records 是 单元名称
返回结果示例
{
    "code": 200,
    "data": {
        "records": [
            {
                "areaId": 1,
                "unitName": "1单元",
                "buildId": 1,
                "createTime": "2020-08-18 10:04:02",
                "unitId": 1,
                "updateTime": "2020-08-18 10:04:04",
                "projectId": 1,
                "status": 1
            },
            {
                "areaId": 1,
                "unitName": "2单元",
                "buildId": 1,
                "createTime": "2020-08-18 10:04:07",
                "unitId": 2,
                "updateTime": "2020-08-18 10:04:06",
                "projectId": 1,
                "status": 1
            }
        ]
    },
    "message": "success"
}

API调用

4.1: 主数据楼层列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/master-data/floor/list

方法：POST

请求参数

名称 位置 类型 必填 描述
unitId body string n 单元id
buildId body string n 楼栋id
projectId body string n 项目id

请求Body描述(非Form表单数据)

{
    "unitId": 1,
    "buildId": 1,
    "projectId": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
unitName body records 是 单元名称
返回结果示例
{
    "code": 200,
    "data": {
        "records": [
            {
                "floorId": 1,
                "createTime": "2020-08-18 14:30:27",
                "description": "1栋2单元5楼",
                "unitId": 1,
                "buildId": 1,
                "updateTime": null,
                "floorName": "5楼",
                "projectId": 1,
                "status": null
            }
        ]
    },
    "message": "success"
}

API调用

5.1: 主数据房屋列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/master-data/house/list

方法：POST

请求参数

名称 位置 类型 必填 描述
floorId body int n 单元id
unitId body int n 单元id
buildId body int n 楼栋id
projectId body int n 项目id

请求Body描述(非Form表单数据)

{
    "unitId": 1,
    "buildId": 1,
    "projectId": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
unitName body records 是 单元名称
返回结果示例
{
    "code": 200,
    "data": {
        "records": [
            {
                "floorId": 1,
                "houseName": "1001房",
                "houseId": 1,
                "roomNo": "1001",
                "createTime": "2020-08-18 10:05:55",
                "description": "l栋1单元5楼1001房",
                "unitId": "1",
                "buildId": 1,
                "updateTime": "2020-08-18 10:05:57",
                "projectId": 1,
                "status": 1

            }
        ]
    },
    "message": "success"
}

6.1: 主数据公共区域列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/master-data/pubArea/list

方法：POST

请求参数

名称 位置 类型 必填 描述
subPositionType body int n 0公共区域，1公共区域位置
projectId body int n 项目id
positionId body int n 位置id

请求Body描述(非Form表单数据)

{


    "projectId":1,
    "subPositionType": 0 ,
    "positionId": 74510   
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
pubAreaName body records 是 区域名称
upPositionId body records 是 父级id
返回结果示例
{
    "code": 200,
    "data": {
        "total": 1,
        "pages": 1,
        "records": [
            {
                "positionId": 74510,
                "createTime": "2020-08-27 09:18:24",
                "subPositionType": 0,
                "updateTime": null,
                "id": 74510,
                "pubAreaName": "一、二期",
                "projectId": 369,
                "upPositionId": "1330",
                "status": 1
            }
        ],
        "pageNo": 1,
        "pageSize": 10
    },
    "message": "success"
}

6.2: 主数据车场区域列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/master-data/park/list

方法：POST

请求参数

名称 位置 类型 必填 描述
subPositionType body int n 0公共区域，1公共区域位置
projectId body int n 项目id
positionId body int n 位置id

请求Body描述(非Form表单数据)

{
    "projectId":1,
    "subPositionType": 0 ,
    "positionId": 74510   
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
pubAreaName body records 是 区域名称
upPositionId body records 是 父级id
返回结果示例
{
    "code": 200,
    "data": {
        "total": 1,
        "pages": 1,
        "records": [
            {
                "positionId": 74510,
                "createTime": "2020-08-27 09:18:24",
                "subPositionType": 0,
                "updateTime": null,
                "id": 74510,
                "pubAreaName": "一、二期",
                "projectId": 369,
                "upPositionId": "1330",
                "status": 1
            }
        ],
        "pageNo": 1,
        "pageSize": 10
    },
    "message": "success"
}

7.1: 空间对照表下载/span>

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/master-data/space/export/{projectId}

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId y 项目id

请求Body描述(非Form表单数据)

{
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
type body JSONObject y 0未知 1公共区域 2楼栋 3单元 4楼层 5车场 6车场区域 7房屋
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

8.1: 主数据客户分页/span>

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/master-data/customer/page

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId y 项目id
custName n 客户名
custPhone n 客户手机号码
certiNbr n 客户证件号码
custType n 客户类型，枚举：C1000 业主 ， C1001业主成员， C2000租户，C2001租户成员

请求Body描述(非Form表单数据)

{
    "pageNo": 1,
    "pageSize": "100",
    "projectId": 610,
    "custType": "C2000",
    "certiNbr": "441299999911111111",
    "custName": "王寺"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
sex n 0男 1女
certiNbr n 证件号码
custStatus n 客户状态 客户缴费状态：1正常客户，2异常客户
status n 记录状态 0否 1正常
返回结果示例
{
    "code": 200,
    "data": {
        "total": 3914,
        "pages": 392,
        "records": [
            {
                "createTime": "2020-08-28 16:04:05",
                "sex": null,
                "custId": 410001,
                "certiType": "1",
                "updateTime": null,
                "id": 410001,
                "certiNbr": "342700196811060425",
                "custName": "吴美蓉",
                "custPhone": "15818003888",
                "projectId": null,
                "faceUrl": null,
                "custStatus": "1",
                "status": 1
            }
         ]
  }
}

8.2: 主数据员工分页/span>

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/master-data/employee/page

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId y 项目id

请求Body描述(非Form表单数据)

{
    "pageNo": 1,
    "pageSize": "100",
    "projectId": 610
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
        "total": 3914,
        "pages": 392,
        "records": [
            {

            }
         ]
  }
}

8.3: 主数据客户详情/span>

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/master-data/customer/detail

方法：POST

请求参数

名称 位置 类型 必填 描述
custId y 客户id
projectId yy 客户id

请求Body描述(非Form表单数据)

{
    "custId": 1054,
    "projectId": 1054
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
custType n C1000业主，C1001业主成员，C2000租户，C2001租户成员
custStatus n 1000正常 10001异常
houseName n 房屋名称
返回结果示例
{
    "code": 200,
    "data": [
        {
            "id": 1,
            "custId": 410001,
            "houseId": 278146,
            "projectId": 610,
            "houseName": "12栋_1单元_2501",
            "custType": "C1001",
            "custStatus": "1000",
            "status": null,
            "createTime": "2020-09-02 16:10:29",
            "updateTime": null
        },
        {
            "id": 2,
            "custId": 410001,
            "houseId": 715032,
            "projectId": 610,
            "houseName": "1栋_1单元_101",
            "custType": "C1000",
            "custStatus": "1000",
            "status": null,
            "createTime": "2020-09-02 16:10:29",
            "updateTime": null
        },
        {
            "id": 3,
            "custId": 410001,
            "houseId": 34000512,
            "projectId": 610,
            "houseName": "3区商铺_1单元_19",
            "custType": "C1000",
            "custStatus": "1000",
            "status": null,
            "createTime": "2020-09-02 16:10:29",
            "updateTime": null
        },
        {
            "id": 4,
            "custId": 410001,
            "houseId": 34000514,
            "projectId": 610,
            "houseName": "3区商铺_1单元_20",
            "custType": "C1000",
            "custStatus": "1000",
            "status": null,
            "createTime": "2020-09-02 16:10:29",
            "updateTime": null
        }
    ],
    "message": "success"
}

8.4: 主数据人脸/span>

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/master-data/face

方法：POST

请求参数

名称 位置 类型 必填 描述
custId y 客户id
projectId yy 客户id

请求Body描述(非Form表单数据)

{
    "custId": 1054,
    "projectId": 1054
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
custType n C1000业主，C1001业主成员，C2000租户，C2001租户成员
custStatus n 1000正常 10001异常
houseName n 房屋名称
返回结果示例
{
    "code": 200,
    "data": [
        {
            "id": 1,
            "custId": 410001,
            "houseId": 278146,
            "projectId": 610,
            "houseName": "12栋_1单元_2501",
            "custType": "C1001",
            "custStatus": "1000",
            "status": null,
            "createTime": "2020-09-02 16:10:29",
            "updateTime": null
        },
        {
            "id": 2,
            "custId": 410001,
            "houseId": 715032,
            "projectId": 610,
            "houseName": "1栋_1单元_101",
            "custType": "C1000",
            "custStatus": "1000",
            "status": null,
            "createTime": "2020-09-02 16:10:29",
            "updateTime": null
        },
        {
            "id": 3,
            "custId": 410001,
            "houseId": 34000512,
            "projectId": 610,
            "houseName": "3区商铺_1单元_19",
            "custType": "C1000",
            "custStatus": "1000",
            "status": null,
            "createTime": "2020-09-02 16:10:29",
            "updateTime": null
        },
        {
            "id": 4,
            "custId": 410001,
            "houseId": 34000514,
            "projectId": 610,
            "houseName": "3区商铺_1单元_20",
            "custType": "C1000",
            "custStatus": "1000",
            "status": null,
            "createTime": "2020-09-02 16:10:29",
            "updateTime": null
        }
    ],
    "message": "success"
}

9.1: 边端重构二期主数据客户分页/span>

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/master-data/main/customer/page

方法：POST

请求参数

名称 位置 类型 必填 描述
pageNo y no
pageSize y size
name y 客户name
phone yy phone

请求Body描述(非Form表单数据)

{
    "name": "老王"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
custType n C1000业主，C1001业主成员，C2000租户，C2001租户成员
custStatus n 1000正常 10001异常
houseName n 房屋名称
返回结果示例
{
    "code": 200,
    "data": [
    ],
    "message": "success"
}

9.2: 边端重构二期主数据员工分页/span>

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/master-data/main/employee/page

方法：POST

请求参数

名称 位置 类型 必填 描述
pageNo y no
pageSize y size
name y 客户name
phone yy phone

请求Body描述(非Form表单数据)

{
    "name": "老王"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
custType n C1000业主，C1001业主成员，C2000租户，C2001租户成员
custStatus n 1000正常 10001异常
houseName n 房屋名称
返回结果示例
{
    "code": 200,
    "data": [
    ],
    "message": "success"
}

results matching ""

    No results matching ""