地图列表
<h5>简要描述</h5>
<ul>
<li>匿名token</li>
</ul>
<h5>请求URL</h5>
<ul>
<li><code>http://localhost:10002/api/v1/bnclw-robot/mapManagement/getList</code></li>
</ul>
<h5>请求方式</h5>
<ul>
<li>POST</li>
</ul>
<h5>header头部参数</h5>
<p>token: 545df4c4c45115aaf0ff5f1e2d5d01d5</p>
<h5>参数</h5>
<pre><code>{
&quot;page&quot;:1,
&quot;length&quot;:10,
&quot;sno&quot;:&quot;234234234&quot;
}</code></pre>
<h5>传入参数说明</h5>
<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;">sno</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Y</td>
<td>设备号</td>
</tr>
<tr>
<td style="text-align: left;">page</td>
<td style="text-align: left;">Int</td>
<td style="text-align: left;">N</td>
<td>默认第1页</td>
</tr>
<tr>
<td style="text-align: left;">length</td>
<td style="text-align: left;">Int</td>
<td style="text-align: left;">N</td>
<td>默认10条</td>
</tr>
</tbody>
</table>
<h5>返回示例</h5>
<pre><code>{
&quot;code&quot;: 0,
&quot;errMsg&quot;: &quot;success&quot;,
&quot;data&quot;: {
&quot;rows&quot;: [
{
&quot;mapId&quot;: 1,
&quot;sno&quot;: &quot;234234234&quot;,
&quot;mapName&quot;: &quot;123&quot;,
&quot;map&quot;: &quot;qwwe&quot;,
&quot;isApply&quot;: 0,
&quot;type&quot;: 1,
&quot;createTime&quot;: 1653035509000,
&quot;updateTime&quot;: 1653035511000,
&quot;mapForbidZones&quot;: [
{
&quot;id&quot;: 1,
&quot;mapId&quot;: 1,
&quot;sno&quot;: &quot;5478fb2e1b88ecd3&quot;,
&quot;name&quot;: null,
&quot;shape&quot;: null,
&quot;createTime&quot;: null,
&quot;updateTime&quot;: 1742802030000,
&quot;points&quot;: null
}
],
&quot;mapModules&quot;: [
{
&quot;id&quot;: 2,
&quot;mapId&quot;: 1,
&quot;sno&quot;: &quot;5478fb2e1b88ecd3&quot;,
&quot;name&quot;: null,
&quot;types&quot;: null,
&quot;moduleType&quot;: null,
&quot;createTime&quot;: null,
&quot;updateTime&quot;: 1742802047000,
&quot;points&quot;: null
}
],
&quot;mapRooms&quot;: [
{
&quot;id&quot;: 3,
&quot;mapId&quot;: 1,
&quot;sno&quot;: &quot;5478fb2e1b88ecd3&quot;,
&quot;name&quot;: null,
&quot;material&quot;: 0,
&quot;createTime&quot;: null,
&quot;updateTime&quot;: 1742802059000,
&quot;contour&quot;: null
}
]
}
],
&quot;total&quot;: 1
}
}</code></pre>
<h5>返回参数说明</h5>
<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>状态码</td>
</tr>
<tr>
<td style="text-align: left;">errMsg</td>
<td style="text-align: left;">String</td>
<td>返回信息</td>
</tr>
<tr>
<td style="text-align: left;">data</td>
<td style="text-align: left;">object</td>
<td>实体对象</td>
</tr>
</tbody>
</table>
<h5>data参数说明</h5>
<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;">total</td>
<td style="text-align: left;">Int</td>
<td>总条数</td>
</tr>
<tr>
<td style="text-align: left;">rows</td>
<td style="text-align: left;">List</td>
<td>数据</td>
</tr>
</tbody>
</table>
<h5>rows参数说明</h5>
<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;">mapId</td>
<td style="text-align: left;">Long</td>
<td>id</td>
</tr>
<tr>
<td style="text-align: left;">sno</td>
<td style="text-align: left;">String</td>
<td>设备号</td>
</tr>
<tr>
<td style="text-align: left;">mapName</td>
<td style="text-align: left;">String</td>
<td>地图名</td>
</tr>
<tr>
<td style="text-align: left;">isApply</td>
<td style="text-align: left;">Int</td>
<td>是否使用 1是 0否 默认0</td>
</tr>
<tr>
<td style="text-align: left;">type</td>
<td style="text-align: left;">Long</td>
<td>清扫类型 1:全屋清扫;2:指定房间;3:指哪扫哪</td>
</tr>
<tr>
<td style="text-align: left;">map</td>
<td style="text-align: left;">String</td>
<td>地图 (protobuf数据)</td>
</tr>
<tr>
<td style="text-align: left;">mapForbidZones</td>
<td style="text-align: left;">List</td>
<td>禁区</td>
</tr>
<tr>
<td style="text-align: left;">mapModules</td>
<td style="text-align: left;">List</td>
<td>地图组件</td>
</tr>
<tr>
<td style="text-align: left;">mapRooms</td>
<td style="text-align: left;">List</td>
<td>房间</td>
</tr>
</tbody>
</table>
<h5>mapForbidZones 参数说明</h5>
<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;">id</td>
<td style="text-align: left;">Long</td>
<td style="text-align: left;">Y</td>
<td>ID</td>
</tr>
<tr>
<td style="text-align: left;">mapId</td>
<td style="text-align: left;">Long</td>
<td style="text-align: left;">Y</td>
<td>地图ID</td>
</tr>
<tr>
<td style="text-align: left;">name</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">N</td>
<td>禁区名</td>
</tr>
<tr>
<td style="text-align: left;">shape</td>
<td style="text-align: left;">Int</td>
<td style="text-align: left;">Y</td>
<td>0:线型 1:矩形</td>
</tr>
<tr>
<td style="text-align: left;">points</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Y</td>
<td>轮廓点世界坐标</td>
</tr>
</tbody>
</table>
<h5>mapModules 参数说明</h5>
<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;">id</td>
<td style="text-align: left;">Long</td>
<td style="text-align: left;">Y</td>
<td>ID</td>
</tr>
<tr>
<td style="text-align: left;">mapId</td>
<td style="text-align: left;">Long</td>
<td style="text-align: left;">Y</td>
<td>地图ID</td>
</tr>
<tr>
<td style="text-align: left;">name</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">N</td>
<td>禁区名</td>
</tr>
<tr>
<td style="text-align: left;">points</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Y</td>
<td>float[]矩形地毯4个顶点世界坐标一组,支持多组</td>
</tr>
<tr>
<td style="text-align: left;">types</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Y</td>
<td>属性数组</td>
</tr>
<tr>
<td style="text-align: left;">moduleType</td>
<td style="text-align: left;">Int</td>
<td style="text-align: left;">Y</td>
<td>1:门槛条,2:地毯</td>
</tr>
</tbody>
</table>
<h5>mapRooms 参数说明</h5>
<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;">id</td>
<td style="text-align: left;">Long</td>
<td style="text-align: left;">Y</td>
<td>ID</td>
</tr>
<tr>
<td style="text-align: left;">mapId</td>
<td style="text-align: left;">Long</td>
<td style="text-align: left;">Y</td>
<td>地图ID</td>
</tr>
<tr>
<td style="text-align: left;">name</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">N</td>
<td>名字</td>
</tr>
<tr>
<td style="text-align: left;">contour</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">Y</td>
<td>轮廓点世界坐标</td>
</tr>
<tr>
<td style="text-align: left;">material</td>
<td style="text-align: left;">Int</td>
<td style="text-align: left;">Y</td>
<td>0:瓷砖 1:大理石 2:木地板 3:地毯</td>
</tr>
</tbody>
</table>
<h5>备注</h5>
<ul>
<li>code码请看目录 项目描述——全局报文说明 更多返回错误代码请看首页的错误代码描述</li>
</ul>