开发者中心
目录

后台WebAPI

# 接口说明

后台WebAPI说明

# 介绍

  • WebApi
  • 兼容windows和linux操作系统
  • 使用ASP.NET Core开发

# 错误码

# API错误码分类

API错误码分类表格
区间 分类描述
200 请求成功
1000~1999 表示用户名口令异常、Token异常或者会话过期等错误
2000~2999 表示参数为空、无效、格式异常等错误
3000~3999 表示API、设备、配置、环境不存在等错误
4000~4999 表示平台内部错误、超时、请求被禁止、不允许请求该方法等错误

# API错误码

API错误码表格
错误码 错误描述（English） 错误描述（中文）
200 Success. 请求成功
1000 The Captcha input error. 验证码输入错误
1001 Incorrect user name or password. 用户名或密码错误
1002 The original password authentication failed. 原密码认证失败
1003 Password complexity does not meet the requirements. 口令复杂度不符合要求
1004 Repeat old and new passwords. 新旧口令重复
1005 The user does not exist. 用户名不存在
1006 The user does alerady exist. 用户名已存在
1007 The user name is invalid. 用户名不合法
1008 The token is missing. 未识别到用户认证信息，请重新登录或稍后重试
1009 The token has expired. 会话过期，请重新登录
1010 Incorrect token or token resolution failed. 认证信息无法识别
1011 The token does not match the current user. 认证信息与当前用户不匹配
2000 Parameter error. 请求参数不全
2001 The request parameters must be specified. 请求参数为空
2002 Invalid length. 请求参数长度非法
2003 Invalid parameter value. 请求参数规则不匹配
3000 The API does not exist. 指定的API不存在
3001 The File does not exist. 指定的文件不存在
3002 The deviceData does not exist. 设备信息不存在
3003 The device is not online. 设备不在线
3004 The device command is muted. 设备命令已被禁用
4000 The IoTCenter Platform internal error, please contact administrator. IoTCenter平台内部错误，请联系管理员
4001 The IoTCenter service was not started or the service ran incorrectly. IoTCenter服务未启动或服务运行出错
4002 The IoTCenter Program directory not found. 未找到IoTCenter程序目录
4003 The IoTCenter program version could not be read. 无法读取到IoTCenter程序版本

# 1. 登录鉴权

  • 获取验证码
  • 登陆获取Token
  • 修改密码
  • 获取授权用户名
  • 获取程序版本号
  • 登出

# 1.1 GetVerificationCode

获取验证码

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/Auth/GetVerificationCode

请求方式：POST

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
codeType 可选 String 验证码类型，默认返回图片 0 图片 1 Base64字符串
  1. 用法示例 1
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/Auth/GetVerificationCode",
    timeout:5000,
    data:{
        "codeType":0
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容 1
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 图片验证码
  1. 返回示例 1
{
    "code": 200,
    "message": "Success",
    "data": "data:image/jpg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAAgAHgDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD2y3tIzY2zJZWsjNEpYyAA9B/snNUL4xLInlaaY5920xfutzKd2Dgb+oViOMnHUYIrVsZjHpMElxsj2x5+Vi3ygcHoOdoyR25HOM1IA6hrhwoYkYDtgRpxnn16n64GcAGkJ6GXG1rDF5ctrb79ucyRhGJPcq2BjOejfTHZs0sDtutbOyntyp3KuFk9PYjk8YB/UVxPxy1NU8EQ2yoxFzdoFk3kAhQSSADyPrxyCM8Guetfhv8ADVrGE3HjENdGNTIkWqWoBfHIUFfXpk/jXp0cBCVBV6kmrtpJRvt8xvdI9L80R7idJntIgoJeSJZVycjHzYII4746deamRtLeRYnSGVgpJdS0W7n0OFByem7pnHTAtab4fGi6faWOm3cq29tCI1WVixOAOc/dGec5U8nIxivNfGWqa14o8Y/8IdpV5JawWyB7+7+TKZwSAw24HKjGRknBxXJSoe1qOMXoru/l3HFXV2eki00gw70hAyeDLK6qTnkb+Qe/TPSpDZQRAmWCWJF7iKOQD8dpbHuR9a8f8RfDaLw7pB13RddvY7q0VWM925VXjGBhcIOg7ZbIGMV33hG9TWPDlhfsbyzmuoCzujqIzIuBhVzubJJIwD0IJz1dWlBR54SuvuBpJKxuWsVlfyQi33NE6M0nmQJG64IG0oVV1Jyeccbe2RWt9hs/+fSD/v2K8o+Merm18Nwabc3Ms/2yXO3y1iKhRndgjJAO3sM+tct4A0nwpfa7DeabcamL2ydZVivGiRGx33YxnuBnPBOMA0o0b0+d/ka+y/d87PoD7DZ/8+kH/fsVDPb2cGx2tbYRZ2uxjHy56H8+Pxz2rIbUtUgJdbSXaoGXuVbaqcZPy9SOT930GfTzHS7PUfirql/dX17c23hmGQxrBbqrM5JDZAxwSQCWCnqR3JrGKuKnT5k5N2SPZo7a0kPGnoFzwzRKM/gef0pRp0IuXcw2xhKKEj8gZVgW3HPfIK8Y4weuePF7/Sbv4TeJdKutG1G6m0u/mWOa1uD98EjqMAZAPXGRx/exXuAhAuXm3HLoqbcDAwWOc4z/ABdzjjgDnJZWuh1aXJZp3TKd3aWf9nzyR28H+qZlZUHpwQaKmvpAbS7jw25YCxO045B6HoTx07ceoopa9TEqRG4aztTHEkqJEmFDjO7CkEg46c8Z5yOnUPEiJL5l6z8bcCSI7Y2z1yMr3GD1HOSe0VnfCOzhXfafcX711g9AOm3j6VP/AGkf79j/AOBf/wBjS1A8o+ISReLvih4Z8NMyXFqgM05iYj5WYll4PB2RjnPftXZN8LvAls1vM2jQxGAgRsbmVeclhn5/mOSeueOOgFaLWukT6iuq3NhZ/bioxLHLEZUOMcvww44wGIq5a3VhZxokUXKoE8x542dgO7MXyx9STk16E8fUVOFKk3FRXR7vqxNXepbW7F3aDFtdAyp8yD5WXI5+cHbkeqsfUHvXjcGszeAvitqt34ih+yW+sRh0uFRp0ToSARgkA5U4GeBxg17D/a8H93/yNF/8XVS9k0nVoBFqOnW11GrZEdz5EgB9cFiKww9ZU21JXTVmUmtU+p4bqPjLWPGUs3hCyks7mS/vMJfxZt0kizuCspVTkdycnjABJyfadL0iDQPDtja20FndQW8Uai4DiJmXjLg8gnksDkZPp1rI1nwl4T1S0giTRLO3aCZZk+zvFADyu4HYw6hcflWtG9kAgmvHidcn5Wd3XPXDg7efp+vNXiK9OcFGmrLr69/6RU5J2scT4116PRfHWkrq1pEmjyKZINRngkkngcD5gmWJA3BCflB5+lZGh30fif4ttrmmhfstmm0XrQMvnvtZQNo/vbx2zhR07+lammi6jbLb3EjXaHGI7lPNjDAEhmVwe4xwO/TGas2SaQlgLC1uFtrUKSLdYY4kXJycAIADk54781nGrFRslrt95ftI8tktWrEWtXOrT6ZJYiwSI3UTxNctKNkWR1I7A8gc5BI4PNeT+F/F1p4a8Eat4U1UR6drEEj+WL21aWJ2ODhgqnkY7jHQ89K9bun+zxrINaiESNltqSSyMM/LgCQ/j8pB54HbPuNG03UxDJepps0hiJAu7W3fyTx8hOWxyT93I4J785LS/mOnUio8lSN43v8A15HnGlahq/xe8V6ZJcQW9rZaPGs00YfKySZ6gdcMVAxzgA85PPtgvc3UMYw3nAgRjaHj2Z3s2W5UHYvyg4LDscjjrfw9pi66dRWz0eC5WIwBQ2Y3jAKKTgBc7DjbwPUHCkdO0sZlZnudPnRtrFGbYAynKt1bnOOfYelO6toFapGcly6RRevv+Qfc/wDXJv5Gis+XVLO+025TzgsgRwVBZckFhwSBuBK9uCCDyGBJUGB//9k="
}
  1. 用法示例 2
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/Auth/GetVerificationCode",
    timeout:5000,
    data:{
        "codeType":1
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容 2
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String Base64加密验证码
  1. 返回示例 2
{
    "code": 200,
    "message": "Success",
    "data": "SiBEIEggNyA="
}

# 1.2 Login

获取设备事件（模拟量状态量设置量事件）——支持时间段查询、分页、排序

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/Auth/Login

请求方式：POST

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
userName 必须 String 用户名
password 必须 String 密码
verificationCode 必须 String 验证码
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/Auth/Login",
    timeout:5000,
    data:{
        userName:"admin",
        password:"1q2w3e4r5tT!@"，
        verificationCode:"1234"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
loginUserName String 登录用户名
data.accessToken String IoTCenter平台Token
data.tokenExpired String IoTCenter平台Token有效时间
data.refreshToken String IoTCenter平台刷新Token
data.refreshTokenExpired String IoTCenter平台刷新Token有效时间
  1. 返回示例
{
    "code": 200,
    "message": "Success",
    "data": {
        "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6ImFkbWluIiwibm9uY2UiOiJmZjI2OWY2MS03ZmE2LTRiZmYtYjk0Ni00MTdjMDQ2MjlkN2EiLCJqdGkiOiJmY2E4NDcwYS04ODI5LTRlYzMtOTVhYS0zZTY0NjhlYTA1MjYiLCJuYmYiOjE1NzgzMTQ0OTIsImV4cCI6MTU3ODMxNDU1MiwiaXNzIjoiZ2Fud2Vpc29mdC5uZXQiLCJhdWQiOiJnYW53ZWlzb2Z0Lm5ldCJ9.0WRfAmo20dk4Or1kH1Q4IsUBy6agQjoQiHgmdGWaDqQ",
        "tokenExpired": 3600,
        "refreshToken": "e440a29aefd94aa7a3a433df536e7442",
        "refreshTokenExpired": 86400
    }
}

# 1.3 UpdUserInfoData

更新用户名密码

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/Auth/UpdUserInfoData

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
userName 必须 String 用户名
oldPassWord 必须 String 旧密码
newPassWord 必须 String 新密码
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/Auth/Login",
    timeout:5000,
    data:{
        userName:"admin",
        oldPassWord:"1q2w3e4r5tT!@"，
        newPassWord:"1q2w3e4r5tT!@1"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 结果 1成功 0失败
  1. 返回示例
{
    "code": 200,
    "message": "Success",
    "data": 1
}

# 1.4 GetUserName2SF

获取授权用户名

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/Auth/GetUserName2SF

请求方式：GET

  1. 请求包header

无

  1. 请求参数

无

  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/Auth/GetUserName2SF",
    timeout:5000,
    data:{},
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 授权用户名
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": "AlarmCenter.DataCenter.Msg10"
}

# 1.5 GetVersionInfo

获取程序版本号

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/Auth/GetVersionInfo

请求方式：GET

  1. 请求包header

无

  1. 请求参数

无

  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/Auth/GetVersionInfo",
    timeout:5000,
    data:{},
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 程序版本号
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": "9.0.0.0"
}

# 1.6 LoginOut

获取程序版本号

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/Auth/LoginOut

请求方式：GET

  1. 请求包header

无

  1. 请求参数

无

  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/Auth/LoginOut",
    timeout:5000,
    data:{},
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 程序版本号
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": true
}

# 设备列表

  • 获取所有设备的列表结构（树形图）——支持分页、搜索
  • 获取所有设备状态——支持分页
  • 获取当前设备的所有测点状态——支持分页、搜索
  • 获取当前设备模拟量测点的状态——支持分页、搜索
  • 获取当前设备状态量测点的状态——支持分页、搜索
  • 获取当前设备设置量测点的状态——支持分页、搜索
  • 获取当前设备单个模拟量测点的状态
  • 获取当前设备单个状态量测点的状态
  • 获取当前设备单个设置量测点的状态
  • 指令下发1（设备号、设置号、设置值、操作用户）
  • 指令下发2（设备号、操作命令、操作参数、设置值、操作用户）
  • 获取模拟量历史曲线
  • 新增设备分组——下版本实现
  • 编辑设备分组——下版本实现
  • 删除设备分组——下版本实现
  • 移动设备至指定分组——下版本实现
  • 设备搜索（后端实现）
  • 模拟量搜索（后端实现）
  • 状态量搜索（后端实现）
  • 设置量搜索（后端实现）

# 2.1 GetEquipListByPage

获取所有设备的列表结构（树形图）——支持分页、搜索

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/EquipList/GetEquipListByPage

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
pageNo 必须 Long 当前页
pageSize 必须 Long 每页显示数量
eventName 可选 String 待搜索的设备名称
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/EquipList/GetEquipListByPage",
    timeout:5000,
    data:{
      pageNo: 0,
      pageSize: 10
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 各类型事件数量，逗号分隔
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "totalCount": 100,
    "totalPage": 10,
    "list": "[{"id":1,"name":"综合管理平台","parentID":0,"equipID":null},{"id":2,"name":"继电器控制模块","parentID":1,"equipID":2}]"
  }
}

