Sfoglia il codice sorgente

提交查询活动接口文档(待优化)

mrzcc 6 anni fa
parent
commit
e841858937
1 ha cambiato i file con 63 aggiunte e 0 eliminazioni
  1. 63 0
      docs/document/api/activities/listActivitiess.md

+ 63 - 0
docs/document/api/activities/listActivitiess.md

@@ -0,0 +1,63 @@
+
+
+**1\. 查询活动**
+###### 接口功能
+> 用户通过web端或APP查询活动接口
+
+###### URL
+> [待补充](待补充)
+
+###### 支持格式
+> JSON
+
+###### HTTP请求方式
+> GET
+
+###### 请求参数(header部分)
+|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-:|
+|app_id|1|String|30|应用ID|Api服务分配                      |
+|transaction_id|1|String|30|请求流水号|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 |
+|sign|1|String|-|签名|请参考签名说明|
+|req_time|1|String|-|请求时间|YYYYMMDDhhmmss|
+
+###### 请求参数(url部分)
+|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-: |
+|page|-|-|-|当前页|-|
+|row|-|-|-|每页显示的行数|-|
+
+###### 返回协议
+
+当http返回状态不为200 时请求处理失败 body内容为失败的原因
+
+当http返回状态为200时请求处理成功,body内容为返回内容,
+
+|父参数名称|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-: | :-: |
+|-|-|-|-|-|-|-|
+
+
+
+
+###### 举例
+> 地址:[url&page=1&row=10](待补充)
+
+``` javascript
+请求头信息:
+Content-Type:application/json
+USER_ID:1234
+APP_ID:8000418002
+TRANSACTION_ID:10029082726
+REQ_TIME:20181113225612
+SIGN:aabdncdhdbd878sbdudn898
+请求报文:
+
+无
+
+返回报文:
+{
+	待补充
+}
+
+```