获取一台设备的书本阅读记录(按书本汇总统计数据)
<p><strong>服务:</strong>api-cloud
<strong>API:</strong><code>cloud-api1.51wanxue.com/api-cloud/record?={openId}&start={start}&end={end}&page={page}&pageSize={pageSize}</code>
<strong>请求方式:</strong>GET
<strong>api开发者:</strong> 祖旦
<strong>简要描述:</strong>获取一个用户在指定时间段内阅读的书本记录列表,一条书本记录包括:</p>
<ul>
<li>书本信息</li>
<li>该书在指定时间段内的累计阅读次数</li>
<li>该书在指定时间段内的累计阅读时长</li>
<li>该书在指定时间段内的各次阅读中,是否至少有一次被读完</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>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">openId</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">String</td>
<td>设备唯一ID</td>
</tr>
<tr>
<td style="text-align: left;">start</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">Long</td>
<td>开始统计时间戳(13位),默认为当日00:00</td>
</tr>
<tr>
<td style="text-align: left;">end</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">Long</td>
<td>结束统计时间戳(13位),默认为次日00:00</td>
</tr>
<tr>
<td style="text-align: left;">page</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">Int</td>
<td>页码,默认为1</td>
</tr>
<tr>
<td style="text-align: left;">pageSize</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">Int</td>
<td>页大小,默认为3</td>
</tr>
</tbody>
</table>
<p><strong>返回示例</strong></p>
<pre><code class="language-json">{
"code": 0,
"msg": "ok",
"data": {
"data": [
{
"readRecord": {
"bookId": 6719,
"totalTime": 208,
"readCount": 1,
"readFinish": true
},
"bookDetail": {
"bookId": 6719,
"name": "腊八节",
"isbn": "9787511040428",
"publisher": "海豚",
"coverImage": "http://files-dev.51wanxue.cn/brs/content/picturebook/6719/dd6bbd32-b674-400a-8e6b-35890e81b1e8_300x300.jpg",
"author": "【中】郑毅",
"description": "",
"state": 0,
"createdTime": "2018-04-18 18:17:00"
},
"labels": ["语言发展", "国学文化"]
}
],
"pagination": {
"pageSize": 3,
"currentPage": 1,
"totalRecord": 1,
"limit": 3,
"recordStartIndex": 0,
"recordEndIndex": 6,
"pages": 1
}
}
}</code></pre>
<p><strong>返回数据参数说明 </strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">code</td>
<td style="text-align: left;">int</td>
<td>请求返回码 0(表示成功)</td>
</tr>
<tr>
<td style="text-align: left;">msg</td>
<td style="text-align: left;">String</td>
<td>返回值为“ok”时代表请求成功,否则为请求失败的原因</td>
</tr>
<tr>
<td style="text-align: left;">data</td>
<td style="text-align: left;">Object</td>
<td>接口返回的数据主体</td>
</tr>
</tbody>
</table>
<p><strong>readRecord </strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">bookId</td>
<td style="text-align: left;">Long</td>
<td>绘本Id</td>
</tr>
<tr>
<td style="text-align: left;">totalTime</td>
<td style="text-align: left;">Int</td>
<td>阅读书本时长(单位:秒)</td>
</tr>
<tr>
<td style="text-align: left;">readCount</td>
<td style="text-align: left;">Int</td>
<td>阅读书本次数</td>
</tr>
<tr>
<td style="text-align: left;">readFinish</td>
<td style="text-align: left;">Boolean</td>
<td>是否读完, 可能为null</td>
</tr>
</tbody>
</table>
<p><strong>bookDetail </strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">bookId</td>
<td style="text-align: left;">Long</td>
<td>绘本Id</td>
</tr>
<tr>
<td style="text-align: left;">name</td>
<td style="text-align: left;">String</td>
<td>书名</td>
</tr>
<tr>
<td style="text-align: left;">isbn</td>
<td style="text-align: left;">String</td>
<td>ISBN</td>
</tr>
<tr>
<td style="text-align: left;">publisher</td>
<td style="text-align: left;">String</td>
<td>出版社</td>
</tr>
<tr>
<td style="text-align: left;">coverImage</td>
<td style="text-align: left;">String</td>
<td>封面缩略图地址</td>
</tr>
<tr>
<td style="text-align: left;">author</td>
<td style="text-align: left;">String</td>
<td>作者</td>
</tr>
<tr>
<td style="text-align: left;">description</td>
<td style="text-align: left;">String</td>
<td>书本描述</td>
</tr>
<tr>
<td style="text-align: left;">state</td>
<td style="text-align: left;">int</td>
<td>是否可读,1可读,0不可读</td>
</tr>
<tr>
<td style="text-align: left;">createdTime</td>
<td style="text-align: left;">Date</td>
<td>书本创建日期, 可能为null</td>
</tr>
</tbody>
</table>
<p><strong>pagination </strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">pageSize</td>
<td style="text-align: left;">int</td>
<td>页面大小</td>
</tr>
<tr>
<td style="text-align: left;">currentPage</td>
<td style="text-align: left;">Int</td>
<td>当前页数</td>
</tr>
<tr>
<td style="text-align: left;">totalRecord</td>
<td style="text-align: left;">Int</td>
<td>总记录条数</td>
</tr>
<tr>
<td style="text-align: left;">limit</td>
<td style="text-align: left;">int</td>
<td>查询最大条数</td>
</tr>
<tr>
<td style="text-align: left;">recordStartIndex</td>
<td style="text-align: left;">int</td>
<td>开始索引</td>
</tr>
<tr>
<td style="text-align: left;">recordEndIndex</td>
<td style="text-align: left;">int</td>
<td>结束索引</td>
</tr>
<tr>
<td style="text-align: left;">pages</td>
<td style="text-align: left;">int</td>
<td>总页数</td>
</tr>
</tbody>
</table>
<p><strong>labels </strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">labels</td>
<td style="text-align: left;">String[]</td>
<td>标签名称数组</td>
</tr>
</tbody>
</table>