采集系统数据发布接口
规范
日期:2011-08-15
目录
1概述 (4)
1.1目的 (4)
1.2参考文献 (4)
2接口介绍 (5)
2.1平台结构图............................................................................................ 错误!未定义书签。
2.2接口功能介绍 (6)
2.3数据需求 (6)
3接口定义 (6)
3.1流程描述 (6)
3.2格式约定 (9)
3.3示例 (9)
3.3.1客户端访问请求 (9)
3.3.2客户端数据请求 (9)
3.3.3客户端文件下载请求 (10)
3.3.4返回文件名情况 (10)
3.3.5返回数据嵌套情况 (11)
3.4接口定义 (11)
3.4.1查询用户档案:type=01 (11)
3.4.2查询终端资产档案:type=02 (12)
3.4.3查询表计档案:type=03 (13)
3.4.4查询电网结构:type=04 (13)
3.4.5查询用户联系人信息:type=05 (14)
3.4.6查询电量数据:type=06,08,10 (14)
3.4.7查询负荷数据:type=07,09 (15)
3.4.8查询实时负荷数据:ywlx=11,ywlx=12 (16)
3.4.9查询月最大负荷数据:ywlx=13,ywlx=14 (17)
3.5访问限制 (18)
3.5.1.不得越单位查询数据 (18)
3.5.2.不能频繁访问 (18)
3.5.3.平台自动选择数据返回方式 (18)
3.5.4.文件下载需要等待30秒 (18)
3.5.5.文件1个小时内下载 (19)
4附录 (19)
附录a 行业代码对照表 (19)
附录b 用电属性 (26)
附录c 接线方式 (27)
附录d 终端规约类型 (27)
1概述
1.1目的
随着全省全覆盖方案的实施,设备数量以及用户数量越来越多,数据需求也越来越多,原有接口方案压力变得很大,为了解决这些问题我们需要建设一套更优的数据发布接口,为各厂商提供统一的访问接口,实现系统数据共享。
1.2参考文献
《用电信息采集系统对外数据发布技术方案.doc》
2 接口介绍
2.1 逻辑架构
光纤、GPRS/CDMA/SMS 等
统一数据采集通信前置子系统
用电信息采集私有数据
统一采集数据
公变监测私有数据
2.2 物理架构
数据发布接口物理架构图
2.3接口功能介绍
用电信息采集系统作为一个统一数据采集平台,采集的数据除了为本系统和营销系统服务外,外部其他系统对于这些采集数据也有着业务应用的需求,因此需要用电信息采集系统开放一个数据发布接口可以对外提供采集数据。
2.4数据需求
当前外部系统需要从用电信息采集系统(以下简称采集系统)获取数据的需求如下:
1.档案数据:包括用户档案、表计档案、采集设备档案、电网结构、联系人信息。
2.采集数据:专变电量数据、专变负荷数据、公变电量数据、公变负荷数据、低
压电量数据。
3.统计数据:专变月最大负荷数据、公变月最大负荷数据、实时工况负荷。
4.停电数据:公变实时停复电信息。
3接口定义
3.1流程描述
1、客户端发送访问请求;
2、进行权限验证,验证用户名密码是否正确,保存正确的用户信息,并记下访问时
间;
3、客户端发送数据请求;
4、验证该用户是否有访问请求中单位的权限,以及判断该用户是否过度频繁访问,
频繁访问的将记入黑名单,不再允许访问;
5、验证通过后,查询数据库中符合该请求的数据的总条数,如果记录数小于100
条则直接返回查询结果;如果大于100条,返回文件名以及客户端需要等待下载的理论时间;
6、根据查询结果生成XML文件,并将文件保存到data目录下;
7、客户端请求下载文件,如果下载不到等待一段时间后再次下载。
流程图如下:
3.2格式约定
VALUE1
VALUE2
……
VALUE3
业务数据组织成XML格式的字符串来交互,该XML格式的字符串遵循以下规则:XML编码格式为“UTF-8”;
XML节点、属性全部为大写;
以来标记数据集的开始和结束;
以标记一行记录;
以字段值标记字段名称及值;
以标记返回标识;
字段为日期的遵循以下约定:
年月日格式统一为“YYYY-MM-DD HH:MI:SS”,如2011-03-22 10:00:00
年月日格式统一为“YYYY-MM-DD”,如“2011-03-22”。
3.3示例
3.3.1客户端访问请求
http://host:port/DataInterface/login.jsp?name=hzxsxt&password=1
表示用户提交访问请求,用户名为hzxsxt,密码为1。
3.3.2客户端数据请求
http://host:port/DataInterface/query?ORG_NO=334013001&type=10&starttime= 2011-07-07&endtime=2011-07-08
表示请求单位代码为334013001的2011-07-07到2011-07-08的低压电量数据其中url里面所需要的字段在3.5节接口定义里面有详细的说明。