设备端区域-餐厅-档口三级列表接口文档

适用项目:智慧营养健康餐厅 store 后端;接口面向设备端调用,不要求后台登录 token。

接口概览

接口地址 POST/api/device/restaurant/tree
认证方式 无需登录 token
请求格式 Form 表单或 JSON Body
业务用途 设备端通过设备编号获取全部区域、餐厅和档口三级列表

请求参数

参数 类型 必填 说明
equipment_code string 设备编号,对应设备表 equipment.code

请求示例

{
  "equipment_code": "EQ001"
}

成功响应

{
  "code": 0,
  "message": "获取成功",
  "data": {
    "equipment": {
      "code": "EQ001",
      "restaurant_id": 100
    },
    "list": [
      {
        "area_id": 1,
        "area_name": "一区",
        "status": 1,
        "restaurant_list": [
          {
            "shop_id": 10,
            "shop_name": "一层餐厅",
            "status": 1,
            "stall_list": [
              {
                "restaurant_id": 100,
                "restaurant_name": "热菜档口",
                "stall_type": 1,
                "status": 1,
                "file_path": "https://example.com/image.jpg",
                "intro": "档口介绍"
              }
            ]
          }
        ]
      }
    ]
  }
}

响应字段说明

字段 说明
code 响应状态。0 表示成功,1 表示失败。
message 响应提示。
data.equipment.code 当前设备编号。
data.equipment.restaurant_id 当前设备绑定的档口 ID;接口不按该档口过滤列表。
data.list[].area_id 区域 ID。
data.list[].area_name 区域名称。
data.list[].status 区域状态,原样返回。
restaurant_list[].shop_id 餐厅 ID。
restaurant_list[].shop_name 餐厅名称。
restaurant_list[].status 餐厅状态,原样返回。
stall_list[].restaurant_id 档口 ID。
stall_list[].restaurant_name 档口名称。
stall_list[].stall_type 档口类型:1 堂食,2 订餐外卖,3 招待订餐。
stall_list[].status 档口状态,原样返回。
stall_list[].file_path 档口图片完整地址。
stall_list[].intro 档口介绍。

错误响应

{
  "code": 1,
  "message": "设备编号不能为空",
  "data": []
}

可能错误信息

业务规则

注意 当前实现按通用设备端全量三级列表处理;删除态数据仍不返回。