# 2.2 GetEquipListStateByPage

获取所有设备状态——支持分页

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/EquipList/GetEquipListStateByPage

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
pageNo 必须 Long 当前页
pageSize 必须 Long 每页显示数量
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/EquipList/GetEquipListStateByPage",
    timeout:5000,
    data:{
      pageNo: 0,
      pageSize: 10
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 各类型事件数量，逗号分隔
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "totalCount": 100,
    "totalPage": 10,
    "list": "{"2":2,"3":1,"5":0,"8":1,"101":1,"102":1,"103":1,"104":1,"105":1,"106":1,"107":1,"108":1,"109":1,"110":1,"111":1,"112":1,"113":1,"114":1,"115":1,"116":1,"117":1,"118":1,"119":1}"
  }
}

# 2.3 GetEquipItemStateByPage

获取当前设备的所有测点状态——支持分页

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/EquipList/GetEquipItemStateByPage

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
pageNo 必须 Long 当前页
pageSize 必须 Long 每页显示数量
equipNo 必须 Long 设备号
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/EquipList/GetEquipItemStateByPage",
    timeout:5000,
    data:{
      pageNo: 0,
      pageSize: 10,
      equipNo: 2
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 各类型事件数量，逗号分隔
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "totalCount": 100,
    "totalPage": 10,
    "list": {
      "equipState": 1,
      "ycItemDict": "{"1":20.0,"2":50.0}",
      "yxItemDict": "{}",
      "setItemDict": ""
    }
  }
}

# 2.4 GetYcpItemStateByPage

获取当前设备模拟量测点的状态——支持分页

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/EquipList/GetYcpItemStateByPage

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
pageNo 必须 Long 当前页
pageSize 必须 Long 每页显示数量
equipNo 必须 Long 设备号
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/EquipList/GetYcpItemStateByPage",
    timeout:5000,
    data:{
      pageNo: 0,
      pageSize: 10,
      equipNo: 3
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 各类型事件数量，逗号分隔
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "totalCount": 100,
    "totalPage": 10,
    "list": {
      "equipState": 1,
      "ycItemDict": "{"1":17.0,"2":44.0}"
    }
  }
}

# 2.5 GetYxpItemStateByPage

获取当前设备状态量测点的状态——支持分页

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/EquipList/GetYxpItemStateByPage

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
pageNo 必须 Long 当前页
pageSize 必须 Long 每页显示数量
equipNo 必须 Long 设备号
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/EquipList/GetYxpItemStateByPage",
    timeout:5000,
    data:{
      pageNo: 0,
      pageSize: 10,
      equipNo: 2
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 各类型事件数量，逗号分隔
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "totalCount": 100,
    "totalPage": 10,
    "list": {
      "equipState": 2,
      "yxItemDict": "{"1":"报警","2":"报警","3":"报警","4":"报警","5":"报警","6":"报警"}"
    }
  }
}

# 2.6 GetSetItemStateByPage

