Skip to content

水价设置接口文档

接口链接

URL地址: /Api_v2/WaterWrite/param

提示

  • 部份表不需要设置参数
  • 具体根据表类型来确认

接口参数

字段名变量名必填类型描述
授权码auth_codeString(32)系统为使用区域分配的授权码,在后台配置页面获取
时间戳timestampString(10)自1970年1月1日(08:00:00 GMT)至当前时间的总秒数
请求内容request_contentString详见request_content字段说明,注意 request_content 是json数组,注意合并请求⭐
回调地址notify_urlString系统处理完查询请求后,通过这个回调地址,把数据推送给请求方
签名signString(32)通过签名算法计算得出的签名值,详见签名生成算法

请求内容request_content字段说明

字段名变量名必填类型描述
操作IDopr_idString操作ID,长度16-32,请求时自己生成,用于标识一次异步操作任务,须保证唯一性
采集器号cidString采集器号,4G、NB设备采集器号与表号一致
表号addressString表号(表地址)
超时时间time_outint超时时间 单位秒,任务因通讯异常等情况未执行自动失效的时间 ,默认1年
是否必须在线must_onlineBoolean如果传true ,则系统接受任务时设备不在线直接返回失败 ,默认 false
重试次数retry_timesint重试次数(0-3) ,默认1次
操作数据paramsjson String操作所需的数据

操作数据params字段说明

NS 无线类型表参数

NS 无线类型表参数
字段名称变量名类型示例值描述单位
水价p1number1.5水价元/m³
报警金额warning_moneynumber1.5报警金额
透支金额overload_moneynumber0最大允许的欠费金额
最低消费金额mini_consume_moneynumber0每月最低消费金额
上报间隔upload_daysnumber1.5每隔指定天数上报一次水表数据
上报起始时间upload_start_hournumber1>=0 , <= 23 , < upload_end_hour
上报结束时间upload_end_hournumber23>=0 , <= 23 , > upload_start_hour
付费模式prepaynumber1预付费表示,0表示不开启预付费,1表示开启预付费

上报起始结束时间表示水表在指定时间内随机上报

NS无线阶梯类型水表参数

NS NS无线阶梯类型水表参数
字段名称变量名类型示例值描述单位
水价p1number1.5水价 0-655.35元/m³
第一阶梯水价p2number1.6水价 0-655.35元/m³
第二阶梯水价p3number1.8水价 0-655.35元/m³
第一阶梯值p4number1.5阶梯值 0-65535
第二阶梯值p5number1.5阶梯值 0-65535
结算方式step_modenumber0表示结算方式 0 表示月结算(默认),1表示季结算,2表示年结算
报警金额warning_moneynumber1.5报警金额
透支金额overload_moneynumber0最大允许的欠费金额
最低消费金额mini_consume_moneynumber0每月最低消费金额
上报间隔upload_daysnumber1.5每隔指定天数上报一次水表数据
上报起始时间upload_start_hournumber1>=0 , <= 23 , < upload_end_hour
上报结束时间upload_end_hournumber23>=0 , <= 23 , > upload_start_hour
付费模式prepaynumber1预付费表示,0表示不开启预付费,1表示开启预付费

上报起始结束时间表示水表在指定时间内随机上报

同步返回结果

字段名变量名必填类型描述
返回状态码statusStringSUCCESS/FAIL,此字段是通信标识
时间戳timestampString(10)自1970年1月1日(08:00:00 GMT)至当前时间的总秒数
回复内容response_contentString详见response_content字段说明
签名signString(32)通过签名算法计算得出的签名值,详见签名生成算法
出错原因error_msgString当返回状态码为"FAIL"时,返回信息为错误原因

同步回复内容response_content字段说明

字段名变量名必填类型描述
操作IDopr_idString操作ID,长度16-32,请求时自己生成,用于标识一次异步操作任务,须保证唯一性
采集器号cidString采集器号,4G、NB设备采集器号与表号一致
表号addressString表号(表地址)
操作状态statusString操作请求结果状态,说明提交的任务成功或者失败
错误信息error_msgString当操作状态:status值不为“SUCCESS”时,填入具体的出错内容

异步返回结果

字段名变量名必填类型描述
时间戳timestampString(10)自1970年1月1日(08:00:00 GMT)至当前时间的总秒数
回复内容response_contentString处理结果数据,查询类型不同,包含数据也会有所差异。
签名signString(32)通过签名算法计算得出的签名值,详见签名生成算法

示例 JSON

json
{
  "auth_code": "37577f8fb62a7b14ba55cc6faec5a142",
  "timestamp": "1586740681",
  "request_content": [
    {
      "opr_id": "eb8dc0e967664e289f9f1204065c6c25",
      "time_out": 0,
      "must_online": true,
      "retry_times": 1,
      "cid": "10000000031",
      "address": "20040900000003",
      "params": {
        "p1": "1",
        "warning_money": "1.5",
        "overload_money": "0",
        "mini_consume_money": "0",
        "upload_days": "1",
        "upload_start_hour": "1",
        "upload_end_hour": "23",
        "prepay": "1"
      }
    }
  ],
  "notify_url": "http://115.221.11.179:8022/notify",
  "sign": "fee536cf6a37a200d6761df04f5bf368"
}

接口测试工具