李鹏 / api-doc

转到一个项目
Toggle navigation Toggle navigation pinning
lipengjava
10c8412d 1 parent b175b93e

more api

内嵌 并排对比
正在显示 3 个修改的文件 包含 100 行增加 和 8 行删除
@@ -10,7 +10,7 @@ @@ -10,7 +10,7 @@
10 * @apiParam {int} pageNo=1 查询第几页，如果超出实际页数，自动调整为第1页 10 * @apiParam {int} pageNo=1 查询第几页，如果超出实际页数，自动调整为第1页
11 * @apiParam {int} [pageSize=20] 每页显示多少条 11 * @apiParam {int} [pageSize=20] 每页显示多少条
12 * @apiParam {Long} timestamp 时间戳 12 * @apiParam {Long} timestamp 时间戳
13 - * @apiParam {String} authId MD5(key+siteId+year+month+timestamp), 其中 key 为与系统约定的加密 key 13 + * @apiParam {String} authId MD5(key+siteId+mtgKey+timestamp), 其中 key 为与系统约定的加密 key
14 * 14 *
15 * @apiParamExample {xml} 请求示例 15 * @apiParamExample {xml} 请求示例
16 <?xml version="1.0" encoding="UTF-8"?> 16 <?xml version="1.0" encoding="UTF-8"?>
@@ -43,13 +43,6 @@ @@ -43,13 +43,6 @@
43 * @apiSuccess {int} logList.logInfo.userRole 用户角色 43 * @apiSuccess {int} logList.logInfo.userRole 用户角色
44 * @apiSuccess {String} logList.logInfo.joinTime 进入时间 44 * @apiSuccess {String} logList.logInfo.joinTime 进入时间
45 * @apiSuccess {String} logList.logInfo.exitTime 离开时间 45 * @apiSuccess {String} logList.logInfo.exitTime 离开时间
46 - * 0 正在创建 <br/>  
47 - * 1 预约状态 <br/>  
48 - * 2 进行中 <br/>  
49 - * 3 已取消 <br/>  
50 - * 4 已结束 <br/>  
51 - * @apiSuccess {String} mtgList.mtgInfo.startTime 开始时间，第一次通过接口进入活动的时间  
52 - * @apiSuccess {String} mtgList.mtgInfo.endTime 结束时间：如果课堂状态为 0、1、2，则是预约的课堂的结束时间；如果状态为3、4，则是课堂真实的结束时间  
53 * 46 *
54 * @apiSuccessExample {xml} 返回示例 47 * @apiSuccessExample {xml} 返回示例
55 &lt;?xml version=“1.0” encoding="UTF-8"?&gt; 48 &lt;?xml version=“1.0” encoding="UTF-8"?&gt;
  1 +/**
  2 + * @api {post} /3m/meeting/conf_log_total.do 14.查询课堂用户进出总记录
  3 + * @apiName conf_log_total
  4 + * @apiGroup user
  5 + * @apiVersion 1.6.0
  6 + * @apiDescription 查询单个课堂用户进出课堂的记录。统计用户第一次加入课堂时间和最后一次离开时间
  7 + *
  8 + * @apiParam {String} siteId 站点标识
  9 + * @apiParam {String} mtgKey 课堂的唯一标识，由第三方维护，最大长度64
  10 + * @apiParam {Long} timestamp 时间戳
  11 + * @apiParam {String} authId MD5(key+siteId+mtgKey+timestamp), 其中 key 为与系统约定的加密 key
  12 + *
  13 + * @apiParamExample {xml} 请求示例
  14 + &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  15 + &lt;param&gt;
  16 + &lt;siteId&gt;shanghai&lt;/siteId&gt;
  17 + &lt;mtgKey&gt;10002321&lt;/mtgKey&gt;
  18 + &lt;timestamp&gt;1392032123210&lt;/timestamp&gt;
  19 + &lt;authId&gt;4297f44b13955235245b2497399d7a93&lt;/authId&gt;
  20 + &lt;/param&gt;
  21 + *
  22 + * @apiSuccess {int} errorCode
  23 + * 0：正常 <br/>
  24 + * 1：siteId 错误，站点不存在或已删除 <br/>
  25 + * 2：站点未到生效日期 <br/>
  26 + * 3: 站点过期 <br/>
  27 + * 4：authId 错误 <br/>
  28 + * 5：authId 不能重复使用 <br/>
  29 + * 6：timestamp 超时 <br/>
  30 + * 7：mtgKey 不存在 <br/>
  31 + * 10：报文格式错误 <br/>
  32 + * @apiSuccess {String} mtgKey 传入的参数
  33 + * @apiSuccess {int} logCount 总记录数
  34 + * @apiSuccess {List} logList 列表
  35 + * @apiSuccess {Object} logList.logInfo 进出信息对象
  36 + * @apiSuccess {String} logList.logInfo.userId 用户ID
  37 + * @apiSuccess {String} logList.logInfo.userName 用户姓名
  38 + * @apiSuccess {int} logList.logInfo.userRole 用户角色
  39 + * @apiSuccess {String} logList.logInfo.joinTime 进入时间
  40 + * @apiSuccess {String} logList.logInfo.exitTime 离开时间
  41 + *
  42 + * @apiSuccessExample {xml} 返回示例
  43 + &lt;?xml version=“1.0” encoding="UTF-8"?&gt;
  44 + &lt;result&gt;
  45 + &lt;errorCode&gt;0&lt;/errorCode&gt;
  46 + &lt;mtgKey&gt;10002321&lt;/mtgKey&gt;
  47 + &lt;logCount&gt;321&lt;logCount&gt;
  48 + &lt;logList&gt;
  49 + &lt;logInfo&gt;
  50 + &lt;userId&gt;12000232&lt;/userId&gt;
  51 + &lt;userName&gt;ChinaBj001&lt;/userName&gt;
  52 + &lt;userRole&gt;3&lt;/userRole&gt;
  53 + &lt;joinTime&gt;2013-09-11 14:02:05&lt;/joinTime&gt;
  54 + &lt;exitTime&gt;2013-09-11 14:15:47&lt;/exitTime&gt;
  55 + &lt;/logInfo&gt;
  56 + &lt;/logList&gt;
  57 + &lt;/result&gt;
  58 + *
  59 + */
  1 +/**
  2 + * @api {post} /3m/meeting/set_assistance.do 15 设置课堂的求助信息
  3 + * @apiName set_assistance
  4 + * @apiGroup meeting
  5 + * @apiVersion 1.6.0
  6 + * @apiDescription 求助页面的设置：qq和手机号
  7 + *
  8 + * @apiParam {String} siteId 站点标识
  9 + * @apiParam {String} qq 多个QQ用英文逗号分隔，最大长度128
  10 + * @apiParam {String} mobile 多个手机号用英文逗号分隔，最大长度128
  11 + * @apiParam {Long} timestamp 时间戳
  12 + * @apiParam {String} authId MD5(key+siteId+timestamp), 其中 key 为与系统约定的加密 key
  13 + *
  14 + * @apiParamExample {xml} 请求示例
  15 + &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  16 + &lt;param&gt;
  17 + &lt;siteId&gt;shanghai&lt;/siteId&gt;
  18 + &lt;qq&gt;10000,12345&lt;/qq&gt;
  19 + &lt;mobile&gt;18012345678,18912345678&lt;/mobile&gt;
  20 + &lt;timestamp&gt;1392032123210&lt;/timestamp&gt;
  21 + &lt;authId&gt;4297f44b13955235245b2497399d7a93&lt;/authId&gt;
  22 + &lt;/param&gt;
  23 + *
  24 + * @apiSuccess {int} errorCode
  25 + * 0：正常 <br/>
  26 + * 1：siteId 错误，站点不存在或已删除 <br/>
  27 + * 2：站点未到生效日期 <br/>
  28 + * 3: 站点过期 <br/>
  29 + * 4：authId 错误 <br/>
  30 + * 5：authId 不能重复使用 <br/>
  31 + * 6：timestamp 超时 <br/>
  32 + * 10：报文格式错误 <br/>
  33 + *
  34 + * @apiSuccessExample {xml} 返回示例
  35 + &lt;?xml version=“1.0” encoding="UTF-8"?&gt;
  36 + &lt;result&gt;
  37 + &lt;errorCode&gt;0&lt;/errorCode&gt;
  38 + &lt;/result&gt;
  39 + *
  40 + */