李鹏 / api-doc

转到一个项目
Toggle navigation Toggle navigation pinning
lipengjava
de6d74d7 1 parent 91a4545f

update sequence of api

内嵌 并排对比
正在显示 9 个修改的文件 包含 163 行增加 和 25 行删除
1 /** 1 /**
2 - * @api {post} /3m/meeting/conf_list.do 6.查询站点的课堂 2 + * @api {post} /3m/meeting/conf_list.do 06.查询站点的课堂
3 * @apiName conf_list 3 * @apiName conf_list
4 * @apiGroup meeting 4 * @apiGroup meeting
5 * @apiVersion 1.6.0 5 * @apiVersion 1.6.0
1 /** 1 /**
2 - * @api {post} /3m/meeting/conf_log.do 7.查询课堂用户进出记录 2 + * @api {post} /3m/meeting/conf_log.do 07.查询课堂用户进出记录
3 * @apiName conf_log 3 * @apiName conf_log
4 * @apiGroup user 4 * @apiGroup user
5 * @apiVersion 1.6.0 5 * @apiVersion 1.6.0
1 /** 1 /**
2 - * @api {post} /3m/meeting/conf_status.do 9.查询课堂的状态 2 + * @api {post} /3m/meeting/conf_status.do 09.查询课堂的状态
3 * @apiName conf_status 3 * @apiName conf_status
4 * @apiGroup meeting 4 * @apiGroup meeting
5 * @apiVersion 1.6.0 5 * @apiVersion 1.6.0
1 /** 1 /**
2 - * @api {post} /3m/meeting/join_mtg_app.do 4.app获取课堂信息 2 + * @api {post} /3m/meeting/join_mtg_app.do 04.app获取课堂信息
3 * @apiName joinClassApp 3 * @apiName joinClassApp
4 * @apiGroup meeting 4 * @apiGroup meeting
5 * @apiVersion 1.6.0 5 * @apiVersion 1.6.0
@@ -83,10 +83,85 @@ @@ -83,10 +83,85 @@
83 */ 83 */
84 84
85 /** 85 /**
86 - * @api {post} /3m/meeting/join_mtg_app.do 4.app获取课堂信息 86 + * @api {post} /3m/meeting/join_mtg_app.do 04.app获取课堂信息
87 * @apiName joinClassApp 87 * @apiName joinClassApp
88 * @apiGroup meeting 88 * @apiGroup meeting
89 * @apiVersion 2.0.0 89 * @apiVersion 2.0.0
90 - * @apiDeprecated 请使用 /3m/meeting/join_mtg.do  
91 - * @apiDescription app获取课堂信息 90 + * @apiDescription app获取课堂信息,如果课堂不存在，先创建该课堂
  91 + *
  92 + * @apiParam {String} siteId 站点标识
  93 + * @apiParam {String} mtgKey 课堂的唯一标识。最大长度 64
  94 + * @apiParam {String} mtgTitle 课堂名称或者课堂主题，最大长度 32
  95 + * @apiParam {String} startTime 课堂的开始时间，作为课堂开始气泡提示的参考时间。格式为：YYYY-MM-DD HH:MM:SS
  96 + * @apiParam {String} endTime 课堂的结束时间，作为课堂结束气泡提示的参考时间。格式为：YYYY-MM-DD HH:MM:SS
  97 + * @apiParam {int} [language=2] 客户端语言：1 英文， 2 中文
  98 + * @apiParam {String} userName 客户端显示的姓名，最大长度 32
  99 + * @apiParam {String} userId 英文或数字组成的字符串，最大长度 50。等于0时是匿名用户，可以允许多个用户同时存在
  100 + * @apiParam {int} userType 用户类型： 8 普通与会者
  101 + * @apiParam {String} hostPwd 主持人密码，密码长度 6 到 8 位，用于对普通人员申请主持人时的验证
  102 + * @apiParam {Long} timestamp 时间戳
  103 + * @apiParam {String} authId MD5(key+siteId+mtgKey+userID+userType+timestamp), 其中 key 为与系统约定的加密 key
  104 + *
  105 + * @apiSuccess {int} errorCode
  106 + * 0：正常 <br/>
  107 + * 1：siteId 错误，站点不存在或已删除 <br/>
  108 + * 2：站点未到生效日期 <br/>
  109 + * 3: 站点过期 <br/>
  110 + * 4：课堂信息 mtgKey/mtgTitle/hostPwd 不能为空 <br/>
  111 + * 5：用户信息 userName/userId/userType 不能为空 <br/>
  112 + * 6：timestamp 超时 <br/>
  113 + * 7：authId 错误 <br/>
  114 + * 8：authId 不能重复使用 <br/>
  115 + * 9：课堂开始或结束时间格式错误 <br/>
  116 + * 10：报文格式错误 <br/>
  117 + * @apiSuccess {String} url 课堂地址
  118 + * @apiSuccess {String} param
  119 + * @apiSuccess {String} siteId
  120 + * @apiSuccess {String} classID 课堂 id
  121 + * @apiSuccess {String} userName
  122 + * @apiSuccess {String} userId
  123 + * @apiSuccess {String} userType
  124 + * @apiSuccess {String} nopassword 是否需要验证密码 False:不需要验证 True: 需要验证
  125 + * @apiSuccess {String} portalIP 服务器ip
  126 + * @apiSuccess {String} portalPort 服务器端口
  127 + * @apiSuccess {String} md5 返回的md5
  128 + * @apiSuccess {String} meetingNumber 学点云系统生成的课堂号
  129 + * @apiSuccess {Long} timestamp 时间戳
  130 + *
  131 + * @apiParamExample {xml} 请求示例
  132 + &lt;param&gt;
  133 + &lt;siteId&gt;shanghai&lt;/siteId&gt;
  134 + &lt;mtgKey&gt;100012&lt;/mtgKey&gt;
  135 + &lt;mtgTitle&gt;shanghai&lt;/mtgTitle&gt;
  136 + &lt;startTime&gt;2015-08-12 14:00:00&lt;/startTime&gt;
  137 + &lt;endTime&gt;2015-08-12 14:30:00&lt;/endTime&gt;
  138 + &lt;language&gt;1&lt;/language&gt;
  139 + &lt;userName&gt;shanghai&lt;/userName&gt;
  140 + &lt;userId&gt;2000012&lt;/userId&gt;
  141 + &lt;userType&gt;8&lt;/userType&gt;
  142 + &lt;hostPwd&gt;123456&lt;/hostPwd&gt;
  143 + &lt;timestamp&gt;1392032123210&lt;/timestamp&gt;
  144 + &lt;authId&gt;4297f44b13955235245b2497399d7a93&lt;/authId&gt;
  145 + &lt;/param&gt;
  146 + *
  147 + * @apiSuccessExample {xml} 返回示例
  148 + &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  149 + &lt;result&gt;
  150 + &lt;errorCode&gt;01&lt;/errorCode&gt;
  151 + &lt;url&gt;http://127.0.0.1:8080/LiveClass/tests/joinClass/index.jsp&lt;/url&gt;
  152 + &lt;param&gt;
  153 + &lt;siteId&gt;admin&lt;/siteId&gt;
  154 + &lt;classID&gt;1419338704&lt;/classID&gt;
  155 + &lt;userName&gt;shanghai&lt;/userName&gt;
  156 + &lt;userId&gt;2000012&lt;/userId&gt;
  157 + &lt;nopassword&gt;false&lt;/nopassword&gt;
  158 + &lt;userType&gt;8&lt;/userType&gt;
  159 + &lt;portalIP&gt;127.0.0.1&lt;/portalIP&gt;
  160 + &lt;portalPort&gt;8080&lt;/portalPort&gt;
  161 + &lt;md5&gt;790a9c17892e99c89d6bef2cb1b5d2e6&lt;/md5&gt;
  162 + &lt;/param&gt;
  163 + &lt;timestamp&gt;1447815907543&lt;/timestamp&gt;
  164 + &lt;meetingNumber&gt;1419338704&lt;/meetingNumber&gt;
  165 + &lt;/result&gt;
  166 + * 获取到param下的参数传给学点云app
92 */ 167 */
1 /** 1 /**
2 - * @api {post} /3m/meeting/join_class_h5_foreign.do 3.获取h5页面课堂地址 2 + * @api {post} /3m/meeting/join_class_h5_foreign.do 03.获取h5页面课堂地址
3 * @apiName joinClassH5 3 * @apiName joinClassH5
4 * @apiGroup meeting 4 * @apiGroup meeting
5 * @apiVersion 1.6.0 5 * @apiVersion 1.6.0
@@ -34,16 +34,7 @@ @@ -34,16 +34,7 @@
34 * 10：报文格式错误 <br/> 34 * 10：报文格式错误 <br/>
35 * 11: 该课堂没有开启h5 35 * 11: 该课堂没有开启h5
36 * @apiSuccess {String} url 课堂地址 36 * @apiSuccess {String} url 课堂地址
37 - * @apiSuccess {String} param  
38 - * @apiSuccess {String} siteId  
39 - * @apiSuccess {String} classID 课堂 id  
40 - * @apiSuccess {String} userName  
41 - * @apiSuccess {String} userId  
42 - * @apiSuccess {String} userType  
43 - * @apiSuccess {String} nopassword 是否需要验证密码 False:不需要验证 True: 需要验证  
44 - * @apiSuccess {String} portalIP 服务器ip  
45 - * @apiSuccess {String} portalPort 服务器端口  
46 - * @apiSuccess {String} md5 返回的md5 37 + * @apiSuccess {String} param 请将该节点下所有参数都拼接到url后面
47 * @apiSuccess {String} meetingNumber 学点云系统生成的课堂号 38 * @apiSuccess {String} meetingNumber 学点云系统生成的课堂号
48 * @apiSuccess {Long} timestamp 时间戳 39 * @apiSuccess {Long} timestamp 时间戳
49 * 40 *
@@ -85,14 +76,86 @@ @@ -85,14 +76,86 @@
85 &lt;timestamp&gt;1447815907543&lt;/timestamp&gt; 76 &lt;timestamp&gt;1447815907543&lt;/timestamp&gt;
86 &lt;meetingNumber&gt;1419338704&lt;/meetingNumber&gt; 77 &lt;meetingNumber&gt;1419338704&lt;/meetingNumber&gt;
87 &lt;/result&gt; 78 &lt;/result&gt;
88 - * 得到地址拼接跳转：http://127.0.0.1:8080/LiveClass/tests/joinClass/index.jsp?siteId=admin&userName=shanghai&userId=11111&userType=8&nopassword=false&classID=2043575585&portalIP=127.0.0.1&portalPort=8080&md5= 86e2b69e2919fb9592025f37f84f5066 79 + 地址拼接：http://127.0.0.1:8080/LiveClass/tests/joinClass/index.jsp?siteId=admin&classID=2043575585&userName=shanghai&userId=11111&userType=8&nopassword=false&portalIP=127.0.0.1&portalPort=8080&md5= 86e2b69e2919fb9592025f37f84f5066
89 */ 80 */
90 81
91 /** 82 /**
92 - * @api {post} /3m/meeting/join_class_h5_foreign.do 3.获取h5页面课堂地址 83 + * @api {post} /3m/meeting/join_class_h5_foreign.do 03.获取h5页面课堂地址
93 * @apiName joinClassH5 84 * @apiName joinClassH5
94 * @apiGroup meeting 85 * @apiGroup meeting
95 * @apiVersion 2.0.0 86 * @apiVersion 2.0.0
96 - * @apiDeprecated 请使用 /3m/meeting/join_mtg.do  
97 * @apiDescription 获取h5页面课堂地址 87 * @apiDescription 获取h5页面课堂地址
  88 + *
  89 + * @apiParam {String} siteId 站点标识
  90 + * @apiParam {String} mtgKey 课堂的唯一标识。最大长度 64
  91 + * @apiParam {String} mtgTitle 课堂名称或者课堂主题，最大长度 32
  92 + * @apiParam {String} startTime 课堂的开始时间，作为课堂开始气泡提示的参考时间。格式为：YYYY-MM-DD HH:MM:SS
  93 + * @apiParam {String} endTime 课堂的结束时间，作为课堂结束气泡提示的参考时间。格式为：YYYY-MM-DD HH:MM:SS
  94 + * @apiParam {int} [language=2] 客户端语言：1 英文， 2 中文
  95 + * @apiParam {String} userName 客户端显示的姓名，最大长度 32
  96 + * @apiParam {String} userId 英文或数字组成的字符串，最大长度 50。等于0时是匿名用户，可以允许多个用户同时存在
  97 + * @apiParam {int} userType 用户类型： 8 普通与会者
  98 + * @apiParam {int} [meetingType=1] 1 互动 支持多人音视频，适用于小班授课 2 直播 适用于千人以上大课堂，不能进行音视频互动，支持H5网页观看
  99 + * @apiParam {String} hostPwd 主持人密码，密码长度 6 到 8 位，用于对普通人员申请主持人时的验证
  100 + * @apiParam {Long} timestamp 时间戳
  101 + * @apiParam {int} [h5Module] 是否启用 H5：1 启用，其它禁止。仅当站点开启 H5 功能时有效
  102 + * @apiParam {String} authId MD5(key+siteId+mtgKey+userID+userType+timestamp), 其中 key 为与系统约定的加密 key
  103 + *
  104 + * @apiSuccess {int} errorCode
  105 + * 0：正常 <br/>
  106 + * 1：siteId 错误，站点不存在或已删除 <br/>
  107 + * 2：站点未到生效日期 <br/>
  108 + * 3: 站点过期 <br/>
  109 + * 4：课堂信息 mtgKey/mtgTitle/hostPwd 不能为空 <br/>
  110 + * 5：用户信息 userName/userId/userType 不能为空 <br/>
  111 + * 6：timestamp 超时 <br/>
  112 + * 7：authId 错误 <br/>
  113 + * 8：authId 不能重复使用 <br/>
  114 + * 9：课堂开始或结束时间格式错误 <br/>
  115 + * 10：报文格式错误 <br/>
  116 + * 11: 该课堂没有开启h5
  117 + * @apiSuccess {String} url 课堂地址
  118 + * @apiSuccess {String} param 请将该节点下所有参数都拼接到url后面
  119 + * @apiSuccess {String} meetingNumber 学点云系统生成的课堂号
  120 + * @apiSuccess {Long} timestamp 时间戳
  121 + *
  122 + * @apiParamExample {xml} 请求示例
  123 + &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  124 + &lt;param&gt;
  125 + &lt;siteId&gt;shanghai&lt;/siteId&gt;
  126 + &lt;mtgKey&gt;100012&lt;/mtgKey&gt;
  127 + &lt;mtgTitle&gt;shanghai&lt;/mtgTitle&gt;
  128 + &lt;startTime&gt;2015-08-12 14:00:00&lt;/startTime&gt;
  129 + &lt;endTime&gt;2015-08-12 14:30:00&lt;/endTime&gt;
  130 + &lt;language&gt;1&lt;/language&gt;
  131 + &lt;userName&gt;shanghai&lt;/userName&gt;
  132 + &lt;userId&gt;2000012&lt;/userId&gt;
  133 + &lt;userType&gt;8&lt;/userType&gt;
  134 + &lt;meetingType&gt;1&lt;/meetingType&gt;
  135 + &lt;h5Module&gt;1&lt;/h5Module&gt;
  136 + &lt;hostPwd&gt;123456&lt;/hostPwd&gt;
  137 + &lt;timestamp&gt;1392032123210&lt;/timestamp&gt;
  138 + &lt;authId&gt;4297f44b13955235245b2497399d7a93&lt;/authId&gt;
  139 + &lt;/param&gt;
  140 + *
  141 + * @apiSuccessExample {xml} 返回示例
  142 + &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  143 + &lt;result&gt;
  144 + &lt;errorCode&gt;0&lt;/errorCode&gt;
  145 + &lt;url&gt;http://127.0.0.1:8080/LiveClass/tests/joinClass/index.jsp&lt;/url&gt;
  146 + &lt;param&gt;
  147 + &lt;siteId&gt;admin&lt;/siteId&gt;
  148 + &lt;classID&gt;1419338704&lt;/classID&gt;
  149 + &lt;userName&gt;shanghai&lt;/userName&gt;
  150 + &lt;userId&gt;2000012&lt;/userId&gt;
  151 + &lt;nopassword&gt;false&lt;/nopassword&gt;
  152 + &lt;userType&gt;8&lt;/userType&gt;
  153 + &lt;portalIP&gt;127.0.0.1&lt;/portalIP&gt;
  154 + &lt;portalPort&gt;8080&lt;/portalPort&gt;
  155 + &lt;md5&gt;790a9c17892e99c89d6bef2cb1b5d2e6&lt;/md5&gt;
  156 + &lt;/param&gt;
  157 + &lt;timestamp&gt;1447815907543&lt;/timestamp&gt;
  158 + &lt;meetingNumber&gt;1419338704&lt;/meetingNumber&gt;
  159 + &lt;/result&gt;
  160 + 地址拼接：http://127.0.0.1:8080/LiveClass/tests/joinClass/index.jsp?siteId=admin&classID=2043575585&userName=shanghai&userId=11111&userType=8&nopassword=false&portalIP=127.0.0.1&portalPort=8080&md5=
98 */ 161 */
1 /** 1 /**
2 - * @api {post} /3m/meeting/join_mtg.do 2.获取课堂地址 2 + * @api {post} /3m/meeting/join_mtg.do 02.获取课堂地址
3 * @apiName joinMtg 3 * @apiName joinMtg
4 * @apiGroup meeting 4 * @apiGroup meeting
5 * @apiVersion 1.6.0 5 * @apiVersion 1.6.0
1 /** 1 /**
2 - * @api {post} /3m/meeting/license.do 8.查询站点剩余点数 2 + * @api {post} /3m/meeting/license.do 08.查询站点剩余点数
3 * @apiName license 3 * @apiName license
4 * @apiGroup site 4 * @apiGroup site
5 * @apiVersion 1.6.0 5 * @apiVersion 1.6.0
1 /** 1 /**
2 - * @api {post} /3m/meeting/set_assistance.do 15 设置课堂的求助信息 2 + * @api {post} /3m/meeting/set_assistance.do 15.设置课堂的求助信息
3 * @apiName set_assistance 3 * @apiName set_assistance
4 * @apiGroup meeting 4 * @apiGroup meeting
5 * @apiVersion 1.6.0 5 * @apiVersion 1.6.0
1 /** 1 /**
2 - * @api {GET} /3m/meeting/timestamp.do 1.获取服务器时间戳 2 + * @api {GET} /3m/meeting/timestamp.do 01.获取服务器时间戳
3 * @apiName getTimestamp 3 * @apiName getTimestamp
4 * @apiGroup other 4 * @apiGroup other
5 * @apiVersion 1.6.0 5 * @apiVersion 1.6.0