中消云物联网研究院

1.获取项目基础信息

功能：获取项目基础信息及实时状态

请求方式：GET

请求路径：{projectServerUrl}/api/1.0/project/getProjectInfo

请求参数：无需参数

返回参数：

参数	名称	类型	备注
code	返回码	string
message	提示语	string
data	数据	object
–linkmanPhone	联系人电话	string
–controlRoomPhone	控制室电话	string
–projectName	项目名称	string
–projectState	项目状态	number
–projectLocation	项目坐标	object
—-longitude	经度	number
—-latitude	纬度	number
—-coordinateSystem	坐标体系	string
–linkman	联系人	string
–projectId	项目编号	string
–projectAddress	项目地址	string
–projectType	项目类型	string

示例：

示例地址：http://xf.tandatech.com:8081/ThreePlaceREST

示例结果：

{

    "code": "000000",

    "message": "获取成功",

    "data": {

        "projectId": "4e650e1234834e30afc640750834ca66",

        "projectName": "测试项目",

        "projectType": "1",

        "projectAddress": "北京市",

        "projectLocation": {

            "longitude": 116.4154925944,

            "latitude": 39.947828852,

            "coordinateSystem": "BD09"

        },

        "controlRoomPhone": "010-12345678",

        "linkman": "联系人",

        "linkmanPhone": "13001234567",

        "projectState": 1

    }

}

2.设备总数

功能：获取所有项目设备台账总数

请求方式：GET

请求路径：{projectServerUrl}/api/1.0/all/deviceCount

请求参数：

参数	必填\选填	类型	描述
deviceType	选填	Integer	设备类型编号。不传显示所有设备总数

返回参数：

参数	名称	类型	备注
code	返回码	string
message	提示语	string
data	数据	object
–deviceType	设备类型	number
–deviceCount	设备数量	number

示例：

示例地址：http://xf.tandatech.com:8081/ThreePlaceREST/api/1.0/all/deviceCount

示例结果：

{

    "code": "000000",

    "data": [{

        "deviceCount": 134,

        "deviceType": 0

    }],

    "message": "获取成功"

}

3.当日报警统计

功能：获取所有项目当日报警统计（包括火警、真实火警、故障）

请求方式：GET

请求路径：{projectServerUrl}/api/1.0/all/dayStatistics

请求参数：无需参数

返回参数：

参数	名称	类型	备注
code	返回码	string
message	提示语	string
data	数据	object
– confirmedFireCount	已确认火警数	number
– faultCount	故障数	number	暂时返回0，下一版返回结果。
– fireCount	火警数	number
– realFireCount	真实火警数	number

示例：

示例地址：http://xf.tandatech.com:8081/ThreePlaceREST

示例结果：

{

    "code": "000000",

    "data": {

        "confirmedFireCount": 8,

        "faultCount": 134,

        "fireCount": 10,

        "realFireCount": 3

    },

    "message": "获取成功"

}

4.实时报警统计

功能：获取所有项目当前报警统计（包括火警、真实火警、故障）

请求方式：GET

请求路径：{projectServerUrl}/api/1.0/all/nowStatistics

请求参数：无需参数

返回参数：

参数	名称	类型	备注
code	返回码	string
message	提示语	string
data	数据	object
– confirmedFireCount	已确认火警数	number
– faultCount	故障数	number
– fireCount	火警数	number
– realFireCount	真实火警数	number

示例：

示例地址：http://xf.tandatech.com:8081/ThreePlaceREST/api/1.0/all/nowStatistics

示例结果：

{

    "code": "000000",

    "data": {

        "confirmedFireCount": 8,

        "faultCount": 134,

        "fireCount": 10,

        "realFireCount": 3

    },

    "message": "获取成功"

}

5.网关在线统计

功能：获取所有项目所有网关在线统计

请求方式：GET

请求路径：{projectServerUrl}/api/1.0/all/onlineStatistics

请求参数：无需参数

返回参数：

参数	名称	类型	备注
code	返回码	string
message	提示语	string
data	数据	object
–gateweyCount	网关总数量	number
–onlineCount	在线数量	number

示例：

示例地址：http://xf.tandatech.com:8081/ThreePlaceREST/api/1.0/all/onlineStatistics

示例结果：

