公司相关

记录公司开发对接文档


绑定设备类型与模组类型

<h3>1. 获取设备类型列表</h3> <p><strong>请求方式:</strong> <code>GET</code> <strong>接口路径:</strong> <code>/iot/deviceType/list</code></p> <p><strong>描述:</strong> 获取设备类型的列表。</p> <p><strong>请求参数:</strong> 无</p> <p><strong>响应示例:</strong></p> <ul> <li> <p><strong>成功返回:</strong></p> <pre><code>{ &amp;quot;code&amp;quot;: 200, &amp;quot;msg&amp;quot;: &amp;quot;操作成功&amp;quot;, &amp;quot;total&amp;quot;: 2, &amp;quot;rows&amp;quot;: [ { &amp;quot;deviceTypeId&amp;quot;: 1, &amp;quot;name&amp;quot;: &amp;quot;举升机&amp;quot;, &amp;quot;description&amp;quot;: &amp;quot;用于举升机的设备类型&amp;quot; }, { &amp;quot;deviceTypeId&amp;quot;: 2, &amp;quot;name&amp;quot;: &amp;quot;压缩机&amp;quot;, &amp;quot;description&amp;quot;: &amp;quot;用于压缩机的设备类型&amp;quot; } ] }</code></pre> </li> <li><strong>失败返回:</strong></li> </ul> <p><code>{ &amp;quot;code&amp;quot;: 403, &amp;quot;msg&amp;quot;: &amp;quot;权限不足&amp;quot; }</code></p> <hr /> <h3>2. 导出设备类型列表</h3> <p><strong>请求方式:</strong> <code>POST</code><br /> <strong>接口路径:</strong> <code>/iot/deviceType/export</code></p> <p><strong>描述:</strong><br /> 将设备类型列表导出为Excel文件。</p> <p><strong>请求参数:</strong> 无</p> <p><strong>响应示例:</strong></p> <ul> <li> <p><strong>成功:</strong><br /> 导出成功,Excel文件将下载。</p> </li> <li><strong>失败返回:</strong></li> </ul> <p>json</p> <p>复制代码</p> <p><code>{ &amp;quot;code&amp;quot;: 500, &amp;quot;msg&amp;quot;: &amp;quot;导出失败,请稍后再试&amp;quot; }</code></p> <hr /> <h3>3. 获取设备类型详细信息</h3> <p><strong>请求方式:</strong> <code>GET</code><br /> <strong>接口路径:</strong> <code>/iot/deviceType/{deviceTypeId}</code></p> <p><strong>描述:</strong><br /> 根据设备类型ID,获取设备类型的详细信息。</p> <p><strong>路径参数:</strong></p> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>deviceTypeId</td> <td>Long</td> <td>是</td> <td>设备类型的唯一ID</td> </tr> </tbody> </table> <p><strong>响应示例:</strong></p> <ul> <li><strong>成功返回:</strong></li> </ul> <p>json</p> <p>复制代码</p> <p><code>{ &amp;quot;code&amp;quot;: 200, &amp;quot;msg&amp;quot;: &amp;quot;操作成功&amp;quot;, &amp;quot;data&amp;quot;: { &amp;quot;deviceTypeId&amp;quot;: 1, &amp;quot;name&amp;quot;: &amp;quot;举升机&amp;quot;, &amp;quot;description&amp;quot;: &amp;quot;用于举升机的设备类型&amp;quot; } }</code></p> <ul> <li><strong>失败返回:</strong></li> </ul> <p>json</p> <p>复制代码</p> <p><code>{ &amp;quot;code&amp;quot;: 404, &amp;quot;msg&amp;quot;: &amp;quot;未找到该设备类型&amp;quot; }</code></p> <hr /> <h3>4. 新增设备类型</h3> <p><strong>请求方式:</strong> <code>POST</code><br /> <strong>接口路径:</strong> <code>/iot/deviceType</code></p> <p><strong>描述:</strong><br /> 新增一个设备类型。</p> <p><strong>请求参数:</strong></p> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>String</td> <td>是</td> <td>设备类型名称</td> </tr> <tr> <td>description</td> <td>String</td> <td>否</td> <td>设备类型描述</td> </tr> </tbody> </table> <p><strong>请求示例:</strong></p> <p>json</p> <p>复制代码</p> <p><code>{ &amp;quot;name&amp;quot;: &amp;quot;新设备类型&amp;quot;, &amp;quot;description&amp;quot;: &amp;quot;这是一个新添加的设备类型&amp;quot; }</code></p> <p><strong>响应示例:</strong></p> <ul> <li><strong>成功返回:</strong></li> </ul> <p>json</p> <p>复制代码</p> <p><code>{ &amp;quot;code&amp;quot;: 200, &amp;quot;msg&amp;quot;: &amp;quot;添加成功&amp;quot; }</code></p> <ul> <li><strong>失败返回:</strong></li> </ul> <p>json</p> <p>复制代码</p> <p><code>{ &amp;quot;code&amp;quot;: 400, &amp;quot;msg&amp;quot;: &amp;quot;请求数据无效&amp;quot; }</code></p> <hr /> <h3>5. 修改设备类型</h3> <p><strong>请求方式:</strong> <code>PUT</code><br /> <strong>接口路径:</strong> <code>/iot/deviceType</code></p> <p><strong>描述:</strong><br /> 修改一个已有的设备类型。</p> <p><strong>请求参数:</strong></p> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>deviceTypeId</td> <td>Long</td> <td>是</td> <td>设备类型的唯一ID</td> </tr> <tr> <td>name</td> <td>String</td> <td>是</td> <td>设备类型名称</td> </tr> <tr> <td>description</td> <td>String</td> <td>否</td> <td>设备类型描述</td> </tr> </tbody> </table> <p><strong>请求示例:</strong></p> <p>json</p> <p>复制代码</p> <p><code>{ &amp;quot;deviceTypeId&amp;quot;: 1, &amp;quot;name&amp;quot;: &amp;quot;修改后的设备类型&amp;quot;, &amp;quot;description&amp;quot;: &amp;quot;修改后的描述信息&amp;quot; }</code></p> <p><strong>响应示例:</strong></p> <ul> <li><strong>成功返回:</strong></li> </ul> <p>json</p> <p>复制代码</p> <p><code>{ &amp;quot;code&amp;quot;: 200, &amp;quot;msg&amp;quot;: &amp;quot;修改成功&amp;quot; }</code></p> <ul> <li><strong>失败返回:</strong></li> </ul> <p>json</p> <p>复制代码</p> <p><code>{ &amp;quot;code&amp;quot;: 404, &amp;quot;msg&amp;quot;: &amp;quot;设备类型不存在&amp;quot; }</code></p> <hr /> <h3>6. 删除设备类型</h3> <p><strong>请求方式:</strong> <code>DELETE</code><br /> <strong>接口路径:</strong> <code>/iot/deviceType/{deviceTypeIds}</code></p> <p><strong>描述:</strong><br /> 删除一个或多个设备类型。</p> <p><strong>路径参数:</strong></p> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>deviceTypeIds</td> <td>Long[]</td> <td>是</td> <td>设备类型的唯一ID数组, 例如: [1, 2, 3]</td> </tr> </tbody> </table> <p><strong>响应示例:</strong></p> <ul> <li><strong>成功返回:</strong></li> </ul> <p>json</p> <p>复制代码</p> <p><code>{ &amp;quot;code&amp;quot;: 200, &amp;quot;msg&amp;quot;: &amp;quot;删除成功&amp;quot; }</code></p> <ul> <li><strong>失败返回:</strong></li> </ul> <p>json</p> <p>复制代码</p> <p><code>{ &amp;quot;code&amp;quot;: 500, &amp;quot;msg&amp;quot;: &amp;quot;删除失败,请稍后再试&amp;quot; }</code></p>

页面列表

ITEM_HTML