外置秤盘留样柜设备接口协议
V1.0.0
目录
1
版本履历
3
一、 定义和术语
4
二、 接入方式
三、接口说明
5
3.1.
连通测试
3.2.
菜品同步接口
3.3.
餐别同步接口
3.4.
留样记录同步接口
6
操作记录同步接口
上传留样图片-OSS
上传留样图片-服务器
配餐同步接口
操作员同步接口
说明
androidDeviceId [已脱敏，原文见微盘源文件]
留样
将食品样品放入留样柜中为留样
将食品样品从留样柜中取出为取样
留样设备主动调用后台接口，用于上传留样、取样、菜品、餐别、操作员、操作日志等信息。
所有接口若无特殊说明，均采用HTTP POST方式请求，Content-Type为application/json，参数编码方式均采用UTF-8编码，所有接口请求结果的数据结构为JSON。
留样柜设备->外部系统
传入参数
备注说明
返回参数
传入参数示例：
留样记录数组转JSON字符串
"sampleListJson": "[{\"id\":\"f6f8cc73-3df1-4e9b-b29c-3e4173db6d73\",\"cabinetAddress\":\"设备地址，打印机用到的那个\",\"doorNum\":\"门编号\",\"mealTypeId\":\"餐别id\",\"mealTypeName\":\"餐别名称\",\"foodId\":\"样品id\",\"foodName\":\"样品名称\",\"foodWeight\":200,\"imgUrl\":\"本地样品图片\",\"ossImgUrl\":\"OSS样品图片\",\"liuyangUserName\":\"留样员姓名\",\"liuyangUserNo\":\"留样员编号\",\"quyangUserName\":\"取样员姓名\",\"quyangUserNo\":\"取样员编号\",\"startTime\":\"留样时间\",\"endTime\":\"需取样时间\",\"endTimes\":\"需取样时间的时间戳\",\"durationHour\":48,\"status\":\"留样状态，1留样中，0已取样\",\"takeTime\":\"实际取样时间\",\"pushTime\":\"推送时间\"}]"
user/mealType/food/preFood:操作员/餐别/菜品/配餐
操作记录数组转JSON字符串
"operationListJson": "[{\"id\":\"2a1c62ac-1c56-4fbd-b211-fc9f4a1deaed\",\"addUserName\":\"操作员姓名\",\"addUserNo\":\"操作员编号\",\"cabinetAddress\":\"设备地址，打印机用到的那个\",\"operationalName\":\"操作名称\",\"note1\":\"备注1\",\"note2\":\"备注2\",\"addTime\":\"添加时间，也是操作时间\",\"pushTime\":\"推送时间\"}]"
multipart/form-data
上传到哪个根目录下
接口请求示例：
接口返回示例：
接口预览地址：/static/${newName}
操作员数组转JSON字符串
"userListJson": "[{\"id\":\"9d0f8794-0740-4070-a596-4405051eda5d\",\"userNo\":\"1\",\"userName\":\"张三\",\"faceFilePath\":\"人脸图本地路径\",\"faceOssUrl\":\"人脸图oss路径\",\"updTime\":\"2025-07-12 12:02:02\",\"pushTime\":\"2025-07-12 12:20:02\"}]"
含义说明
账号或密码错误
登录账号已被限制使用
请求参数异常
例如：遗漏必填参数
请求接口不存在
参数编码方式均采用UTF-8编码，数据结构为JSON。
String url="{root}/{mode}/{simNo}/{appVersion}/{androidDeviceId}";
root:目标服务器前缀
mode:设备类型，静态值"lockLyg"
simNo:设备物联网卡号，如不存在，则为静态值"none"
androidDeviceId:设备唯一编号
String androidDeviceId="67f88471cf3b5d04";
String websocketUrl=root+"/"+mode+"/"+simNo+"/"+appVersion+"/"+androidDeviceId;
协议格式
外部系统->留样柜设备
协议格式/json
设备类型
设备Id
等同于androidDeviceId，设备唯一编号
操作类型
"userName": "操作员名称，最好加前缀’PC-’区分下",
"userNo": "操作员编号，可空"
完整参数示例：