获取当前设备设置量测点的状态——支持分页

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/EquipList/GetSetItemStateByPage

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
pageNo 必须 Long 当前页
pageSize 必须 Long 每页显示数量
equipNo 必须 Long 设备号
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/EquipList/GetSetItemStateByPage",
    timeout:5000,
    data:{
      pageNo: 0,
      pageSize: 10,
      equipNo: 2
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 各类型事件数量，逗号分隔
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "totalCount": 100,
    "totalPage": 10,
    "list": {
      "equipState": 2,
      "setItemDict": "[{继电器1 断开}][{05}][{0000}][{0000}];[{继电器1 闭合}][{05}][{0000}][{65280}];[{继电器2 断开}][{05}][{0001}][{0000}];[{继电器2 闭合}][{05}][{0001}][{65280}];[{继电器3 断开}][{05}][{0002}][{0000}];[{继电器3 闭合}][{05}][{0002}][{65280}];[{继电器4 断开}][{05}][{0003}][{0000}];[{继电器4 闭合}][{05}][{0003}][{65280}]"
    }
  }
}

# 2.7 GetEquipYcpState

获取当前设备单个模拟量测点的状态

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/EquipList/GetEquipYcpState

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
equipNo 必须 Long 设备号
ycpNo 必须 Long 模拟量号
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/EquipList/GetEquipYcpState",
    timeout:5000,
    data:{
      equipNo: 3,
      ycpNo: 1
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 各类型事件数量，逗号分隔
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 28
}

# 2.8 GetEquipYxpState

获取当前设备单个状态量测点的状态

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/EquipList/GetEquipYxpState

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
equipNo 必须 Long 设备号
yxpNo 必须 Long 状态量号
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/EquipList/GetEquipYxpState",
    timeout:5000,
    data:{
      equipNo: 2,
      yxpNo: 1
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 各类型事件数量，逗号分隔
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 0
}

# 2.9 SetCommandBySetNo

指令下发1（设备号、设置号、设置值、操作用户）

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/EquipList/SetCommandBySetNo

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
equipNo 必须 Long 设备号
setNo 必须 Long 设置号
value 可选 String 设置值
userName 必须 String 操作人
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/EquipList/SetCommandBySetNo",
    timeout:5000,
    data:{
      equipNo: 2,
      setNo: 1，
      userName: "admin"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 各类型事件数量，逗号分隔
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": true
}

# 2.10 SetCommandByParameter

指令下发2（设备号、操作命令、操作参数、设置值、操作用户）

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/EquipList/SetCommandByParameter

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
equipNo 必须 Long 设备号
mainInstr 必须 String 操作命令
minoInstr 必须 String 操作参数
value 可选 String 设置值
userName 必须 String 操作人
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/EquipList/SetCommandByParameter",
    timeout:5000,
    data:{
      equipNo: 2,
      mainInstr: "xxx"，
      minoInstr: "xxx"，
      userName: "admin"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 各类型事件数量，逗号分隔
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": true
}

# 2.11 GetYcpHistroyByTimeAsync

获取模拟量历史曲线

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/EquipList/GetYcpHistroyByTimeAsync

请求方式：POST

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
beginTime 必须 String 开始时间
endTime 必须 String 结束时间
staNo 必须 String 站点号
equipNo 必须 String 设备号
ycpNo 必须 String 遥测号
type 可选 String 类型，默认为C
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/EquipList/GetYcpHistroyByTimeAsync",
    timeout:5000,
    data:{
      beginTime: "2020-01-01 10:00:00",
      endTime: "2020-01-02 10:00:00",
      staNo: 1，
      equipNo: 2，
      ycpNo: 1,
      type: "C"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 各类型事件数量，逗号分隔
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": []
}

# 3. 实时快照

  • 获取实时快照事件的类型配置信息
  • 获取当前实时报警事件的总数
  • 获取当前各类报警的实时事件和数量——支持分页、排序、按类型查询
  • 确认当前报警事件

# 3.1 GetRealTimeEventTypeConfig

获取实时快照事件的类型配置信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/RealTime/GetRealTimeEventTypeConfig

请求方式：GET

  1. 请求包header

无

  1. 请求参数

无

  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/RealTime/GetRealTimeEventTypeConfig",
    timeout:5000,
    data:{},
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 程序版本号
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": "[{"id":1,"snapshotName":"故障","snapshotLevelMin":10003,"snapshotLevelMax":10004,"maxCount":-1,"isShow":1,"iconRes":"Errors.png"},{"id":2,"snapshotName":"警告","snapshotLevelMin":2,"snapshotLevelMax":9,"maxCount":-1,"isShow":1,"iconRes":"Warnings.png"},{"id":3,"snapshotName":"信息","snapshotLevelMin":0,"snapshotLevelMax":1,"maxCount":-1,"isShow":1,"iconRes":"Informations.png"},{"id":4,"snapshotName":"设置","snapshotLevelMin":10001,"snapshotLevelMax":10001,"maxCount":-1,"isShow":1,"iconRes":"Settings.png"},{"id":5,"snapshotName":"资产","snapshotLevelMin":10002,"snapshotLevelMax":10002,"maxCount":-1,"isShow":1,"iconRes":"Assets.png"}]"
}

# 3.2 GetRealTimeEventCount

获取当前实时报警事件的总数

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/RealTime/GetRealTimeEventCount

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
eventType 必须 String 快照类型分类，多个分类请用';'符号隔开，多个值请用逗号隔开
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/RealTime/GetRealTimeEventCount",
    timeout:5000,
    data:{
        eventType:"10003,10004;2,3,4,5,6,7,8,9;0,1;10001;10002"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 各类型事件数量，逗号分隔
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": "0,0,0,0,0"
}

# 3.3 GetRealTimeEventByType

获取当前各类报警的实时事件和数量——支持分页、排序、类型查询、搜索

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/RealTime/GetRealTimeEventByType

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
pageNo 必须 Long 当前页
pageSize 必须 Long 每页显示数量
eventType 必须 String 快照类型分类，多个分类请用';'符号隔开，多个值请用逗号隔开
eventName 可选 String 快照事件名称
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/RealTime/GetRealTimeEventByType",
    timeout:5000,
    data:{
      pageNo: 0,
      pageSize: 100,
      eventType: "10003,10004;2,3,4,5,6,7,8,9;0,1;10001;10002"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 各类型事件数量，逗号分隔
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "pageNo": 0,
    "pageSize": 10,
    "totalCount": 100,
    "totalPage": 10,
    "list": []
  }
}

# 4. 系统配置

  • 获取所有设备配置信息——支持分页
  • 获取单个设备配置信息
  • 获取设备配置列名信息
  • 新增设备配置信息——下版本实现
  • 修改设备配置信息
  • 删除设备配置信息——下版本实现
  • 获取单个设备所有模拟量配置信息——支持分页
  • 获取单个设备单个模拟量配置信息
  • 获取模拟量配置列名信息
  • 增加模拟量配置信息——下版本实现
  • 修改模拟量配置信息
  • 删除模拟量配置信息——下版本实现
  • 获取单个设备所有状态量配置信息——支持分页
  • 获取单个设备单个状态量配置信息
  • 获取状态量配置列名信息
  • 增加状态量配置信息——下版本实现
  • 修改状态量配置信息
  • 删除状态量配置信息——下版本实现
  • 获取单个设备所有设置量配置信息——支持分页
  • 获取单个设备单个设置量配置信息
  • 获取设置量配置列名信息
  • 增加设置量配置信息——下版本实现
  • 修改设置量配置信息
  • 删除设置量配置信息——下版本实现
  • 获取资产编号下拉列表
  • 获取预案号下拉列表
  • 获取关联视频下拉列表

# 4.1 GetAllEquipDataList

获取所有设备配置信息——支持分页、搜索

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/SystemConfig/GetAllEquipDataList

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
pageNo 必须 Long 当前页
pageSize 必须 Long 每页显示数量
equipName 可选 String 设备名称
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/SystemConfig/GetAllEquipDataList",
    timeout:5000,
    data:{
      pageNo: 0,
      pageSize: 100
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备列表集合
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "pageNo": 0,
    "pageSize": 10,
    "totalCount": 100,
    "totalPage": 10,
    "list": "[{"sta_n":1,"equip_no":2,"equip_nm":"继电器控制模块","equip_detail":"","acc_cyc":1,"related_pic":"","proc_advice":"1.掉电。2.通讯线故障。3.电源连接线故障。4.监控机串口故障。如故障为第一种，来电之后自动恢复，如为后几种故障，请与我公司联系。","out_of_contact":"通讯故障","contacted":"通讯恢复正常","event_wav":"EQ61_0.wav/EQ61_1.wav","communication_drv":"GWJBUS.STD.dll","local_addr":"TC/192.168.0.254:10003","equip_addr":"5","communication_param":"9600/8/1/no","communication_time_param":"100/100/100","raw_equip_no":1006,"tabname":"Ext_7053D","alarm_scheme":15,"attrib":0,"sta_IP":"","alarmRiseCycle":0,"reserve1":"","reserve2":"","reserve3":"","related_video":"","ziChanID":"","planNo":"","safeTime":""}]"
  }
}

