智慧硬件开发
智慧硬件开发
硬件直连接入
打印/扫描设备
接口调用
获取打印任务列表
获取打印任务列表
最后更新:2019/09/11

获取打印任务列表

1.支持分页拉取,分页获取任务时,需填写offset和limit参数,打印机可以根据自身的情况决定分页大小。默认按任务提交时间排序,任务最多存储7天。
2.同时支持按特定jobid来获取任务,jobid_list不填或者填为空调数组则忽略该参数,填写jobid_list时,接口自动忽略offset、limit、status等参数。

请求包体:

{
 	"cmd":"printer/get_job_list",
   	"headers":
	{
		"req_id":"xxxxx"
	},
	"body":
	{
		"userid": "zhangsan",
		"status": 0,
		"offset": 0,
		"limit": 10,
		"jobid_list":
		[
		"aa",
		"bb",
		"cc"
		]
	}
}

参数说明:

参数名是否必须类型描述
req_idString请求的id,自行保证不会重复即可
useridString(40)成员id
offsetUint32下载偏移量
limitUint32本次请求任务数
jobid_listArray(String)任务id列表
statusUint32任务状态:
0:获取未打印的任务;
1:获取打印成功的任务;
2:获取打印失败的任务;
不填则获取所有任务

返回结果:

{
	"headers": {
      		"req_id": "xxxx"
  	},
	"body":
	{
		"printer_job_list":
		[
			{
				"userid""zhangsan"
				"createtime"12345678,
				"submitted"1,
				"page_size":4,
				"state":"machine_01",
				"status":0,
				"errcode":0,
				"errmsg":"ok",
				"doc_name":"aa.doc",
				"doc_size": 3317,
				"jobid":"job_id_xxxxx",
				"setting_list":
				[
					{
						"key":"纸张大小",
						"value":["A4"]
					},
					{
						"key":"单双面",
						"value":["单面"]
					}
				]
				"printer_format":"pdf"
			},
			{
				"userid""lisi",
				"createtime"12345678,
				"submitted"0,
				"state":"machine_02",
				"status":2,
				"errcode":1,
				"errmsg":"打印机缺纸",
				"jobid":"job_id_yyyyy",
				"doc_name":"bb.pdf",
				"doc_size": 3317,
				"setting_list":
				[
					{
						"key":"纸张大小",
						"value":["A4"]
					},
					{
						"key":"单双面",
						"value":["单面"]
					}
				],
				"printer_format":"jpg",
				"pic_file_list":
				{
					"size":6,
					"item":[
						{
							"idx":0, 
							"pic_size":10240
						},
						{
							"idx":1, 
							"pic_size":635
						},
						{
							"idx":2, 
							"pic_size":11111
						}
						{
							"idx":3, 
							"pic_size":35374
						}
					]
				}
			}
		]
	}
  	"errcode": 0,
  	"errmsg": "ok"
}

参数说明:

参数名描述
req_id透传请求的req_id
errcode错误码
errmsg错误码描述
printer_job_list打印任务列表
createtime任务提交时间
submitted表示该任务是否扫码后提交:
0:否
1:是
userid成员id,表示该任务是谁提交的
page_size页数,仅当printer_format为jpg时可以忽略该参数
status任务状态:
0:获取未打印的任务
1:获取打印成功的任务
2:获取打印失败的任务
printer_job_list:errcode该任务错误码
printer_job_list:errmsg该任务的错误描述
jobid任务id
doc_name文档名称
doc_size文档大小,单位字节,仅当printer_format为jpg时可以忽略该参数
state打印机二维码中需要透传回去的参数
printer_format本任务的格式,目前仅支持pdf和jpg
pic_file_list每一页的文件,仅当printer_format为jpg时有效
pic_file_list: size数组大小
pic_file_list: item数组中的元素
idx每个元素的索引,目前排序与文件页码相同(索引从0开始计数)
pic_size每个元素的文件大小,单位字节
setting_list该任务的一些设置,所有设置都是key-value对
key设置项名称,字符串类型,utf8编码
value设置项的值,字符串数组,utf8编码,可以表示复选值
上一篇获取身份验证二维码
下一篇下载打印文件
    本节内容
硬件直连接入
更新日志
联系我们