手游冲级活动-1.0.0
<p>[TOC]</p>
<h2>修订记录</h2>
<table>
<thead>
<tr>
<th style="text-align: left;">版本</th>
<th style="text-align: left;">日期</th>
<th style="text-align: left;">操作内容</th>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">v1.0.2</td>
<td style="text-align: left;">20181102</td>
<td style="text-align: left;">修改（秦露）</td>
<td style="text-align: left;">接口2新增：AppPkg<br/></td>
</tr>
<tr>
<td style="text-align: left;">v1.0.1</td>
<td style="text-align: left;">20181026</td>
<td style="text-align: left;">新增（秦露）</td>
<td style="text-align: left;">接口1新增：UserAwardStatus<br/> //用户对该奖品的领取状态： 1可以领取；2已经领取；3不可领取</td>
</tr>
<tr>
<td style="text-align: left;">v1.0.0</td>
<td style="text-align: left;">20181022</td>
<td style="text-align: left;">修改（杜月姣）</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">v1.0.0</td>
<td style="text-align: left;">20181019</td>
<td style="text-align: left;">创建（梁亚杰、秦露）</td>
<td style="text-align: left;">-</td>
</tr>
</tbody>
</table>
<h2>接口文档维护者（前端 秦露）</h2>
<h2>接口约定</h2>
<h3>通用约定</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">名称</th>
<th style="text-align: left;">内容</th>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">协议</td>
<td style="text-align: left;">支持HTTPS/HTTP</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">接口地址</td>
<td style="text-align: left;">开发版：<a href="http://lykf.admin.ct108.org:1506">http://lykf.admin.ct108.org:1506</a><br>提测版：<a href="http://lykf.admin.ct108.org:1507">http://lykf.admin.ct108.org:1507</a> <br>稳定版：<a href="http://lykf.admin.ct108.org:1505/">http://lykf.admin.ct108.org:1505/</a><br> 正式版：<a href="http://lykf.admin.ct108.com/">http://lykf.admin.ct108.com/</a> <br>预发版：<a href="http://lykf.admin.ct108.org:2505">http://lykf.admin.ct108.org:2505</a></td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">Header</td>
<td style="text-align: left;">认证字段：AppKey</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">Content-Type</td>
<td style="text-align: left;">application/json;charset=utf-8</td>
<td style="text-align: left;">-</td>
</tr>
</tbody>
</table>
<h3>通用Code值</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">代号区间</th>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">10000-19999</td>
<td style="text-align: left;">系统通用错误</td>
</tr>
<tr>
<td style="text-align: left;">20000-29999</td>
<td style="text-align: left;">业务错误</td>
</tr>
</tbody>
</table>
<h2>系统通用错误</h2>
<table>
<thead>
<tr>
<th style="text-align: left;">code</th>
<th style="text-align: left;">说明</th>
<th>客户端提示信息</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">0</td>
<td style="text-align: left;">成功</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">10001</td>
<td style="text-align: left;"> 未登录</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">101</td>
<td style="text-align: left;">活动未开始</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">102</td>
<td style="text-align: left;">活动已结束</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">103</td>
<td style="text-align: left;">活动被禁用</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">201</td>
<td style="text-align: left;">等级不够</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">202</td>
<td style="text-align: left;">已领取奖励</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">203</td>
<td style="text-align: left;">库存不足</td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<h2>业务错误（例如活动项目）</h2>
<ul>
<li>
<p>20001-20099 活动错误</p>
</li>
<li>
<p>20101-20199 请求错误</p>
</li>
<li>20201-20299 用户错误</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">code</th>
<th style="text-align: left;">说明</th>
<th>客户端提示信息</th>
</tr>
</thead>
<tbody>
</tbody>
</table>
<h3>常量</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">常量</th>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
</tbody>
</table>
<h2>公共接口</h2>
<h3>接口1:获取活动初始化信息</h3>
<p><strong>简要描述：</strong> </p>
<ul>
<li>获取活动初始化信息 </li>
</ul>
<p><strong>请求url：</strong> </p>
<ul>
<li>/api/activity/getinit</li>
</ul>
<p><strong>请求方式：</strong> </p>
<ul>
<li><code>get</code></li>
</ul>
<p><strong>适用版本：</strong> </p>
<ul>
<li><code>1.0.0</code></li>
</ul>
<p><strong>请求参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必选</th>
<th>默认值</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>ActivityId</td>
<td>long</td>
<td>是</td>
<td></td>
<td>活动Id</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求示例：</strong></p>
<pre><code>{
"ActivityId": 111 //活动Id
}</code></pre>
<p><strong>返回参数：</strong>
<code>下边的 > 这个符号是表明层级关系的</code></p>
<table>
<thead>
<tr>
<th style="text-align: left;">名称</th>
<th style="text-align: left;">类型</th>
<th style="text-align: left;">说明</th>
<th style="text-align: left;">限制长度说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">> ActivityInfo</td>
<td style="text-align: left;">array</td>
<td style="text-align: left;">活动信息</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">ActivityNumber</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">序号：后台排序的序号。<br/>切记按序号从小到大返回</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">Id</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">子活动id</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">ActivityType</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">类型：1冲级活动，2图文活动</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">ActivityName</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">活动名称</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">BeginUnixTime</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">活动开始时间（时间戳）</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">EndUnixTime</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">活动结束时间（时间戳）</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">>> ActivityConfig</td>
<td style="text-align: left;">object</td>
<td style="text-align: left;">对象：配置的信息</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">SubActivityImgForVertical</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">背景图竖版 路径</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">SubActivityImgForHorizontal</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">活动标题图 横版（图文活动为活动图）</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">>>> Award</td>
<td style="text-align: left;">array</td>
<td style="text-align: left;">奖品</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">AwardId</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">奖品id</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">AwardImgForVertical</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">背景图竖版 路径</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">AwardImgForHorizontal</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">背景图横版 路径</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">AwardName</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">奖品名</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">LimitLevel</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">等级</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">AwardCount</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">剩余份数</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">UserAwardStatus</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">用户领取奖励的状态值<br/> 1可以领取；2已经领取；3不可领取</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">> head</td>
<td style="text-align: left;">object</td>
<td style="text-align: left;">头部区域</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">BGImgForVertical</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">背景图竖版 路径</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">BGImgForHorizontal</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">活动标题图 横版（图文活动为活动图）</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">ServerIdMin</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">开始服</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">ServerIdMax</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">结束服</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">> BGColor</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">皮肤：1，2，3，4取这其中 一个值</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">> ActivityRule</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">规则内容</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">> AppCode</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">游戏缩写</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">> AppName</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">游戏名</td>
<td style="text-align: left;">-</td>
</tr>
</tbody>
</table>
<p><strong>返回示例：</strong></p>
<pre><code>{
"Code": 0,
"Data": {
"ActivityInfo": [
{
"ActivityNumber": 1, // 序号
"Id": 203, // 子活动id
"ActivityType": 1, //类型：1冲级活动
"ActivityName": "冲级活动1", // 活动名称
"BeginUnixTime": 1539933773766, // 活动开始时间（时间戳）
"EndUnixTime": 1539934000074, // 活动结束时间（时间戳）
"ActivityConfig": {
"SubActivityImgForVertical": "", //背景图：冲级活动头部的横板图
"SubActivityImgForHorizontal": "", //背景图：冲级活动头部的竖版图
"Award":[{ //奖品：冲级活动至少一个奖品，最多10个奖品
"AwardId":1, //奖品id
"AwardImgForVertical": "", //奖品竖图
"AwardImgForHorizontal": "", //奖品横图
"AwardName": "200两银子", //奖品名
"LimitLevel": 2, //等级
"AwardCount": 0, //剩余份数
"UserAwardStatus": 0 //用户对该奖品的领取状态： 1可以领取；2已经领取；3不可领取
}]
}
},
{
"ActivityNumber": 2, // 序号
"Id": 234, // 子活动id
"ActivityType": 2, //类型：2图文活动
"ActivityName": "图文活动",
"BeginUnixTime": 0,
"EndUnixTime": 0,
"ActivityConfig": {
"SubActivityImgForVertical": "", //背景图：冲级活动头部的横板图
"SubActivityImgForHorizontal": "", //背景图：冲级活动头部的竖版图
"AwardName":[] //奖品：图文活动所有都为空
}
}
],
"head":{ //头部区域
"BGImgForVertical": "", //背景图竖版
"BGImgForHorizontal": "", //背景图横版
"ServerIdMin": 998, //开始服
"ServerIdMax": 999//结束服
},
"BGColor": 1, //皮肤
"ActivityRule": "", //规则内容
"AppCode": "qnyh" //游戏缩写
"AppName": "倩女幽魂" //游戏名
},
"Message": ""
}
</code></pre>
<p><strong>特别说明</strong>
1、code值说明：</p>
<ul>
<li>0 正常</li>
<li>101 活动未开始</li>
<li>102 活动已结束</li>
<li>103 活动禁用</li>
<li>其他code h5统一识别为异常</li>
</ul>
<p>2、返回的【活动信息】这个参数数组的顺序根据后台的活动的 排序返回。</p>
<h3>接口2:获取页面底部的游戏信息</h3>
<p><strong>简要描述：</strong></p>
<ul>
<li>获取页面底部的游戏信息</li>
</ul>
<p><strong>请求url：</strong></p>
<ul>
<li>/api/activity/getbottom
<strong>适用版本：</strong> </li>
<li><code>1.0.0</code></li>
</ul>
<p><strong>请求方式：</strong> </p>
<ul>
<li><code>get</code></li>
</ul>
<p><strong>请求参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必选</th>
<th>默认值</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>ActivityId</td>
<td>long</td>
<td>是</td>
<td>""</td>
<td>活动Id</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求示例：</strong></p>
<pre><code>{
"ActivityId": 111 //游戏Id
}</code></pre>
<p><strong>返回参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>AppIcon</td>
<td>string</td>
<td>icon链接</td>
<td>-</td>
</tr>
<tr>
<td>AppName</td>
<td>string</td>
<td>游戏名</td>
<td>-</td>
</tr>
<tr>
<td>ActivityIntroduce</td>
<td>string</td>
<td>游戏介绍</td>
<td>-</td>
</tr>
<tr>
<td>AppPkg</td>
<td>string</td>
<td>游戏包名</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>返回示例：</strong></p>
<pre><code>{
"Code":0, //code值
"Data":{ //数据
"AppIcon": "ds.html", //icon链接
"AppName": "传奇霸业", //游戏名
"ActivityIntroduce": "", //游戏介绍
"AppPkg": "com.uc108.mobile.jhxkl.tcy" // 游戏包名
},
"Message":""
}</code></pre>
<h3>接口3:领取奖励接口</h3>
<p><strong>简要描述：</strong></p>
<ul>
<li>领取奖励</li>
</ul>
<p><strong>请求url：</strong></p>
<ul>
<li>/api/activity/getaward</li>
</ul>
<p><strong>适用版本：</strong> </p>
<ul>
<li><code>1.0.0</code></li>
</ul>
<p><strong>请求方式：</strong> </p>
<ul>
<li><code>get</code></li>
</ul>
<p><strong>请求参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必选</th>
<th>默认值</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>Id</td>
<td>number</td>
<td>是</td>
<td>""</td>
<td>奖励id</td>
<td>-</td>
</tr>
<tr>
<td>ActivityId</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>活动Id</td>
<td>-</td>
</tr>
<tr>
<td>SubActivityId</td>
<td>number</td>
<td>是</td>
<td>""</td>
<td>冲级活动Id（子活动）</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求示例：</strong></p>
<pre><code>{
"Id": 1 , //奖励id
"ActivityId": 1, //活动Id
"SubActivityId": 1 //冲级活动Id
}
</code></pre>
<p><strong>返回参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>AwardName</td>
<td>string</td>
<td>奖励名</td>
<td>-</td>
</tr>
<tr>
<td>AwardImgForVertical</td>
<td>string</td>
<td>奖励图片 竖版a.jpg</td>
<td>-</td>
</tr>
<tr>
<td>AwardImgForHorizontal</td>
<td>string</td>
<td>奖励图片 横版a.jpg</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>返回示例：</strong></p>
<pre><code>{
"Code":0, //code值
"Data":{ //数据
"AwardName": "200两银子l", //奖励名
"AwardImgForVertical": "http://a.jpg" //奖励图片地址
"AwardImgForHorizontal": "http://a.jpg" //奖励图片地址
},
"Message":""
}
</code></pre>
<p><strong>特别说明</strong>
1、code值说明：</p>
<ul>
<li>0 正常</li>
<li>101 活动未开始</li>
<li>102 活动已结束</li>
<li>103 活动禁用</li>
<li>201 等级不够</li>
<li>202 已领取奖励</li>
<li>203 库存不足</li>
<li>其他code h5统一识别为异常</li>
</ul>
<h3>接口4:获取奖励记录</h3>
<p><strong>简要描述：</strong></p>
<ul>
<li>获取奖励记录 </li>
</ul>
<p><strong>请求url：</strong></p>
<ul>
<li>/api/activity/getawardrecord</li>
</ul>
<p><strong>适用版本：</strong> </p>
<ul>
<li><code>1.0.0</code></li>
</ul>
<p><strong>请求方式：</strong> </p>
<ul>
<li><code>get</code></li>
</ul>
<p><strong>适用版本：</strong> </p>
<ul>
<li><code>1.0.0</code></li>
</ul>
<p><strong>请求参数：</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">名称</th>
<th style="text-align: left;">类型</th>
<th style="text-align: left;">必选</th>
<th>默认值</th>
<th>说明</th>
<th>限制长度说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">ActivityId</td>
<td style="text-align: left;">long</td>
<td style="text-align: left;">是</td>
<td></td>
<td>活动Id</td>
<td>-</td>
</tr>
<tr>
<td style="text-align: left;">PageIndex</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">是</td>
<td>1</td>
<td>当前页码</td>
<td>-</td>
</tr>
<tr>
<td style="text-align: left;">PageSize</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">是</td>
<td>5</td>
<td>当前页长</td>
<td>-</td>
</tr>
<tr>
<td style="text-align: left;">Flag</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">是</td>
<td>1</td>
<td>标识：以防数据继续进行插入，导致下载加载的数据不准确</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求示例：</strong></p>
<pre><code>{
"ActivityId":1,
"PageIndex": 1,
"PageSize": 5，
"Flag":1
}
</code></pre>
<p><strong>返回参数：</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">名称</th>
<th style="text-align: left;">类型</th>
<th style="text-align: left;">说明</th>
<th style="text-align: left;">限制长度说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">RecordCount</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">总的页数</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">Flag</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">标识</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">— List</td>
<td style="text-align: left;">array</td>
<td style="text-align: left;">List的数组对象</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">Id</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">Id</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">PrizeName</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">奖项名称</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">PrizeDate</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">奖励时间</td>
<td style="text-align: left;">例如：2018.10.22</td>
</tr>
<tr>
<td style="text-align: left;">Status</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">状态</td>
<td style="text-align: left;">0已发放，1发放中，2等待发放-->约等于 发放异常，</td>
</tr>
<tr>
<td style="text-align: left;">PrizeAbout</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">备注</td>
<td style="text-align: left;">-</td>
</tr>
</tbody>
</table>
<p><strong>返回示例：</strong></p>
<pre><code>{
"Code": 0,
"Data": {
"RecordCount": 23,
"Flag":1,
"List": [
{
"Id": 1,
"PrizeName": "100-10元豆券",
"PrizeDate": "2018.10.22",
"Status":0,
"PrizeAbout": ""
}
]
},
"Message": ""
}
</code></pre>