# 4.2 GetEquipDataByEquipNo

获取单个设备配置信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/SystemConfig/GetEquipDataByEquipNo

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
staNo 必须 Long 站点号
equipNo 必须 Long 设备号
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/SystemConfig/GetEquipDataByEquipNo",
    timeout:5000,
    data:{
      staNo: 1,
      equipNo: 2
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": "[{"sta_n":1,"equip_no":2,"equip_nm":"继电器控制模块","equip_detail":"","acc_cyc":1,"related_pic":"","proc_advice":"1.掉电。2.通讯线故障。3.电源连接线故障。4.监控机串口故障。如故障为第一种，来电之后自动恢复，如为后几种故障，请与我公司联系。","out_of_contact":"通讯故障","contacted":"通讯恢复正常","event_wav":"EQ61_0.wav/EQ61_1.wav","communication_drv":"GWJBUS.STD.dll","local_addr":"TC/192.168.0.254:10003","equip_addr":"5","communication_param":"9600/8/1/no","communication_time_param":"100/100/100","raw_equip_no":1006,"tabname":"Ext_7053D","alarm_scheme":15,"attrib":0,"sta_IP":"","alarmRiseCycle":0,"reserve1":"","reserve2":"","reserve3":"","related_video":"","ziChanID":"","planNo":"","safeTime":""}]"
}

# 4.3 GetEquipColumnData

获取设备配置列名信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/SystemConfig/GetEquipColumnData

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数

无

  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/SystemConfig/GetEquipColumnData",
    timeout:5000,
    data:{
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备字段详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": [
    [
      "equip_no",
      "equip_nm",
      "related_pic",
      "related_video",
      "ZiChanID",
      "PlanNo",
      "equip_detail",
      "acc_cyc",
      "proc_advice",
      "out_of_contact",
      "contacted",
      "event_wav",
      "communication_drv",
      "local_addr",
      "equip_addr",
      "communication_param",
      "communication_time_param",
      "AlarmRiseCycle",
      "raw_equip_no",
      "tabname",
      "attrib",
      "SafeTime",
      "alarm_scheme"
    ],
    [
      "设备号",
      "设备名",
      "关联界面",
      "关联视频",
      "资产编号",
      "预案号",
      "设备属性",
      "通讯刷新周期",
      "通故障处理意见",
      "故障提示",
      "故障恢复提示",
      "报警声音文件",
      "驱动文件",
      "通讯端口",
      "设备地址",
      "通讯参数",
      "通讯时间参数",
      "报警升级周期（分钟）",
      "模板设备号",
      "附表名称",
      "属性",
      "安全时段",
      "报警方式"
    ]
  ]
}

# 4.4 AddEquipData

新增设备配置信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/SystemConfig/AddEquipData

