浏览代码

更新通知接口文档

mrzcc 6 年之前
父节点
当前提交
626b784ea6
共有 1 个文件被更改,包括 68 次插入0 次删除
  1. 68 0
      docs/document/api/notice/updateNotice.md

+ 68 - 0
docs/document/api/notice/updateNotice.md

@@ -0,0 +1,68 @@
+
+
+**1\. 更新通知**
+###### 接口功能
+>更新通知接口
+
+###### URL
+> [http://api.java110.com:8008/api/notice.updateNotice](http://api.java110.com:8008/api/notice.updateNotice)
+
+###### 支持格式
+> JSON
+
+###### HTTP请求方式
+> POST
+
+###### 请求参数(header部分)
+|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-:|
+|app_id|1|String|30|应用ID|Api服务分配                      |
+|transaction_id|1|String|30|请求流水号|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 |
+|sign|1|String|-|签名|请参考签名说明|
+|req_time|1|String|-|请求时间|YYYYMMDDhhmmss|
+
+###### 请求参数
+|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-: |
+|noticeId|1|String|30|通知ID|-|
+|title|1|String|100|通知标题|-|
+|noticeTypeCd|1|String|4|类型|1000 业主通知,1001员工通知,1002小区通知|
+|context|1|String|longtext|通知内容|-|
+|startTime|1|timestamp|-|开始时间|-|
+
+
+###### 返回协议
+
+当http返回状态不为200 时请求处理失败 body内容为失败的原因
+
+当http返回状态为200时请求处理成功,body内容为返回内容,
+
+
+###### 举例
+> 地址:[http://api.java110.com:8008/api/notice.updateNotice](http://api.java110.com:8008/api/notice.updateNotice)
+
+``` javascript
+请求头信息:
+Content-Type:application/json
+USER_ID:1234
+APP_ID:8000418002
+TRANSACTION_ID:10029082726
+REQ_TIME:20181113225612
+SIGN:aabdncdhdbd878sbdudn898
+请求报文:
+
+{
+	"noticeTypeCd": "1002",
+	"context": "<p>测试广告sdad</p>",
+	"startTime": "2020-01-15 19:27:02",
+	"endTime": "2020-04-16 10:30:02",
+	"title": "测试数据公告",
+	"communityId": "7020181217000001",
+	"userId": "30518940136629616640",
+	"noticeId": "962020011569970015"
+}
+
+返回报文:
+
+
+```