{

    "code": "000000",

    "data": {

        "gateweyCount": 8,

        "onlineCount": 7

    },

    "message": "获取成功"

}

6.当前报警设备列表

功能：获取项目实时的报警设备列表

请求方式：GET

请求路径：{projectServerUrl}/api/1.0/project/getAlertDeviceList

请求参数：

参数	必填\选填	类型	描述
stateGroupId	选填	Integer	状态码编号（状态组），不传显示全部报警设备列表

返回参数：

参数	名称	类型	备注
code	返回码	string
message	提示语	string
data	数据	array<object>
–logId	日志编号	String
–gatewayName	网关名称	String
–deviceId	设备编号	String
–deviceControllerId	控制器编号	Integer
–deviceLoopId	设备回路号	Integer
–deviceAddrId	设备逻辑地址	Integer
–deviceChannelId	设备通道号	Integer
–deviceNumber	设备二次码	String
–deviceType	设备类型编号	Integer
–deviceState	设备详细状态	Integer
–deviceGroupState	设备状态	Integer
–happenTime	发生时间	Long	毫秒时间戳

示例：

示例地址：http://xf.tandatech.com:8081/ThreePlaceREST/api/1.0/project/getAlertDeviceList

示例结果：

{

    "code": "000000",

    "message": "获取成功",

    "data": [

        {

            " logId ": "63f454550f2342a9985ca8bc447baa5b",

            "gatewayName": "TX3252_20180412zxy001",

            "deviceId": "63f454550f2342a9985ca8bc447baa5a",

            "devicePosition ": "大厅",

            "deviceControllerId": 1,

            "deviceLoopId": 1,

            "deviceAddrId": 1,

            "deviceChannelId": 0,

            "deviceNumber": "-",

            "deviceType": 1,

            "projectState": 1,

            "deviceGroupState": 1,

            " happenTime ": 1524895526000

        }

    ]

}

7.获取设备台账(可能很多，后期导出文件提供下载)

功能：获取项目中设备台账

请求方式：GET

请求路径：{projectServerUrl}/api/1.0/project/device/getList

请求参数：无需参数

返回参数：

参数	名称	类型	备注
code	返回码	string
message	提示语	string
data	数据	array<object>
–gatewayName	网关名称	String
–deviceId	设备编号	String
–devicePosition	设备安装位置	String
–deviceControllerId	控制器编号	Integer
–deviceLoopId	设备回路号	Integer
–deviceAddrId	设备逻辑地址	Integer
–deviceChannelId	设备通道号	Integer
–deviceNumber	设备二次码	String
–deviceType	设备类型编号	Integer
–deviceState	设备详细状态	Integer
–deviceGroupState	设备状态	Integer
–createTime	创建时间	Long	毫秒时间戳

示例：

示例地址：http://xf.tandatech.com:8081/ThreePlaceREST/api/1.0/project/device/getList

示例结果：

{

    "code": "000000",

    "message": "获取成功",

    "data": [

        {

            "gatewayName": "TX3252_20180412zxy001",

            "deviceId": "63f454550f2342a9985ca8bc447baa5a",

            "devicePosition ": "大厅",

            "deviceControllerId": 1,

            "deviceLoopId": 1,

            "deviceAddrId": 1,

            "deviceChannelId": 0,

            "deviceNumber": "-",

            "deviceType": 1,

            "projectState": 1,

            "deviceGroupState": 1,

            "createTime": 1524895526000

        }

    ]

}

8.获取所有网关

功能：获取项目中的所有网关及连接情况

请求方式：GET

请求路径：{projectServerUrl}/api/1.0/project/device/gateway/getList

请求参数：无需参数

返回参数：

参数	名称	类型	备注
code	返回码	string
message	提示语	string
data	数据	array<object>
–gatewayName	网关名称	String
– gatewayId	网关编号	String
–connectState	连接状态	boolean
–lastConnectTime	上次连接时间	Long	毫秒时间戳

示例：

示例地址：http://xf.tandatech.com:8081/ThreePlaceREST/api/1.0/project/device/gateway/getList

示例结果：

{

    "code": "000000",

    "message": "获取成功",

    "data": [

        {

            "gatewayName": "TX3252_20180412zxy001",

            "connectState": true,

            "lastConnectTime": 1524895526000

         }

    ]

}