请求方式：POST

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
staNo 必须 Long 站点号
equipNo 必须 Long 设备号
equipNm 必须 String 设备名称
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/SystemConfig/AddEquipData",
    timeout:5000,
    data:{
      staNo: 1,
      equipNo: 999,
      equipNm: "string",
      equipDetail: "string",
      accCyc: 0,
      relatedPic: "string",
      procAdvice: "string",
      outOfContact: "string",
      contacted: "string",
      eventWav: "string",
      communicationDrv: "string",
      localAddr: "string",
      equipAddr: "string",
      communicationParam: "string",
      communicationTimeParam: "string",
      rawEquipNo: 0,
      tabname: "string",
      alarmScheme: 0,
      attrib: 0,
      staIp: "string",
      alarmRiseCycle: 0,
      reserve1: "string",
      reserve2: "string",
      reserve3: "string",
      relatedVideo: "string",
      ziChanId: "string",
      planNo: "string",
      safeTime: "string"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备新增结果 1成功 0失败
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 4.5 EditEquipData

修改设备配置信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/SystemConfig/EditEquipData

请求方式：POST

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
staNo 必须 Long 站点号
equipNo 必须 Long 设备号
equipNm 必须 String 设备名称
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/SystemConfig/EditEquipData",
    timeout:5000,
    data:{
      staNo: 1,
      equipNo: 999,
      equipNm: "string",
      equipDetail: "string",
      accCyc: 0,
      relatedPic: "string",
      procAdvice: "string",
      outOfContact: "string",
      contacted: "string",
      eventWav: "string",
      communicationDrv: "string",
      localAddr: "string",
      equipAddr: "string",
      communicationParam: "string",
      communicationTimeParam: "string",
      rawEquipNo: 0,
      tabname: "string",
      alarmScheme: 0,
      attrib: 0,
      staIp: "string",
      alarmRiseCycle: 0,
      reserve1: "string",
      reserve2: "string",
      reserve3: "string",
      relatedVideo: "string",
      ziChanId: "string",
      planNo: "string",
      safeTime: "string"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备新增结果 1成功 0失败
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 4.6 DelEquipData

删除设备配置信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/SystemConfig/DelEquipData

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
staNo 必须 Long 站点号
equipNo 必须 Long 设备号
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/SystemConfig/DelEquipData",
    timeout:5000,
    data:{
      staNo: 1,
      equipNo: 999
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备列表集合，逗号分隔
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 4.7 GetAllEquipDataList

获取模拟量配置信息——支持分页、搜索

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/SystemConfig/GetYcpDataList

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
pageNo 必须 Long 当前页
pageSize 必须 Long 每页显示数量
equipNo 必须 Long 设备号
ycName 可选 String 模拟量名称
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/SystemConfig/GetYcpDataList",
    timeout:5000,
    data:{
      pageNo: 0,
      pageSize: 100,
      equipNo: 2
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备模拟量列表集合
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "totalCount": 100,
    "totalPage": 10,
    "list": "[{"sta_n":1,"equip_no":3,"yc_no":1,"yc_nm":"温度","mapping":1,"yc_min":0.0,"yc_max":1000.0,"physic_min":0.0,"physic_max":100.0,"val_min":15.0,"restore_min":18.0,"restore_max":28.0,"val_max":30.0,"val_trait":0,"main_instruction":"04","minor_instruction":"0000","safe_bgn":"2001-01-01 00:00:00","safe_end":"2001-01-01 00:00:00","alarm_acceptable_time":0,"restore_acceptable_time":0,"alarm_repeat_time":0,"proc_advice":"","lvl_level":3,"outmin_evt":"过低。","outmax_evt":"过高。","wave_file":"YC1_1_0.wav/YC1_1_1.wav","related_pic":"","alarm_scheme":15,"curve_rcd":1,"curve_limit":0.0,"alarm_shield":"","unit":"℃","alarmRiseCycle":0,"reserve1":"","reserve2":"","reserve3":"","related_video":"","ziChanID":"","planNo":"","safeTime":""},{"sta_n":1,"equip_no":3,"yc_no":2,"yc_nm":"湿度","mapping":1,"yc_min":0.0,"yc_max":1000.0,"physic_min":0.0,"physic_max":100.0,"val_min":20.0,"restore_min":30.0,"restore_max":80.0,"val_max":90.0,"val_trait":0,"main_instruction":"04","minor_instruction":"0001","safe_bgn":"2001-01-01 00:00:00","safe_end":"2001-01-01 00:00:00","alarm_acceptable_time":0,"restore_acceptable_time":0,"alarm_repeat_time":0,"proc_advice":"","lvl_level":0,"outmin_evt":"过低。","outmax_evt":"过高。","wave_file":"YC2_2_0.wav/YC2_2_1.wav","related_pic":"","alarm_scheme":15,"curve_rcd":1,"curve_limit":0.0,"alarm_shield":"","unit":"％","alarmRiseCycle":0,"reserve1":"","reserve2":"","reserve3":"","related_video":"","ziChanID":"","planNo":"","safeTime":""}]"
  }
}

# 4.8 GetYcpDataByEquipYcNo

获取单个测点的模拟量配置信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/SystemConfig/GetYcpDataByEquipYcNo

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
staNo 必须 Long 站点号
equipNo 必须 Long 设备号
ycNo 必须 Long 遥测号
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/SystemConfig/GetYcpDataByEquipYcNo",
    timeout:5000,
    data:{
      staNo: 1,
      equipNo: 3,
      ycNo:1
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": "[{"sta_n":1,"equip_no":3,"yc_no":1,"yc_nm":"温度","mapping":1,"yc_min":0.0,"yc_max":1000.0,"physic_min":0.0,"physic_max":100.0,"val_min":15.0,"restore_min":18.0,"restore_max":28.0,"val_max":30.0,"val_trait":0,"main_instruction":"04","minor_instruction":"0000","safe_bgn":"2001-01-01 00:00:00","safe_end":"2001-01-01 00:00:00","alarm_acceptable_time":0,"restore_acceptable_time":0,"alarm_repeat_time":0,"proc_advice":"","lvl_level":3,"outmin_evt":"过低。","outmax_evt":"过高。","wave_file":"YC1_1_0.wav/YC1_1_1.wav","related_pic":"","alarm_scheme":15,"curve_rcd":1,"curve_limit":0.0,"alarm_shield":"","unit":"℃","alarmRiseCycle":0,"reserve1":"","reserve2":"","reserve3":"","related_video":"","ziChanID":"","planNo":"","safeTime":""}]"
}

# 4.9 GetYcpColumnData

获取模拟量配置列名信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/SystemConfig/GetYcpColumnData

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数

无

  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/SystemConfig/GetYcpColumnData",
    timeout:5000,
    data:{
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备字段详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": [
    [
      "equip_no",
      "yc_no",
      "yc_nm",
      "val_min",
      "restore_min",
      "restore_max",
      "val_max",
      "unit",
      "related_pic",
      "related_video",
      "ZiChanID",
      "PlanNo",
      "curve_rcd",
      "mapping",
      "curve_limit",
      "yc_min",
      "yc_max",
      "physic_min",
      "physic_max",
      "val_trait",
      "main_instruction",
      "minor_instruction",
      "alarm_acceptable_time",
      "restore_acceptable_time",
      "alarm_repeat_time",
      "proc_advice",
      "lvl_level",
      "AlarmRiseCycle",
      "outmin_evt",
      "outmax_evt",
      "wave_file",
      "alarm_shield",
      "SafeTime",
      "alarm_scheme"
    ],
    [
      "设备号",
      "模拟量编号",
      "模拟量名称",
      "下限值",
      "回复下限值",
      "回复上限值",
      "上限值",
      "单位",
      "关联页面",
      "关联视频",
      "资产编号",
      "预案号",
      "曲线记录",
      "比例变换",
      "曲线记录阈值",
      "实测最小值",
      "实测最大值",
      "最小值",
      "最大值",
      "属性值",
      "操作命令",
      "操作参数",
      "越线滞纳时间（秒）",
      "恢复滞纳时间（秒）",
      "重复报警时间（分钟）",
      "处理意见",
      "报警级别",
      "报警升级周期",
      "越下限事件",
      "越上限事件",
      "声音文件",
      "报警屏蔽",
      "安全时段",
      "报警方式"
    ]
  ]
}

# 4.10 AddYcpData

新增模拟量配置信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/SystemConfig/AddYcpData

请求方式：POST

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
staNo 必须 Long 站点号
equipNo 必须 Long 设备号
ycNo 必须 Long 遥测号
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/SystemConfig/AddYcpData",
    timeout:5000,
    data:{
      staNo: 1,
      equipNo: 3,
      ycNo: 999,
      ycNm: "string",
      mapping: 0,
      ycMin: 0,
      ycMax: 0,
      physicMin: 0,
      physicMax: 0,
      valMin: 0,
      restoreMin: 0,
      restoreMax: 0,
      valMax: 0,
      valTrait: 0,
      mainInstruction: "string",
      minorInstruction: "string",
      safeBgn: "string",
      safeEnd: "string",
      alarmAcceptableTime: 0,
      restoreAcceptableTime: 0,
      alarmRepeatTime: 0,
      procAdvice: "string",
      lvlLevel: 0,
      outminEvt: "string",
      outmaxEvt: "string",
      waveFile: "string",
      relatedPic: "string",
      alarmScheme: 0,
      curveRcd: 0,
      curveLimit: 0,
      alarmShield: "string",
      unit: "string",
      alarmRiseCycle: 0,
      reserve1: "string",
      reserve2: "string",
      reserve3: "string",
      relatedVideo: "string",
      ziChanId: "string",
      planNo: "string",
      safeTime: "string"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备新增结果 1成功 0失败
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 4.11 EditYcpData

修改设备配置信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/SystemConfig/EditYcpData

请求方式：POST

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
staNo 必须 Long 站点号
equipNo 必须 Long 设备号
ycNo 必须 String 遥测号
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/SystemConfig/EditYcpData",
    timeout:5000,
    data:{
      staNo: 1,
      equipNo: 3,
      ycNo: 999,
      ycNm: "string1",
      mapping: 0,
      ycMin: 0,
      ycMax: 0,
      physicMin: 0,
      physicMax: 0,
      valMin: 0,
      restoreMin: 0,
      restoreMax: 0,
      valMax: 0,
      valTrait: 0,
      mainInstruction: "string",
      minorInstruction: "string",
      safeBgn: "string",
      safeEnd: "string",
      alarmAcceptableTime: 0,
      restoreAcceptableTime: 0,
      alarmRepeatTime: 0,
      procAdvice: "string",
      lvlLevel: 0,
      outminEvt: "string",
      outmaxEvt: "string",
      waveFile: "string",
      relatedPic: "string",
      alarmScheme: 0,
      curveRcd: 0,
      curveLimit: 0,
      alarmShield: "string",
      unit: "string",
      alarmRiseCycle: 0,
      reserve1: "string",
      reserve2: "string",
      reserve3: "string",
      relatedVideo: "string",
      ziChanId: "string",
      planNo: "string",
      safeTime: "string"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备新增结果 1成功 0失败
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 4.12 DelYcpData

删除模拟量配置信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/SystemConfig/DelYcpData

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
staNo 必须 Long 站点号
equipNo 必须 Long 设备号
ycNo 必须 Long 遥测号
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/SystemConfig/DelYcpData",
    timeout:5000,
    data:{
      staNo: 1,
      equipNo: 3,
      ycNo:999
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备列表集合，逗号分隔
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 4.13 GetYxpDataList

获取状态量配置信息——支持分页、搜索

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/SystemConfig/GetYxpDataList

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
pageNo 必须 Long 当前页
pageSize 必须 Long 每页显示数量
equipNo 必须 Long 设备号
equipName 可选 String 设备名称
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/SystemConfig/GetYxpDataList",
    timeout:5000,
    data:{
      pageNo: 0,
      pageSize: 100,
      equipNo: 2
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备列表集合
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "totalCount": 100,
    "totalPage": 10,
    "list": "[{"sta_n":1,"equip_no":2,"yx_no":6,"yx_nm":"测点6","proc_advice_r":"请查看","proc_advice_d":"请查看","level_r":1,"level_d":3,"evt_01":"正常","evt_10":"报警","main_instruction":"02","minor_instruction":"0000.5","safe_bgn":"2001-01-01 00:00:00","safe_end":"2001-01-01 00:00:00","alarm_acceptable_time":5,"restore_acceptable_time":0,"alarm_repeat_time":0,"wave_file":"YX62_6_0.wav/YX62_6_1.wav","related_pic":"","alarm_scheme":3,"inversion":0,"initval":0,"val_trait":0,"alarm_shield":"","alarmRiseCycle":0,"reserve1":"","reserve2":"","reserve3":"","related_video":"","ziChanID":"","planNo":"","safeTime":""}]"
  }
}

# 4.14 GetYxpDataByEquipYxNo

获取单个测点的状态量配置信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/SystemConfig/GetYxpDataByEquipYxNo

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
staNo 必须 Long 站点号
equipNo 必须 Long 设备号
ycyxSetpNo 必须 Long 遥信号
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/SystemConfig/GetYxpDataByEquipYxNo",
    timeout:5000,
    data:{
      staNo: 1,
      equipNo: 2,
      ycyxSetpNo: 1
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": "[{"sta_n":1,"equip_no":2,"yx_no":1,"yx_nm":"测点1","proc_advice_r":"请查看","proc_advice_d":"请查看","level_r":1,"level_d":3,"evt_01":"正常","evt_10":"报警","main_instruction":"02","minor_instruction":"0000.0","safe_bgn":"2001-01-01 00:00:00","safe_end":"2001-01-01 00:00:00","alarm_acceptable_time":5,"restore_acceptable_time":0,"alarm_repeat_time":0,"wave_file":"YX62_1_0.wav/YX62_1_1.wav","related_pic":"","alarm_scheme":3,"inversion":0,"initval":0,"val_trait":0,"alarm_shield":"","alarmRiseCycle":0,"reserve1":"","reserve2":"","reserve3":"","related_video":"","ziChanID":"","planNo":"","safeTime":""}]"
}

# 5. 事件查询

  • 获取设备事件（模拟量状态量设置量事件）——支持时间段查询、分页、排序、搜索
  • 获取系统事件——支持时间段查询、分页、排序、搜索

# 5.1 GetEquipEvtByPage

获取设备事件（模拟量状态量设置量事件）——支持时间段查询、分页、排序、搜索

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/Event/GetEquipEvtByPage

请求方式：POST

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application//json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
pageNo 必须 Int 当前页
pageSize 必须 Int 每页显示数量
beginTime 必须 String 开始时间
endTime 必须 String 结束时间
equipNos 必须 String 选中设备号，逗号分隔
sort 可选 String 排序，默认降序 asc：升序 desc：降序
eventName 可选 String 待搜索的事件名称
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/Event/GetEquipEvtByPage",
    timeout:5000,
    data:{
        pageNo:"0",
        pageSize:"10",
        beginTime:"2020-01-01",
        endTime:"2020-10-01",
        equipNos:"1,2,3,4,5,6,7,8,9,10",
        sort:"desc",
        eventName:"温湿度"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data.pageNo String d当前页
data.pageSize String 每页记录数
data.totalCount String 总数
data.totalPage String 总页数
data.list String 设备事件集合
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "pageNo": 0,
    "pageSize": 10,
    "totalCount": 100,
    "totalPage": 10,
    "list": "[{"time":"2020-01-03 10:43:20.1393148","equip_no":2,"equip_nm":"继电器控制模块","event":"继电器控制模块-测点1:报警","alarmlevel":3,"ycyx_no":1,"ycyx_type":"X","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-03 10:43:20.5410665","equip_no":2,"equip_nm":"继电器控制模块","event":"继电器控制模块-测点2:报警","alarmlevel":3,"ycyx_no":2,"ycyx_type":"X","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-03 10:43:20.905027","equip_no":2,"equip_nm":"继电器控制模块","event":"继电器控制模块-测点3:报警","alarmlevel":3,"ycyx_no":3,"ycyx_type":"X","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-03 10:43:21.2115576","equip_no":2,"equip_nm":"继电器控制模块","event":"继电器控制模块-测点4:报警","alarmlevel":3,"ycyx_no":4,"ycyx_type":"X","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-03 10:43:21.5253649","equip_no":2,"equip_nm":"继电器控制模块","event":"继电器控制模块-测点5:报警","alarmlevel":3,"ycyx_no":5,"ycyx_type":"X","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-03 10:43:21.8033044","equip_no":2,"equip_nm":"继电器控制模块","event":"继电器控制模块-测点6:报警","alarmlevel":3,"ycyx_no":6,"ycyx_type":"X","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-03 10:43:25.015791","equip_no":5,"equip_nm":"bacnet","event":"bacnet:-通讯失败","alarmlevel":3,"ycyx_no":0,"ycyx_type":"E","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-06 09:44:07.9640004","equip_no":2,"equip_nm":"继电器控制模块","event":"继电器控制模块-测点1:报警","alarmlevel":3,"ycyx_no":1,"ycyx_type":"X","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-06 09:44:08.3800554","equip_no":2,"equip_nm":"继电器控制模块","event":"继电器控制模块-测点2:报警","alarmlevel":3,"ycyx_no":2,"ycyx_type":"X","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-06 09:44:08.7068873","equip_no":2,"equip_nm":"继电器控制模块","event":"继电器控制模块-测点3:报警","alarmlevel":3,"ycyx_no":3,"ycyx_type":"X","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-06 09:44:09.0700227","equip_no":2,"equip_nm":"继电器控制模块","event":"继电器控制模块-测点4:报警","alarmlevel":3,"ycyx_no":4,"ycyx_type":"X","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-06 09:44:09.3394956","equip_no":2,"equip_nm":"继电器控制模块","event":"继电器控制模块-测点5:报警","alarmlevel":3,"ycyx_no":5,"ycyx_type":"X","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-06 09:44:09.64687","equip_no":2,"equip_nm":"继电器控制模块","event":"继电器控制模块-测点6:报警","alarmlevel":3,"ycyx_no":6,"ycyx_type":"X","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-06 09:44:12.750662","equip_no":5,"equip_nm":"bacnet","event":"bacnet:-通讯失败","alarmlevel":3,"ycyx_no":0,"ycyx_type":"E","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-06 16:14:28.9203206","equip_no":2,"equip_nm":"继电器控制模块","event":"继电器控制模块-测点1:报警","alarmlevel":3,"ycyx_no":1,"ycyx_type":"X","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-06 16:14:29.4057003","equip_no":2,"equip_nm":"继电器控制模块","event":"继电器控制模块-测点2:报警","alarmlevel":3,"ycyx_no":2,"ycyx_type":"X","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-06 16:14:29.9080928","equip_no":2,"equip_nm":"继电器控制模块","event":"继电器控制模块-测点3:报警","alarmlevel":3,"ycyx_no":3,"ycyx_type":"X","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-06 16:14:30.2276098","equip_no":2,"equip_nm":"继电器控制模块","event":"继电器控制模块-测点4:报警","alarmlevel":3,"ycyx_no":4,"ycyx_type":"X","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-06 16:14:30.5024468","equip_no":2,"equip_nm":"继电器控制模块","event":"继电器控制模块-测点5:报警","alarmlevel":3,"ycyx_no":5,"ycyx_type":"X","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-06 16:14:30.7549735","equip_no":2,"equip_nm":"继电器控制模块","event":"继电器控制模块-测点6:报警","alarmlevel":3,"ycyx_no":6,"ycyx_type":"X","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""},{"time":"2020-01-06 16:14:34.050944","equip_no":5,"equip_nm":"bacnet","event":"bacnet:-通讯失败","alarmlevel":3,"ycyx_no":0,"ycyx_type":"E","confirmtime":"0001-01-01 00:00:00","related_pic":"","related_video":"","ziChanID":"","planNo":""}]"
  }
}

