沃土开放平台

API文档 > 设备管理类 > 设备列表查询接口
URL:http://gs-api.uface.uni-ubi.com/v1/{appId}/devices/search,method:POST
  • 发送查询条件至云端,若条件为空则返回该appId下的所有设备
  • 若设备有tag,则需按tag搜索才能找到设备
  • 若搜索条件不传入tag,则搜索范围是无tag的设备

根据具体需求查询该appId下符合条件的所有设备

  • state可用于查询处于某一状态的所有设备
  • startTime和endTime可查询在某阶段时间内录入的所有设备
  • index相当于可跳转到目标页码
  • length可设置每页显示的设备数量,若为空则默认为每页数量为5
字段 描述 类型 必传 说明
appId 应用Id String Y
token 调用接口凭证 String Y
tag 标签 String N
deviceKey 设备序列号 String N
state 设备状态 Int N 1:未绑定,设备-appId绑定关系
2:绑定中,设备与云端确认通信中
3:解绑中,设备删除中,与appId解绑中
4:未同步,云端数据未同步至设备
5:同步中,云端数据正在同步至设备
6:已同步,云端数据已同步至设备
7:已禁用,设备不可被使用
8:禁用中,设备正在“禁用”过程中
9:启用中,设备正在“启用”过程中
startTime 录入时间初始 Date N
endTime 录入时间末尾 Date N
index 分页页码 Int N
length 每页数量 Int N
systemVersionNo 设备系统版本号 String N
versionNo 设备应用版本号 String N
orderFieldKey 按照某字段排序 String N 2:DEVICE_KEY //设备序列号
3: STATE //设备状态
5:VERSION_NO //设备应用版本号
6:SYSTEM_VERSION_NO //设备系统版本号
8:REG_NUM //识别次数
9:CREATE_TIME //创建时间
默认DEVICE_KEY
orderTypeKey 升降序 String N 1:ASC //升序
2:DESC //降序

默认升序
{
	"code": "GS_SUS303",//设备列表查询接口调用成功  
	"data": {
		"content": [
		{
		"deviceKey": "84E0F42005DCABCD",//设备序列号
		"name": "测试设备",//设备名称
		"state": 6,// 设备状态,1:未绑定,2:绑定中,3:解绑中,4:未同步,5:同步中,6:已同步,7:已禁用,8:禁用中,9:启用中
		"status": 2,//设备网络状态,1:在线,2:离线
		"versionNo": "2.4",//设备应用版本号
		"systemVersionNo": "1.0",//设备系统版本号
		"needUpgradeSystem":true,//是否需要系统升级
		"needUpgradeApp":true,//是否需要APP升级
		"needUpgrade": true//是否需要升级(包括系统和APP升级)
		}
	],
	"pagination": {//分页信息
		"total": 1,//总条目数
		"size": 1,//总页数
		"index": 1,//当前页数
		"length": 5,//每页最大显示数量,默认5
		"beginIndex": 0,//分页开始条目于总数位置
		"endIndex": 1//分页结束条目于总数位置
		}
	},
	"msg": "success
	"result": "1",
	"success": true
}
state名称 设备状态state 照片在设备上的注册状态state (拍照)注册任务状态state
state说明 1:未绑定,设备-appId绑定关系
2:绑定中,设备与云端确认通信中
3:解绑中,设备删除中,与appId解绑中
4:未同步,云端数据未同步至设备
5:同步中,云端数据正在同步至设备
6:已同步,云端数据已同步至设备
7:已禁用,设备不可被使用
8:禁用中,设备正在“禁用”过程中
9:启用中,设备正在“启用”过程中
1:已上传
2:注册中
3:注册成功
4:注册失败
1:任务创建
2:准备就绪
3:开启失败
4:任务完成
5:任务过期
6:任务失败
出现接口名称
  • 设备查询
  • 设备列表查询
人员照片状态查询
  • 注册任务状态查询
  • 注册任务状态变更