9.获取单网关信息

功能：获取单一网关的信息

请求方式：GET

请求路径：{projectServerUrl}/api/1.0/project/device/gateway/get

请求参数：

参数	必填\选填	类型	描述
gatewayName	必填	String	网关名称

返回参数：

参数	名称	类型	备注
code	返回码	string
message	提示语	string
data	数据	object
–gatewayName	网关名称	String
– gatewayId	网关编号	String
–connectState	连接状态	boolean
–lastConnectTime	上次连接时间	Long	毫秒时间戳

示例：

示例地址：http://xf.tandatech.com:8081/ThreePlaceREST/api/1.0/project/device/gateway/get

示例结果：

{

    "code": "000000",

    "message": "获取成功",

    "data": {

        "gatewayName": "TX3252_20180412zxy001",

        "connectState": true,

        "lastConnectTime": 1524895526000,

        "createTime": 1524895526000

    }

}

10.获取网关下设备列表

功能：获取指定网关下设备台账

请求方式：GET

请求路径：{projectServerUrl}/api/1.0/project/device/gateway/getDeviceList

请求参数：

参数	必填\选填	类型	描述
gatewayName	必填	String	网关名称

返回参数：

参数	名称	类型	备注
code	返回码	string
message	提示语	string
data	数据	array<object>
–gatewayName	网关名称	String
–deviceId	设备编号	String
–devicePosition	设备安装位置	String
–deviceControllerId	控制器编号	Integer
–deviceLoopId	设备回路号	Integer
–deviceAddrId	设备逻辑地址	Integer
–deviceChannelId	设备通道号	Integer
–deviceNumber	设备二次码	String
–deviceType	设备类型编号	Integer
–deviceState	设备详细状态	String	数值型状态通过“，”进行连接
–deviceGroupState	设备状态	Integer
–createTime	创建时间	Long	毫秒时间戳

示例：

示例地址：http://xf.tandatech.com:8081/ThreePlaceREST/api/1.0/project/device/gateway/getDeviceList

示例结果：

{

    "code": "000000",

    "message": "获取成功",

    "data": [

        {

            "gatewayName": "TX3252_20180412zxy001",

            "deviceId": "63f454550f2342a9985ca8bc447baa5a",

            "devicePosition ": "大厅",

            "deviceControllerId": 1,

            "deviceLoopId": 1,

            "deviceAddrId": 1,

            "deviceChannelId": 0,

            "deviceNumber": "-",

            "deviceType": 1,

            "projectState":  “1,2,3,20”,

            "deviceGroupState": 1,

            "createTime": 1524895526000

        }

    ]

}

11.获取单设备信息

功能：获取单一设备信息

请求方式：GET

请求路径：{projectServerUrl}/api/1.0/project/device/get

请求参数：

参数	必填\选填	类型	描述
deviceId	必填	String（UUID）	设备编号

返回参数：

参数	名称	类型	备注
code	返回码	string
message	提示语	string
data	数据	object
–gatewayName	网关名称	String
–deviceId	设备编号	String
–devicePosition	设备安装位置	String
–deviceControllerId	控制器编号	Integer
–deviceLoopId	设备回路号	Integer
–deviceAddrId	设备逻辑地址	Integer
–deviceChannelId	设备通道号	Integer
–deviceNumber	设备二次码	String
–deviceType	设备类型编号	Integer
–deviceState	设备详细状态	String	数值型状态通过“，”进行连接
–deviceGroupState	设备状态	Integer
–createTime	创建时间	Long	毫秒时间戳

示例：

示例地址：http://xf.tandatech.com:8081/ThreePlaceREST/api/1.0/project/device/get

示例结果：

{

“code”: “000000”,

“message”: “获取成功”,

“data”: {

        “gatewayName”: “TX3252_20180412zxy001”,

        “deviceId”: “63f454550f2342a9985ca8bc447baa5a”,

        “deviceControllerId”: 1,

        “devicePosition “: “大厅”,

        “deviceLoopId”: 1,

        “deviceAddrId”: 1,

        “deviceChannelId”: 0,

        “deviceNumber”: “-“,

        “deviceType”: 1,

        “projectState”: “1,2,3,20”

        “deviceGroupState”: 1,

        “createTime”: 1524895526000

}

}