# 5.2 GetSysEvtByPage

获取系统事件——支持时间段查询、分页、排序、搜索

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/Event/GetSysEvtByPage

请求方式：POST

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application//json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
pageNo 必须 Int 当前页
pageSize 必须 Int 每页显示数量
beginTime 必须 String 开始时间
endTime 必须 String 结束时间
sort 可选 String 排序，默认降序 asc：升序 desc：降序
eventName 可选 String 待搜索的事件名称
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/Event/GetSysEvtByPage",
    timeout:5000,
    data:{
        pageNo:"0",
        pageSize:"10",
        beginTime:"2020-01-01",
        endTime:"2020-10-01",
        sort:"desc",
        eventName:"联动出错"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data.pageNo String 当前页
data.pageSize String 每页记录数
data.totalCount String 总数
data.totalPage String 总页数
data.list String 系统事件集合
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "pageNo": 0,
    "pageSize": 10,
    "totalCount": 100,
    "totalPage": 10,
    "list": "[{"event":"AlarmCenter.DataCenter.Msg6","time":"2020-01-07 10:42:03.1742532","confirmtime":"2000-01-01 00:00:00"},{"event":"联动出错:SetParm表中不存在设备号为1,设置号为1的动作. ","time":"2020-01-07 10:42:02.4836202","confirmtime":"2000-01-01 00:00:00"},{"event":"AlarmCenter.Config.Msg1AlarmCenter.Config.Msg2Ae6n-6m9C-Ba3r-3A4l","time":"2020-01-07 10:42:01.4570035","confirmtime":"2000-01-01 00:00:00"},{"event":"AlarmCenter.DataCenter.Msg6","time":"2020-01-06 16:14:23.405826","confirmtime":"2000-01-01 00:00:00"},{"event":"联动出错:SetParm表中不存在设备号为1,设置号为1的动作. ","time":"2020-01-06 16:14:22.6241335","confirmtime":"2000-01-01 00:00:00"},{"event":"AlarmCenter.Config.Msg1AlarmCenter.Config.Msg2DeAn-9mAC-1a7r-EA8l","time":"2020-01-06 16:14:20.8110223","confirmtime":"2000-01-01 00:00:00"},{"event":"AlarmCenter.DataCenter.Msg6","time":"2020-01-06 09:44:02.0645478","confirmtime":"2000-01-01 00:00:00"},{"event":"联动出错:SetParm表中不存在设备号为1,设置号为1的动作. ","time":"2020-01-06 09:44:01.5914719","confirmtime":"2000-01-01 00:00:00"},{"event":"AlarmCenter.Config.Msg1AlarmCenter.Config.Msg2Ae6n-6m9C-Ba3r-3A4l","time":"2020-01-06 09:44:00.4652988","confirmtime":"2000-01-01 00:00:00"},{"event":"AlarmCenter.DataCenter.Msg6","time":"2020-01-03 10:43:14.1636256","confirmtime":"2000-01-01 00:00:00"},{"event":"联动出错:SetParm表中不存在设备号为1,设置号为1的动作. ","time":"2020-01-03 10:43:13.5603333","confirmtime":"2000-01-01 00:00:00"},{"event":"AlarmCenter.Config.Msg1AlarmCenter.Config.Msg2Ae6n-6m9C-Ba3r-3A4l","time":"2020-01-03 10:43:12.2449048","confirmtime":"2000-01-01 00:00:00"}]"
  }
}

