设备端档口设备列表接口文档
接口概览
接口地址
POST
/api/device/restaurant/equipmentList
认证方式
无需登录 token
请求格式
Form 表单或 JSON Body
业务用途
设备端根据档口 ID 获取该档口绑定的称重台设备列表
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
restaurant_id |
int | 是 | 档口 ID,对应 restaurants.id。 |
{
"restaurant_id": 1
}
筛选规则
| 数据对象 | 规则 |
|---|---|
| 档口 | restaurants.id = restaurant_id 且 restaurants.is_delete = 2,不存在时返回 档口不存在。 |
| 设备 | equipment.restaurant_id = restaurant_id 且 equipment.del_flag = 0。 |
| 设备类型 | 只返回称重台 400、450、460:type in (2, 3, 4, 10)。对应 400 型、450 型单称、450 型双称、460 型。 |
说明 截图中包含 500 型,但本次需求明确写的是 400、450、460,因此接口不返回 500 型。
成功响应
{
"code": 0,
"message": "获取成功",
"data": {
"restaurant": {
"restaurant_id": 1,
"restaurant_name": "热菜档口"
},
"list": [
{
"equipment_id": 10,
"equipment_name": "称重台 A",
"equipment_code": "CW-001",
"address": "一层热菜区",
"type": 2,
"type_name": "称重台-400型",
"status": 1,
"status_name": "在线",
"push_dishes": {
"has_push_dishes": true,
"push_dishes_user": "管理员",
"push_dishes_time": "2026-06-23 14:10:00",
"left_dishes": {
"dishes_uuid": "dish-left-uuid",
"dishes_name": "番茄炒蛋",
"file_path": "https://img.example.com/dishes/tomato-egg.jpg"
},
"right_dishes": {
"dishes_uuid": "",
"dishes_name": "",
"file_path": ""
}
}
}
]
}
}
返回字段
| 字段 | 类型 | 说明 |
|---|---|---|
data.restaurant.restaurant_id |
int | 档口 ID。 |
data.restaurant.restaurant_name |
string | 档口名称。 |
data.list[].equipment_id |
int | 设备 ID。 |
data.list[].equipment_name |
string | 设备名称。 |
data.list[].equipment_code |
string | 设备编号。 |
data.list[].address |
string | 设备安装地址。 |
data.list[].type |
int | 设备类型枚举值:2、3、4、10。 |
data.list[].type_name |
string | 设备类型名称。 |
data.list[].status |
int | 设备状态原始值。 |
data.list[].status_name |
string | 设备状态名称:1 在线,2 离线。 |
data.list[].push_dishes.has_push_dishes |
bool | 当前设备是否已有排菜信息;左称或右称存在任一菜品 UUID 即为 true。 |
data.list[].push_dishes.push_dishes_user |
string | 最近一次排菜人员,取自设备当前排菜字段。 |
data.list[].push_dishes.push_dishes_time |
string | 最近一次排菜时间,未排菜时可能为默认时间或空值。 |
data.list[].push_dishes.left_dishes |
object | 左称当前菜品,包含 dishes_uuid、dishes_name、file_path。 |
data.list[].push_dishes.right_dishes |
object | 右称当前菜品,单称设备通常为空对象字段。 |
异常响应
| 场景 | 响应示例 |
|---|---|
未传 restaurant_id |
{"code":1,"message":"档口ID不能为空","data":[]} |
| 档口不存在或已删除 | {"code":1,"message":"档口不存在","data":[]} |
| 服务端异常 | {"code":1,"message":"设备列表获取失败","data":[]} |
调用示例
curl -X POST 'http://127.0.0.1/api/device/restaurant/equipmentList' \
-H 'Content-Type: application/json' \
-d '{"restaurant_id":1}'