Browse Source

更新小区接口文档

mrzcc 6 years ago
parent
commit
1eb4019363
1 changed files with 69 additions and 0 deletions
  1. 69 0
      docs/document/api/community/updateCommunity.md

+ 69 - 0
docs/document/api/community/updateCommunity.md

@@ -0,0 +1,69 @@
+
+
+**1\. 更新小区**
+###### 接口功能
+> 小区审核接口
+
+###### URL
+> [http://api.java110.com:8008/api/community.updateCommunity](http://api.java110.com:8008/api/community.updateCommunity)
+
+###### 支持格式
+> 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|
+
+###### 请求参数(body部分)
+|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-: |
+|communityId|1|String|30|小区ID|-|
+|name|1|String|100|小区名称|-|
+|address|1|String|200|小区地址|-|
+|nearbyLandmarks|1|String|200|地标|如王府井北60米|
+
+
+###### 返回协议
+
+当http返回状态不为200 时请求处理失败 body内容为失败的原因
+
+当http返回状态为200时请求处理成功,body内容为返回内容,
+
+
+
+###### 举例
+> 地址:[http://api.java110.com:8008/api/community.updateCommunity](http://api.java110.com:8008/api/community.updateCommunity)
+
+``` javascript
+请求头信息:
+Content-Type:application/json
+USER_ID:1234
+APP_ID:8000418002
+TRANSACTION_ID:10029082726
+REQ_TIME:20181113225612
+SIGN:aabdncdhdbd878sbdudn898
+请求报文:
+{
+	"address": "青海省西宁市城中区申宁路6",
+	"nearbyLandmarks": "安馨雅苑北100米1",
+	"cityName": "未知",
+	"stateName": "待审核",
+	"cityCode": "8630100",
+	"name": "格兰小镇(西宁)",
+	"state": "1000",
+	"communityId": "7020181217000002",
+	"mapY": "",
+	"mapX": "102.909090"
+}
+返回报文:
+
+成功
+
+```