正在显示
2 个修改的文件
包含
59 行增加
和
0 行删除
src/find_shared_media.js
0 → 100644
| 1 | +/** | ||
| 2 | + * @api {post} /3m/api/sharedMedia/findBySite.do 32.查询站点的媒体共享列表 | ||
| 3 | + * @apiName sharedMedia_findBySite | ||
| 4 | + * @apiGroup doc | ||
| 5 | + * @apiVersion 2.1.0 | ||
| 6 | + * @apiDescription 查询站点的媒体共享列表 | ||
| 7 | + * | ||
| 8 | + * @apiParam {String} siteId 站点标识 | ||
| 9 | + * @apiParam {Long} timestamp 时间戳 | ||
| 10 | + * @apiParam {String} authId MD5(key+siteId+timestamp), 其中 key 为与系统约定的加密 key | ||
| 11 | + * @apiParam {String} beginTime 开始日期。格式:YYYY-MM-DD HH:MM:SS | ||
| 12 | + * @apiParam {String} endTime 结束日期。格式:YYYY-MM-DD HH:MM:SS | ||
| 13 | + * @apiParam {String} [name] 文档名称 | ||
| 14 | + * | ||
| 15 | + * @apiParamExample {xml} 请求示例 | ||
| 16 | + <?xml version="1.0" encoding="UTF-8"?> | ||
| 17 | + <param> | ||
| 18 | + <siteId>admin</siteId> | ||
| 19 | + <beginTime>2017-02-01 00:00:00</beginTime> | ||
| 20 | + <endTime>2017-02-22 00:00:00</endTime> | ||
| 21 | + <name></name> | ||
| 22 | + <timestamp>1487756351064</timestamp> | ||
| 23 | + <authId>6f584b3a816c1405107ddd657e95292b</authId> | ||
| 24 | + </param> | ||
| 25 | + * | ||
| 26 | + * @apiSuccess {int} errorCode | ||
| 27 | + * 0:正常 <br/> | ||
| 28 | + * 1:siteId 错误 <br/> | ||
| 29 | + * 2:站点未到生效日期 <br/> | ||
| 30 | + * 3:站点过期 <br/> | ||
| 31 | + * 4:authId 错误 <br/> | ||
| 32 | + * 5:authId 不能重复使用 <br/> | ||
| 33 | + * 6:timestamp 超时 <br/> | ||
| 34 | + * 10:报文格式错误 <br/> | ||
| 35 | + * @apiSuccess {Array} mediaList | ||
| 36 | + * @apiSuccess {Object} mediaList.media | ||
| 37 | + * @apiSuccess {String} mediaList.media.id 文件 id | ||
| 38 | + * @apiSuccess {String} mediaList.media.name 文件名称 | ||
| 39 | + * @apiSuccess {String} mediaList.media.userName 上传者用户名 | ||
| 40 | + * @apiSuccess {String} mediaList.media.startTime 上传开始时间 | ||
| 41 | + * @apiSuccess {String} mediaList.media.endTime 上传结束时间 | ||
| 42 | + * | ||
| 43 | + * @apiSuccessExample {xml} 返回示例 | ||
| 44 | + <?xml version=“1.0” encoding="UTF-8"?> | ||
| 45 | + <result> | ||
| 46 | + <errorCode>0</errorCode> | ||
| 47 | + <mediaList> | ||
| 48 | + <media> | ||
| 49 | + <id>3</id> | ||
| 50 | + <name>123.mp3</name> | ||
| 51 | + <userName>somebody</userName> | ||
| 52 | + <startTime>2013-09-11 14:02:05</startTime> | ||
| 53 | + <endTime>2013-09-11 14:15:47</endTime> | ||
| 54 | + </media> | ||
| 55 | + </mediaList > | ||
| 56 | + </result> | ||
| 57 | + * | ||
| 58 | + */ |
| @@ -19,6 +19,7 @@ | @@ -19,6 +19,7 @@ | ||
| 19 | * @apiParam {String} hostPwd 主持人密码,密码长度 6 到 8 位,用于对普通人员申请主持人时的验证 | 19 | * @apiParam {String} hostPwd 主持人密码,密码长度 6 到 8 位,用于对普通人员申请主持人时的验证 |
| 20 | * @apiParam {String} docID 文档唯一标识。多个文档标识用英文逗号分隔。文档标识通过查询文档列表接口获取 | 20 | * @apiParam {String} docID 文档唯一标识。多个文档标识用英文逗号分隔。文档标识通过查询文档列表接口获取 |
| 21 | * @apiParam {String} mediaID 伴音唯一标识。多个标识用英文逗号分隔。标识通过查询伴音列表接口获取 | 21 | * @apiParam {String} mediaID 伴音唯一标识。多个标识用英文逗号分隔。标识通过查询伴音列表接口获取 |
| 22 | + * @apiParam {String} sharedMediaID 媒体共享文件唯一标识。多个标识用英文逗号分隔。标识通过查询媒体共享文件接口获取 | ||
| 22 | * @apiParam {String} [backUrl] 课堂结束后的回调地址 | 23 | * @apiParam {String} [backUrl] 课堂结束后的回调地址 |
| 23 | * @apiParam {Long} timestamp 时间戳 | 24 | * @apiParam {Long} timestamp 时间戳 |
| 24 | * @apiParam {int} [docModule] 是否启用文档共享:1 启用,其它禁止。默认为站点默认值 | 25 | * @apiParam {int} [docModule] 是否启用文档共享:1 启用,其它禁止。默认为站点默认值 |
-
请 注册 或 登录 后发表评论