apes-Authon-Web/docs/solenoid-valve-api.md

电磁阀管理接口文档

接口前缀

/api/user-service/fei/solenoid/valve

1. 分页查询电磁阀列表

请求方式: POST
请求路径: /page

请求参数

{
  "pageIndex": 1,           // 页码（必填）
  "pageSize": 10,           // 每页数量（必填）
  "valveName": "电磁阀A",   // 阀门名称（模糊查询，可选）
  "valveCode": "SV-001",    // 阀门编号（精确查询，可选）
  "parkId": 1,              // 园区ID（可选）
  "plotId": 1,              // 地块ID（可选）
  "valveStatus": 0,         // 阀门状态 0-关闭 1-开启（可选）
  "onlineStatus": 1         // 在线状态 0-离线 1-在线（可选）
}

响应示例

{
  "code": 1,
  "msg": "ok",
  "data": {
    "records": [
      {
        "id": 1,
        "valveName": "电磁阀A01",
        "valveCode": "SV-2026-001",
        "parkId": 1,
        "plotId": 1,
        "longitude": 108.365432,
        "latitude": 22.842156,
        "installLocation": "A区1号地块入口",
        "valveStatus": 0,
        "onlineStatus": 1,
        "lastActionTime": null,
        "remark": "测试数据1",
        "parkName": "示例园区",
        "plotName": "A3",
        "createTime": "2026-07-07 20:52:25",
        "updateTime": "2026-07-07 20:52:25",
        "isDel": 0
      }
    ],
    "total": 2,
    "size": 10,
    "current": 1,
    "pages": 1
  }
}

2. 查询电磁阀详情

请求方式: POST
请求路径: /detail

请求参数

{
  "id": 1  // 电磁阀ID（必填）
}

响应示例

{
  "code": 1,
  "msg": "ok",
  "data": {
    "id": 1,
    "valveName": "电磁阀A01",
    "valveCode": "SV-2026-001",
    "parkId": 1,
    "plotId": 1,
    "longitude": 108.365432,
    "latitude": 22.842156,
    "installLocation": "A区1号地块入口",
    "valveStatus": 0,
    "onlineStatus": 1,
    "lastActionTime": null,
    "remark": "测试数据1",
    "parkName": "示例园区",
    "plotName": "A3",
    "createTime": "2026-07-07 20:52:25",
    "updateTime": "2026-07-07 20:52:25",
    "isDel": 0
  }
}

3. 新增电磁阀

请求方式: POST
请求路径: /add

请求参数

{
  "valveName": "电磁阀A01",           // 阀门名称（必填）
  "valveCode": "SV-2026-001",         // 阀门编号（必填，唯一）
  "parkId": 1,                        // 园区ID（必填）
  "plotId": 1,                        // 地块ID（可选）
  "longitude": 108.365432,            // 经度（可选）
  "latitude": 22.842156,              // 纬度（可选）
  "installLocation": "A区1号地块入口", // 安装位置描述（可选）
  "valveStatus": 0,                   // 阀门状态 0-关闭 1-开启（可选，默认0）
  "onlineStatus": 1,                  // 在线状态 0-离线 1-在线（可选，默认0）
  "remark": "备注信息"                 // 备注（可选）
}

响应示例

{
  "code": 1,
  "msg": "ok",
  "data": null
}

4. 更新电磁阀

请求方式: POST
请求路径: /update

请求参数

{
  "id": 1,                            // 电磁阀ID（必填）
  "valveName": "电磁阀A01-修改",      // 阀门名称（可选）
  "valveCode": "SV-2026-001",         // 阀门编号（可选，唯一）
  "parkId": 1,                        // 园区ID（可选）
  "plotId": 1,                        // 地块ID（可选）
  "longitude": 108.365500,            // 经度（可选）
  "latitude": 22.842200,              // 纬度（可选）
  "installLocation": "新位置",         // 安装位置描述（可选）
  "valveStatus": 1,                   // 阀门状态 0-关闭 1-开启（可选）
  "onlineStatus": 1,                  // 在线状态 0-离线 1-在线（可选）
  "remark": "更新后的备注"             // 备注（可选）
}

响应示例

{
  "code": 1,
  "msg": "ok",
  "data": null
}

5. 删除电磁阀

请求方式: POST
请求路径: /delete

请求参数

{
  "id": 1  // 电磁阀ID（必填）
}

响应示例

{
  "code": 1,
  "msg": "ok",
  "data": null
}

字段说明

电磁阀字段

字段名	类型	说明
id	Long	主键ID
valveName	String	阀门名称
valveCode	String	阀门编号（唯一）
parkId	Long	园区ID
plotId	Long	地块ID
longitude	BigDecimal	经度
latitude	BigDecimal	纬度
installLocation	String	安装位置描述
valveStatus	Integer	阀门状态 0-关闭 1-开启
onlineStatus	Integer	在线状态 0-离线 1-在线
lastActionTime	Date	最后操作时间
remark	String	备注
parkName	String	园区名称（非数据库字段，用于展示）
plotName	String	地块名称（非数据库字段，用于展示）
createTime	Date	创建时间
updateTime	Date	更新时间
isDel	Integer	逻辑删除 0-正常 1-删除