# 6. 报警排班

  • 获取人员信息列表——支持分页、搜索
  • 增加排班人员信息
  • 修改排班人员信息
  • 删除排班人员信息
  • 获取人员安排列表（周排表、管理范围、特定日期排表）
  • 获取设备分组列表——支持分页、搜索
  • 增加设备分组列表信息
  • 修改单条设备分组信息
  • 删除单条设备分组信息
  • 获取管理范围列表——支持分页
  • 增加单条管理范围信息
  • 修改单条管理范围信息
  • 删除单条管理范围信息
  • 获取周排表列表——支持分页
  • 增加单条周排表信息
  • 修改单条周排表信息
  • 删除单条周排表信息
  • 获取特定日期排表列表——支持分页
  • 增加单条特定日期排表信息
  • 修改单条特定日期排表信息
  • 删除单条特定日期排表信息
  • 人员信息搜索（后端实现）
  • 设备分组搜索（后端实现）
  • 周排表搜索（后端实现）
  • 特定日期排表搜索（后端实现）

# 6.1 GetAllEquipDataList

获取人员信息列表——支持分页、搜索

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/GetPersonListByPage

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
pageNo 必须 Long 当前页
pageSize 必须 Long 每页显示数量
personName 可选 String 人员名称
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/GetPersonListByPage",
    timeout:5000,
    data:{
      pageNo: 0,
      pageSize: 100
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备列表集合
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "totalCount": 100,
    "totalPage": 10,
    "list": "[{"administrator":"邓经飞","telphone":"18948196576","mobileTel":"18948196576","eMail":"dengjingfei@ganweisoft.com","ackLevel":1}]"
  }
}

# 6.2 AddPersonInfo

