API文档示例

API文档示例


用户查询接口(按账号)

<h5>简要描述</h5> <ul> <li>用户查询接口(按账号)</li> </ul> <h5>请求URL</h5> <ul> <li><code>http://xx.xxx/user/getUserByAccountNum</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST </li> </ul> <h5>参数</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">accountNum</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>用户名</td> </tr> <tr> <td style="text-align: left;">password</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>密码</td> </tr> </tbody> </table> <p>请求示例:{&quot;accountNum&quot;:&quot;111&quot;,&quot;password&quot;:&quot;cmy&quot;}</p> <h5>返回示例</h5> <pre><code>成功: { "joinsmallforumid": "1", "password": "cmy", "accountNum": "111", "identity": "1", //1表示参会者,2表示秘书,3表示会议主席,4表示论坛主席 ,可以有多重身份吧 "sex": "1", "name": "1", "state": "success", "id": "4", "joinmeetingid": "1", "RequestBody": "{\"accountNum\":\"111\",\"password\":\"cmy\"}" } 错误: { "userInfo": null, "state": "Error", "RequestBody": "..." }</code></pre> <h5>返回参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> </tbody> </table> <h5>备注</h5> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul> <p>欢迎使用ShowDoc!</p>

页面列表

ITEM_HTML