中移铁通接口文档修改部分

技术团队文档示例


【理论学习】列表接口V1.0.2

<p>欢迎使用ShowDoc!</p> <p><strong>简要描述:</strong> </p> <ul> <li>获取弹窗提醒列表V1.0.2</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>/app/learn/pagelearnFieldInfo</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST </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> </tr> </thead> <tbody> <tr> <td style="text-align: left;">version</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>版本号</td> <td>1.0.2</td> </tr> <tr> <td style="text-align: left;">userId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>用户ID</td> <td>1</td> </tr> <tr> <td style="text-align: left;">page</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>页</td> <td>1</td> </tr> <tr> <td style="text-align: left;">rows</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>行</td> <td>10</td> </tr> <tr> <td style="text-align: left;">firstType</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>第一分类ID(查询条件)</td> <td>1</td> </tr> <tr> <td style="text-align: left;">secondType</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>第二分类ID(查询条件)</td> <td>1</td> </tr> <tr> <td style="text-align: left;">learnStatus</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>学习状态 0:未学习;1:已学习(查询条件)</td> <td>0</td> </tr> <tr> <td style="text-align: left;">parame</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>模糊查询与tilte相关(查询条件)</td> <td>文字</td> </tr> </tbody> </table> <p><strong>返回示例</strong> { &quot;result&quot;: 200, &quot;message&quot;: &quot;操作成功&quot;, &quot;object&quot;: { &quot;total&quot;: 11, &quot;rows&quot;: [ { &quot;id&quot;: 66, &quot;title&quot;: &quot;每周一课第12课&quot;, &quot;createTime&quot;: &quot;2018-05-10 10:46:19&quot;, &quot;deptId&quot;: &quot;1&quot;, &quot;url&quot;: &quot;<a href="http://192.168.1.164:8080/\\static\\common\\lDetail.html?id=66&amp;userId=1&amp;version=1.0.0&quot">http://192.168.1.164:8080/\\static\\common\\lDetail.html?id=66&amp;userId=1&amp;version=1.0.0&quot</a>;, &quot;readState&quot;: &quot;0&quot;, &quot;readingTime&quot;: &quot;1&quot; }, { &quot;id&quot;: 61, &quot;title&quot;: &quot;每周一课第7课&quot;, &quot;createTime&quot;: &quot;2018-05-10 10:42:32&quot;, &quot;deptId&quot;: &quot;1&quot;, &quot;url&quot;: &quot;<a href="http://192.168.1.164:8080/\\static\\common\\lDetail.html?id=61&amp;userId=1&amp;version=1.0.0&quot">http://192.168.1.164:8080/\\static\\common\\lDetail.html?id=61&amp;userId=1&amp;version=1.0.0&quot</a>;, &quot;readState&quot;: &quot;0&quot;, &quot;readingTime&quot;: &quot;10&quot; }, { &quot;id&quot;: 56, &quot;title&quot;: &quot;每周一课第2课&quot;, &quot;createTime&quot;: &quot;2018-05-10 10:38:12&quot;, &quot;deptId&quot;: &quot;1&quot;, &quot;url&quot;: &quot;<a href="http://192.168.1.164:8080/\\static\\common\\lDetail.html?id=56&amp;userId=1&amp;version=1.0.0&quot">http://192.168.1.164:8080/\\static\\common\\lDetail.html?id=56&amp;userId=1&amp;version=1.0.0&quot</a>;, &quot;readState&quot;: &quot;0&quot;, &quot;readingTime&quot;: &quot;10&quot; }, { &quot;id&quot;: 53, &quot;title&quot;: &quot;每周一题第12期&quot;, &quot;createTime&quot;: &quot;2018-05-10 10:36:04&quot;, &quot;deptId&quot;: &quot;1&quot;, &quot;url&quot;: &quot;<a href="http://192.168.1.164:8080/\\static\\common\\lDetail.html?id=53&amp;userId=1&amp;version=1.0.0&quot">http://192.168.1.164:8080/\\static\\common\\lDetail.html?id=53&amp;userId=1&amp;version=1.0.0&quot</a>;, &quot;readState&quot;: &quot;0&quot;, &quot;readingTime&quot;: &quot;10&quot; }, { &quot;id&quot;: 51, &quot;title&quot;: &quot;每周一题第10期&quot;, &quot;createTime&quot;: &quot;2018-05-10 10:34:29&quot;, &quot;deptId&quot;: &quot;1&quot;, &quot;url&quot;: &quot;<a href="http://192.168.1.164:8080/\\static\\common\\lDetail.html?id=51&amp;userId=1&amp;version=1.0.0&quot">http://192.168.1.164:8080/\\static\\common\\lDetail.html?id=51&amp;userId=1&amp;version=1.0.0&quot</a>;, &quot;readState&quot;: &quot;0&quot;, &quot;readingTime&quot;: &quot;10&quot; }, { &quot;id&quot;: 49, &quot;title&quot;: &quot;每周一题第9期&quot;, &quot;createTime&quot;: &quot;2018-05-10 10:31:00&quot;, &quot;deptId&quot;: &quot;1&quot;, &quot;url&quot;: &quot;<a href="http://192.168.1.164:8080/\\static\\common\\lDetail.html?id=49&amp;userId=1&amp;version=1.0.0&quot">http://192.168.1.164:8080/\\static\\common\\lDetail.html?id=49&amp;userId=1&amp;version=1.0.0&quot</a>;, &quot;readState&quot;: &quot;0&quot;, &quot;readingTime&quot;: &quot;10&quot; }, { &quot;id&quot;: 48, &quot;title&quot;: &quot;每周一题第8期&quot;, &quot;createTime&quot;: &quot;2018-05-10 10:30:07&quot;, &quot;deptId&quot;: &quot;1&quot;, &quot;url&quot;: &quot;<a href="http://192.168.1.164:8080/\\static\\common\\lDetail.html?id=48&amp;userId=1&amp;version=1.0.0&quot">http://192.168.1.164:8080/\\static\\common\\lDetail.html?id=48&amp;userId=1&amp;version=1.0.0&quot</a>;, &quot;readState&quot;: &quot;0&quot;, &quot;readingTime&quot;: &quot;10&quot; }, { &quot;id&quot;: 47, &quot;title&quot;: &quot;每周一题第7期&quot;, &quot;createTime&quot;: &quot;2018-05-10 10:29:22&quot;, &quot;deptId&quot;: &quot;1&quot;, &quot;url&quot;: &quot;<a href="http://192.168.1.164:8080/\\static\\common\\lDetail.html?id=47&amp;userId=1&amp;version=1.0.0&quot">http://192.168.1.164:8080/\\static\\common\\lDetail.html?id=47&amp;userId=1&amp;version=1.0.0&quot</a>;, &lt;font color='red'&gt;&quot;readState&quot;&lt;/font&gt;: &quot;0&quot;, &lt;font color='red'&gt;&quot;readingTime&lt;/font&gt;: &quot;10&quot; } ] } }</p> <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;">&lt;font color='red'&gt;readState&lt;/font&gt;</td> <td style="text-align: left;">string</td> <td>学习状态</td> <td>0代表未学习、1代表已学习、2代表没有设置学习时间(不强制学习时间)</td> </tr> <tr> <td style="text-align: left;">&lt;font color='red'&gt;readingTime&lt;/font&gt;</td> <td style="text-align: left;">int</td> <td>学习时间 (单位:分钟)</td> <td>10</td> </tr> </tbody> </table> <p><strong>备注:</strong> &lt;font color='red'&gt;弹框不用考虑即时性,例如控制为每次打开APP后主动拉取一次待处理信息, 如果列表长度为0则表示无需弹框提醒</p>

页面列表

ITEM_HTML