李鹏 / api-doc

转到一个项目
Toggle navigation Toggle navigation pinning
tanyatang
d720b264 1 parent 149d053a

删除已经不用的接口。

内嵌 并排对比
正在显示 1 个修改的文件 包含 0 行增加 和 161 行删除
1 -/**  
2 - * @api {post} /3m/meeting/join_class_h5_foreign.do 03.获取h5页面课堂地址  
3 - * @apiName joinClassH5  
4 - * @apiGroup meeting  
5 - * @apiVersion 1.6.0  
6 - * @apiDescription 获取h5页面课堂地址，如果课堂不存在，先创建该课堂  
7 - *  
8 - * @apiParam {String} siteId 站点标识  
9 - * @apiParam {String} mtgKey 课堂的唯一标识。最大长度 64  
10 - * @apiParam {String} mtgTitle 课堂名称或者课堂主题，最大长度 32  
11 - * @apiParam {String} startTime 课堂的开始时间，作为课堂开始气泡提示的参考时间。格式为：YYYY-MM-DD HH:MM:SS  
12 - * @apiParam {String} endTime 课堂的结束时间，作为课堂结束气泡提示的参考时间。格式为：YYYY-MM-DD HH:MM:SS  
13 - * @apiParam {int} [language=2] 客户端语言：1 英文， 2 中文  
14 - * @apiParam {String} userName 客户端显示的姓名，最大长度 32  
15 - * @apiParam {String} userId 英文或数字组成的字符串，最大长度 50。等于0时是匿名用户，可以允许多个用户同时存在  
16 - * @apiParam {int} userType 用户类型： 8 普通与会者  
17 - * @apiParam {int} [meetingType=1] 1 互动 支持多人音视频，适用于小班授课 2 直播 适用于千人以上大课堂，不能进行音视频互动，支持H5网页观看  
18 - * @apiParam {String} hostPwd 主持人密码，密码长度 6 到 8 位，用于对普通人员申请主持人时的验证  
19 - * @apiParam {Long} timestamp 时间戳  
20 - * @apiParam {int} [h5Module] 是否启用 H5：1 启用，其它禁止。仅当站点开启 H5 功能时有效  
21 - * @apiParam {String} authId MD5(key+siteId+mtgKey+userID+userType+timestamp), 其中 key 为与系统约定的加密 key  
22 - *  
23 - * @apiSuccess {int} errorCode  
24 - * 0：正常 <br/>  
25 - * 1：siteId 错误，站点不存在或已删除 <br/>  
26 - * 2：站点未到生效日期 <br/>  
27 - * 3: 站点过期 <br/>  
28 - * 4：课堂信息 mtgKey/mtgTitle/hostPwd 不能为空 <br/>  
29 - * 5：用户信息 userName/userId/userType 不能为空 <br/>  
30 - * 6：timestamp 超时 <br/>  
31 - * 7：authId 错误 <br/>  
32 - * 8：authId 不能重复使用 <br/>  
33 - * 9：课堂开始或结束时间格式错误 <br/>  
34 - * 10：报文格式错误 <br/>  
35 - * 11: 该课堂没有开启h5  
36 - * @apiSuccess {String} url 课堂地址  
37 - * @apiSuccess {String} param 请将该节点下所有参数都拼接到url后面  
38 - * @apiSuccess {String} meetingNumber 学点云系统生成的课堂号  
39 - * @apiSuccess {Long} timestamp 时间戳  
40 - *  
41 - * @apiParamExample {xml} 请求示例  
42 - &lt;?xml version="1.0" encoding="UTF-8"?&gt;  
43 - &lt;param&gt;  
44 - &lt;siteId&gt;shanghai&lt;/siteId&gt;  
45 - &lt;mtgKey&gt;100012&lt;/mtgKey&gt;  
46 - &lt;mtgTitle&gt;shanghai&lt;/mtgTitle&gt;  
47 - &lt;startTime&gt;2015-08-12 14:00:00&lt;/startTime&gt;  
48 - &lt;endTime&gt;2015-08-12 14:30:00&lt;/endTime&gt;  
49 - &lt;language&gt;1&lt;/language&gt;  
50 - &lt;userName&gt;shanghai&lt;/userName&gt;  
51 - &lt;userId&gt;2000012&lt;/userId&gt;  
52 - &lt;userType&gt;8&lt;/userType&gt;  
53 - &lt;meetingType&gt;1&lt;/meetingType&gt;  
54 - &lt;h5Module&gt;1&lt;/h5Module&gt;  
55 - &lt;hostPwd&gt;123456&lt;/hostPwd&gt;  
56 - &lt;timestamp&gt;1392032123210&lt;/timestamp&gt;  
57 - &lt;authId&gt;4297f44b13955235245b2497399d7a93&lt;/authId&gt;  
58 - &lt;/param&gt;  
59 - *  
60 - * @apiSuccessExample {xml} 返回示例  
61 - &lt;?xml version="1.0" encoding="UTF-8"?&gt;  
62 - &lt;result&gt;  
63 - &lt;errorCode&gt;0&lt;/errorCode&gt;  
64 - &lt;url&gt;http://127.0.0.1:8080/LiveClass/tests/joinClass/index.jsp&lt;/url&gt;  
65 - &lt;param&gt;  
66 - &lt;siteId&gt;admin&lt;/siteId&gt;  
67 - &lt;classID&gt;1419338704&lt;/classID&gt;  
68 - &lt;userName&gt;shanghai&lt;/userName&gt;  
69 - &lt;userId&gt;2000012&lt;/userId&gt;  
70 - &lt;nopassword&gt;false&lt;/nopassword&gt;  
71 - &lt;userType&gt;8&lt;/userType&gt;  
72 - &lt;portalIP&gt;127.0.0.1&lt;/portalIP&gt;  
73 - &lt;portalPort&gt;8080&lt;/portalPort&gt;  
74 - &lt;md5&gt;790a9c17892e99c89d6bef2cb1b5d2e6&lt;/md5&gt;  
75 - &lt;/param&gt;  
76 - &lt;timestamp&gt;1447815907543&lt;/timestamp&gt;  
77 - &lt;meetingNumber&gt;1419338704&lt;/meetingNumber&gt;  
78 - &lt;/result&gt;  
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  
80 - */  
81 -  
82 -/**  
83 - * @api {post} /3m/meeting/join_class_h5_foreign.do 03.获取h5页面课堂地址  
84 - * @apiName joinClassH5  
85 - * @apiGroup meeting  
86 - * @apiVersion 2.0.0  
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=  
161 - */