lipengjava

add doc: apply_test_site.js

  1 +/**
  2 + * @api {post} /3m/meeting/apply_test_site.do 17.申请创建试用站点
  3 + * @apiName apply_test_site
  4 + * @apiGroup site
  5 + * @apiVersion 1.6.0
  6 + * @apiDescription 申请创建试用站点
  7 + *
  8 + * @apiParam {String} siteId 站点标识
  9 + * @apiParam {String} parentSiteId 所属站点标识
  10 + * @apiParam {String} beginTime 站点启用日期 yyyy-mm-dd
  11 + * @apiParam {int} stype=0 产品授权方式: 0 试用用户, 1 正式用户
  12 + * @apiParam {String} [password] 站点管理员的密码,不填时随机生成
  13 + * @apiParam {String} email 申请人邮箱
  14 + * @apiParam {Long} timestamp 时间戳
  15 + * @apiParam {String} authId MD5(key+parentSiteId+timestamp), 其中 key 为与系统约定的加密 key
  16 + *
  17 + * @apiSuccess {int} errorCode
  18 + * 0:正常 <br/>
  19 + * 1:所属站点不存在或已删除 <br/>
  20 + * 2:所属站点未到生效日期 <br/>
  21 + * 3: 所属站点过期 <br/>
  22 + * 4:authId 错误 <br/>
  23 + * 5:authId 不能重复使用 <br/>
  24 + * 6:timestamp 超时 <br/>
  25 + * 7:站点模板不存在 <br/>
  26 + * 8:siteId已存在 <br/>
  27 + * 9:siteId 不能为空 <br/>
  28 + * 10:parentSiteId 不能为空 <br/>
  29 + * 11:timestamp 不能为空 <br/>
  30 + * 12:authId 不能为空 <br/>
  31 + * 13:beginTime 不能为空 <br/>
  32 + * 14:email 不能为空 <br/>
  33 + * 15:email 格式不正确 <br/>
  34 + * 16:beginTime 格式不正确 <br/>
  35 + * 17:stype 不能为空 <br/>
  36 + * 18:stype 格式不正确 <br/>
  37 + * @apiSuccess {String} msg 错误信息
  38 + * @apiSuccess {Object} data 详细信息
  39 + * @apiSuccess {String} data.siteId 站点标识
  40 + * @apiSuccess {String} data.siteKey 站点 Key
  41 + * @apiSuccess {String} data.username 站点管理员用户名
  42 + * @apiSuccess {String} data.password 站点管理员密码
  43 + *
  44 + * @apiParamExample {xml} 请求示例
  45 + &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  46 + &lt;param&gt;
  47 + &lt;siteId&gt;childSite&lt;/siteId&gt;
  48 + &lt;parentSiteId&gt;parent&lt;/parentSiteId&gt;
  49 + &lt;timestamp&gt;111&lt;/timestamp&gt;
  50 + &lt;authId&gt;111&lt;/authId&gt;
  51 + &lt;beginTime&gt;2016-01-01&lt;/beginTime&gt;
  52 + &lt;stype&gt;1&lt;/stype&gt;
  53 + &lt;email&gt;xxx@yyy.com&lt;/email&gt;
  54 + &lt;/param&gt;
  55 + *
  56 + * @apiSuccessExample {xml} 返回示例
  57 + &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  58 + &lt;result&gt;
  59 + &lt;errcode&gt;0&lt;/errcode&gt;
  60 + &lt;msg&gt;操作成功&lt;/msg&gt;
  61 + &lt;data&gt;
  62 + &lt;siteid&gt;ceshi3&lt;/siteid&gt;
  63 + &lt;sitekey&gt;297e92ae4e2af258014e2af258ac0000&lt;/sitekey&gt;
  64 + &lt;username&gt;admin&lt;/username&gt;
  65 + &lt;password&gt;admin&lt;/password&gt;
  66 + &lt;/data&gt;
  67 + &lt;/result&gt;
  68 + *
  69 + */