Appearance
水价设置接口文档
接口链接
URL地址: /Api_v2/WaterWrite/param
提示
- 部份表不需要设置参数
- 具体根据表类型来确认
接口参数
字段名 | 变量名 | 必填 | 类型 | 描述 |
---|---|---|---|---|
授权码 | auth_code | 是 | String(32) | 系统为使用区域分配的授权码,在后台配置页面获取 |
时间戳 | timestamp | 是 | String(10) | 自1970年1月1日(08:00:00 GMT)至当前时间的总秒数 |
请求内容 | request_content | 是 | String | 详见request_content字段说明,注意 request_content 是json数组,注意合并请求⭐ |
回调地址 | notify_url | 是 | String | 系统处理完查询请求后,通过这个回调地址,把数据推送给请求方 |
签名 | sign | 是 | String(32) | 通过签名算法计算得出的签名值,详见签名生成算法 |
请求内容request_content字段说明
字段名 | 变量名 | 必填 | 类型 | 描述 |
---|---|---|---|---|
操作ID | opr_id | 是 | String | 操作ID,长度16-32,请求时自己生成,用于标识一次异步操作任务,须保证唯一性 |
采集器号 | cid | 是 | String | 采集器号,4G、NB设备采集器号与表号一致 |
表号 | address | 是 | String | 表号(表地址) |
超时时间 | time_out | 否 | int | 超时时间 单位秒,任务因通讯异常等情况未执行自动失效的时间 ,默认1年 |
是否必须在线 | must_online | 否 | Boolean | 如果传true ,则系统接受任务时设备不在线直接返回失败 ,默认 false |
重试次数 | retry_times | 否 | int | 重试次数(0-3) ,默认1次 |
操作数据 | params | 是 | json String | 操作所需的数据 |
操作数据params字段说明
NS 无线类型表参数
NS 无线类型表参数
字段名称 | 变量名 | 类型 | 示例值 | 描述 | 单位 |
---|---|---|---|---|---|
水价 | p1 | number | 1.5 | 水价 | 元/m³ |
报警金额 | warning_money | number | 1.5 | 报警金额 | 元 |
透支金额 | overload_money | number | 0 | 最大允许的欠费金额 | 元 |
最低消费金额 | mini_consume_money | number | 0 | 每月最低消费金额 | 元 |
上报间隔 | upload_days | number | 1.5 | 每隔指定天数上报一次水表数据 | 天 |
上报起始时间 | upload_start_hour | number | 1 | >=0 , <= 23 , < upload_end_hour | 时 |
上报结束时间 | upload_end_hour | number | 23 | >=0 , <= 23 , > upload_start_hour | 时 |
付费模式 | prepay | number | 1 | 预付费表示,0表示不开启预付费,1表示开启预付费 |
上报起始结束时间表示水表在指定时间内随机上报
NS无线阶梯类型水表参数
NS NS无线阶梯类型水表参数
字段名称 | 变量名 | 类型 | 示例值 | 描述 | 单位 |
---|---|---|---|---|---|
水价 | p1 | number | 1.5 | 水价 0-655.35 | 元/m³ |
第一阶梯水价 | p2 | number | 1.6 | 水价 0-655.35 | 元/m³ |
第二阶梯水价 | p3 | number | 1.8 | 水价 0-655.35 | 元/m³ |
第一阶梯值 | p4 | number | 1.5 | 阶梯值 0-65535 | m³ |
第二阶梯值 | p5 | number | 1.5 | 阶梯值 0-65535 | m³ |
结算方式 | step_mode | number | 0 | 表示结算方式 0 表示月结算(默认),1表示季结算,2表示年结算 | |
报警金额 | warning_money | number | 1.5 | 报警金额 | 元 |
透支金额 | overload_money | number | 0 | 最大允许的欠费金额 | 元 |
最低消费金额 | mini_consume_money | number | 0 | 每月最低消费金额 | 元 |
上报间隔 | upload_days | number | 1.5 | 每隔指定天数上报一次水表数据 | 天 |
上报起始时间 | upload_start_hour | number | 1 | >=0 , <= 23 , < upload_end_hour | 时 |
上报结束时间 | upload_end_hour | number | 23 | >=0 , <= 23 , > upload_start_hour | 时 |
付费模式 | prepay | number | 1 | 预付费表示,0表示不开启预付费,1表示开启预付费 |
上报起始结束时间表示水表在指定时间内随机上报
同步返回结果
字段名 | 变量名 | 必填 | 类型 | 描述 |
---|---|---|---|---|
返回状态码 | status | 是 | String | SUCCESS/FAIL,此字段是通信标识 |
时间戳 | timestamp | 是 | String(10) | 自1970年1月1日(08:00:00 GMT)至当前时间的总秒数 |
回复内容 | response_content | 是 | String | 详见response_content字段说明 |
签名 | sign | 是 | String(32) | 通过签名算法计算得出的签名值,详见签名生成算法 |
出错原因 | error_msg | 否 | String | 当返回状态码为"FAIL"时,返回信息为错误原因 |
同步回复内容response_content字段说明
字段名 | 变量名 | 必填 | 类型 | 描述 |
---|---|---|---|---|
操作ID | opr_id | 是 | String | 操作ID,长度16-32,请求时自己生成,用于标识一次异步操作任务,须保证唯一性 |
采集器号 | cid | 是 | String | 采集器号,4G、NB设备采集器号与表号一致 |
表号 | address | 是 | String | 表号(表地址) |
操作状态 | status | 是 | String | 操作请求结果状态,说明提交的任务成功或者失败 |
错误信息 | error_msg | 否 | String | 当操作状态:status值不为“SUCCESS”时,填入具体的出错内容 |
异步返回结果
字段名 | 变量名 | 必填 | 类型 | 描述 |
---|---|---|---|---|
时间戳 | timestamp | 是 | String(10) | 自1970年1月1日(08:00:00 GMT)至当前时间的总秒数 |
回复内容 | response_content | 是 | String | 处理结果数据,查询类型不同,包含数据也会有所差异。 |
签名 | sign | 是 | String(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"
}