增加一条排班人员信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/AddPersonInfo

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
personName 必须 String 人员名称
telphone 可选 String 电话号码
mobileTel 可选 String 短信号码
email 可选 String 电子邮箱
ackLevel 必须 Long 报警通知级别(0-3)
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/AddPersonInfo",
    timeout:5000,
    data:{
      personName: "邓经飞2",
      telphone: "18720989200",
      mobileTel: "18720989200",
      email: "18720989200@139.com",
      ackLevel: 1
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 6.3 EditPersonInfo

修改一条排班人员信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/EditPersonInfo

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
personName 必须 String 人员名称
telphone 可选 String 电话号码
mobileTel 可选 String 短信号码
email 可选 String 电子邮箱
ackLevel 必须 Long 报警通知级别(0-3)
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/EditPersonInfo",
    timeout:5000,
    data:{
      personName: "邓经飞2",
      telphone: "18720989200",
      mobileTel: "18720989200",
      email: "18720989200@139.com",
      ackLevel: 1
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 6.4 DelPersonInfo

删除一条排班人员信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/DelPersonInfo

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
personName 必须 String 人员名称
telphone 可选 String 电话号码
mobileTel 可选 String 短信号码
email 可选 String 电子邮箱
ackLevel 必须 Long 报警通知级别(0-3)
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/DelPersonInfo",
    timeout:5000,
    data:{
      personName: "邓经飞2"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 6.5 GetEquipGroupListByPage

获取设备分组列表——支持分页、搜索

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/GetEquipGroupListByPage

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
pageNo 必须 Long 当前页
pageSize 必须 Long 每页显示数量
groupName 可选 String 设备分组名称
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/GetEquipGroupListByPage",
    timeout:5000,
    data:{
      pageNo: 0,
      pageSize: 100
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备列表集合
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "totalCount": 100,
    "totalPage": 10,
    "list": "[{"group_no":1,"group_name":"新建设备分组1","equipcomb":"#2#3"}]"
  }
}

# 6.6 AddEquipGroupData

增加一条设备分组信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/AddEquipGroupData

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
groupName 必须 String 设备分组名称
equipComb 可选 String 选中设备，格式#1#2#3
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/AddEquipGroupData",
    timeout:5000,
    data:{
      groupName: "新建设备分组2",
      equipComb: "#3"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 6.7 EditPersonInfo

修改一条设备分组信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/EditPersonInfo

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
groupNo 必须 String 设备分组编码
groupName 必须 String 设备分组名称
equipComb 可选 String 选中设备，格式#1#2#3
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/EditPersonInfo",
    timeout:5000,
    data:{
      groupNo: 2,
      groupName: "新建设备分组2",
      equipComb: "#3"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 6.8 DelEquipGroupData

删除一条设备分组信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/DelEquipGroupData

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
groupNo 必须 String 设备分组编码
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/DelEquipGroupData",
    timeout:5000,
    data:{
      groupNo: 2
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 6.9 GetAlmReportListByPage

获取管理范围列表——支持分页、搜索

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/GetAlmReportListByPage

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
pageNo 必须 Long 当前页
pageSize 必须 Long 每页显示数量
personName 可选 String 人员名称
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/GetAlmReportListByPage",
    timeout:5000,
    data:{
      pageNo: 0,
      pageSize: 100
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 管理范围列表集合
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "totalCount": 100,
    "totalPage": 10,
    "list": "[{"id":1,"sta_n":0,"group_no":1,"administrator":"钟其达"},{"id":2,"sta_n":0,"group_no":2,"administrator":"闫列友"}]"
  }
}

# 6.10 AddAlmReportData

增加一条管理范围信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/AddAlmReportData

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
groupNo 必须 Long 设备分组编码
personName 必须 String 人员名称
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/AddAlmReportData",
    timeout:5000,
    data:{
      groupNo: 2,
      personName: "邓经飞"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 6.11 EditPersonInfo

修改一条管理范围信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/EditPersonInfo

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
ID 必须 Long 管理范围编码
groupNo 必须 Long 设备分组编码
personName 必须 String 人员名称
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/EditPersonInfo",
    timeout:5000,
    data:{
      ID: 3，
      groupNo: 2,
      personName: "陈焕杰"      
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 6.12 DelAlmReportData

删除一条管理范围信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/DelAlmReportData

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
ID 必须 Long 管理范围编码
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/DelAlmReportData",
    timeout:5000,
    data:{
      groupNo: 2
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 6.13 GetWeekAlmReportListByPage

获取周排表列表——支持分页、搜索

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/GetWeekAlmReportListByPage

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
pageNo 必须 Long 当前页
pageSize 必须 Long 每页显示数量
personName 可选 String 人员名称
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/GetWeekAlmReportListByPage",
    timeout:5000,
    data:{
      pageNo: 0,
      pageSize: 100
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 管理范围列表集合
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "totalCount": 100,
    "totalPage": 10,
    "list": "[{"id":1,"sta_n":0,"group_no":1,"administrator":"邓经飞","week_day":1,"begin_time":"1900-01-01 00:00:00.000","end_time":"1900-01-01 23:59:00.000"}]"
  }
}

# 6.14 AddWeekAlmReportData

增加一条周排表信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/AddWeekAlmReportData

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
groupNo 必须 Long 设备分组编码
personName 必须 String 人员名称
weekList 必须 String 星期
beginTime 必须 DateTime 开始时间
endTime 必须 DateTime 结束时间
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/AddWeekAlmReportData",
    timeout:5000,
    data:{
      groupNo: 2,
      groupName: "新增设备分组2",
      weekList: "1",
      beginTime: "2020-01-12T01:56:02.928Z",
      endTime: "2020-01-12T23:56:02.928Z"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 6.15 EditWeekAlmReportData

修改一条管理范围信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/EditWeekAlmReportData

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
ID 必须 Long 周排表编码
groupNo 必须 Long 设备分组编码
personName 必须 String 人员名称
weekList 必须 String 星期
beginTime 必须 DateTime 开始时间
endTime 必须 DateTime 结束时间
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/EditWeekAlmReportData",
    timeout:5000,
    data:{
      ID: 2,
      groupNo: 2,
      groupName: "新增设备分组2",
      weekList: "1",
      beginTime: "2020-01-12T01:56:02.928Z",
      endTime: "2020-01-12T23:56:02.928Z"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 6.16 DelWeekAlmReportData

删除一条周排表信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/DelWeekAlmReportData

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
ID 必须 Long 周排表编码
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/DelWeekAlmReportData",
    timeout:5000,
    data:{
      ID: 2
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 6.17 GetSpeAlmReportListByPage

获取特定日期排表列表——支持分页、搜索

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/GetSpeAlmReportListByPage

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
pageNo 必须 Long 当前页
pageSize 必须 Long 每页显示数量
personName 可选 String 人员名称
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/GetSpeAlmReportListByPage",
    timeout:5000,
    data:{
      pageNo: 0,
      pageSize: 100
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 特定日期排表列表集合
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "totalCount": 100,
    "totalPage": 10,
    "list": "[{"id":1,"sta_n":0,"group_no":1,"administrator":"邓经飞","week_day":1,"begin_time":"1900-01-01 00:00:00.000","end_time":"1900-01-01 23:59:00.000"}]"
  }
}

# 6.18 AddSpeAlmReportData

增加一条特定日期排表信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/AddSpeAlmReportData

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
groupNo 必须 Long 设备分组编码
personName 必须 String 人员名称
beginTime 必须 DateTime 开始时间
endTime 必须 DateTime 结束时间
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/AddSpeAlmReportData",
    timeout:5000,
    data:{
      groupNo: 2,
      groupName: "新增设备分组2",
      beginTime: "2020-01-12T01:56:02.928Z",
      endTime: "2020-01-12T23:56:02.928Z"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 6.19 EditSpeAlmReportData

修改一条特定日期排表信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/EditSpeAlmReportData

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
ID 必须 Long 周排表编码
groupNo 必须 Long 设备分组编码
personName 必须 String 人员名称
beginTime 必须 DateTime 开始时间
endTime 必须 DateTime 结束时间
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/EditSpeAlmReportData",
    timeout:5000,
    data:{
      ID: 2,
      groupNo: 2,
      groupName: "新增设备分组2",
      beginTime: "2020-01-12T01:56:02.928Z",
      endTime: "2020-01-12T23:56:02.928Z"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 设备详情
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 6.20 DelSpelmReportData

删除一条特定日期排表信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/AlarmManage/DelSpelmReportData

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
ID 必须 Long 特定日期排表编码
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/AlarmManage/DelSpelmReportData",
    timeout:5000,
    data:{
      ID: 2
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 处理结果 0 失败 1成功
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": 1
}

# 7. 定时任务

  • 获取任务库列表
  • 获取一条任务流程图（坐标、开始/结束时间、执行时间、顺序）
  • 新建一条任务
  • 修改一条任务
  • 删除一条任务
  • 搜索任务（后端实现）
  • 获取每周任务安排（包含普通任务、循环任务）
  • 保存每周任务安排
  • 获取所有特殊日期安排——支持分页
  • 增加一条特殊日期安排任务
  • 修改一条特殊日期安排任务
  • 删除一条特殊日期安排任务

# 8. 设备联动（场景编辑下版本开发）

  • 获取所有设备联动列表——支持分页、搜索
  • 增加单条设备联动信息
  • 修改单条设备联动信息
  • 删除单条设备联动信息

# 8.1 GetEquipLinkListByPage

获取所有设备联动列表——支持分页、搜索

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/EquipLink/GetEquipLinkListByPage

请求方式：POST

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application//json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
pageNo 必须 Int 当前页
pageSize 必须 Int 每页显示数量
equipName 可选 String 待搜索的设备名称
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/EquipLink/GetEquipLinkListByPage",
    timeout:5000,
    data:{
        pageNo:"0",
        pageSize:"10",
        equipName:"继电器"
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data.pageNo String d当前页
data.pageSize String 每页记录数
data.totalCount String 总数
data.totalPage String 总页数
data.list String 设备联动列表集合
  1. 返回示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "pageNo": 0,
    "pageSize": 10,
    "totalCount": 100,
    "totalPage": 10,
    "list": "[{"iequip_no":2,"equip_nm":"继电器控制模块","iycyx_no":1,"yx_nm":"测点1","iycyx_type":"X","delay":0,"oequip_no":2,"oset_no":1,"set_nm":"继电器1 断开","value":"0","procDesc":"test"},{"iequip_no":1,"equip_nm":null,"iycyx_no":1,"yx_nm":null,"iycyx_type":"X","delay":0,"oequip_no":1,"oset_no":1,"set_nm":null,"value":"0","procDesc":"test"}]"
  }
}

# 8.2 AddEquipLinkData

增加单条设备联动信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/EquipLink/AddEquipLinkData

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
iequipNo 必须 Long 触发设备号
iycyxNo 必须 Long 遥测遥信号
iycyxType 必须 String 遥测遥信类型
delay 可选 Long 延时
oequipNo 必须 Long 关联设备号
osetNo 必须 Long 关联设置号
value 可选 String 值
procDesc 可选 String 描述
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/EquipLink/AddEquipLinkData",
    timeout:5000,
    data:{
        iequipNo:2,
        iycyxNo:1，
        iycyxType:"X"，
        delay:0，
        oequipNo:2，
        osetNo:1，
        value:""，
        procDesc:""
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 结果 1成功 0失败
  1. 返回示例
{
    "code": 200,
    "message": "Success",
    "data": 1
}

# 8.3 EditEquipLinkData

修改单条设备联动信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/EquipLink/EditEquipLinkData

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
id 必须 Long 唯一编码
iequipNo 必须 Long 触发设备号
iycyxNo 必须 Long 遥测遥信号
iycyxType 必须 String 遥测遥信类型
delay 可选 Long 延时
oequipNo 必须 Long 关联设备号
osetNo 必须 Long 关联设置号
value 可选 String 值
procDesc 可选 String 描述
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/EquipLink/EditEquipLinkData",
    timeout:5000,
    data:{
        id:3,
        iequipNo:2,
        iycyxNo:1,
        iycyxType:"X",
        delay:0,
        oequipNo:2,
        osetNo:1,
        value:"",
        procDesc:""
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 结果 1成功 0失败
  1. 返回示例
{
    "code": 200,
    "message": "Success",
    "data": 1
}

# 8.4 DelEquipLinkData

删除单条设备联动信息

  1. 接口形式

接口：https://localhost:44380/IoT/api/v3/EquipLink/DelEquipLinkData

请求方式：GET

  1. 请求包header

该请求要求含有下表列出的头部信息：

参数名 值 描述
Content-Type application/json json格式
  1. 请求参数
参数名 是否必须 类型 参数说明
id 必须 Long 唯一编码
  1. 用法示例
 $.ajax({
    type:"POST",
    url:"/IoT/api/v3/EquipLink/DelEquipLinkData",
    timeout:5000,
    data:{
        id:3
    },
    success:function(dt){
        console.log(dt);
        console.log(dt.HttpData.data);
    }
});
  1. 返回内容
字段 类型 说明
code String 接口调用处理的结果码
message String 描述
data String 结果 1成功 0失败
  1. 返回示例
{
    "code": 200,
    "message": "Success",
    "data": 1
}

# 9. 定时报表

  • 增加单条抄表配置
  • 删除单条抄表配置
  • 获取多个设备多个测点指定时间段的抄表文件列表
  • 查看抄表文件内容
  • 报表定义界面——设备名称搜索（后端实现）

# 10. 用户权限管理

  • 获取所有用户列表信息
  • 增加单个用户
  • 删除单个用户
  • 修改单个用户信息
  • 获取所有角色列表信息
  • 增加一个角色
  • 删除一个角色
  • 修改一个角色
  • 获取可控设备列表
  • 获取可看设备列表
  • 获取可看页面列表
  • 获取系统功能列表
上次更新: 1/6/2023, 5:54:14 PM

← 北向WebAPI→