添加文档
添加文档及其可选元数据和可选缩略图。 DocumentGUID 在响应中返回。
网址:
发布 http://api.aurelon.com/api/v2/document
请求标头:
内容类型:多部分/表单数据
MisKey :见认证
HardwareHash :见认证
序列号:见认证
应用程序版本:请参阅身份验证
请求正文:
表格数据1:必填
-
- 名称:JsonString
- 内容类型:应用程序/json
- JSON 对象包含:
- DocumentGUID – 可选 – 文档 GUID,指定时使用此 GUID,如果存在,则添加同一文档的新修订版并使其成为当前版本。
- 名称– 必填 – 文件名称
- 类型– 必填 – 文档的内容类型
- Meta – 包含文档元数据的 JSON 对象
- 尺寸– 以单位为单位的文档大小
表单数据2:可选
-
- 名称:文档的原始名称
- 内容类型:应用程序/八位字节流
- 文档的二进制内容
表格数据3:可选
-
- 名称:缩略图.png
- 内容类型:图片/png
- 文档缩略图的二进制内容
回复:
包含操作结果的内容类型 application/json。
成功:
- 200 OK : {“Message”:”文档保存成功”, “DocumentGUID”:”00000000-0000-0000-0000-000000000000″}
错误:
- 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
- 401 Unauthorized : {“Message”:”Invalid MisKey”}
- 415 不支持的媒体类型: {“消息”:“此请求格式不正确”}
- 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
- 500 内部服务器错误: {“消息”:“内部服务器错误”}
获取文档列表
获取组织中所有文档的过滤列表
网址:
发布 http://api.aurelon.com/api/v2/document/list
请求标头:
内容类型:应用程序/json
MisKey :见认证
HardwareHash :见认证
序列号:见认证
应用程序版本:请参阅身份验证
请求正文:
包含以下一个或多个过滤器的 JSON 对象:
- 序列号
- 工作
- 作业GUID
- 设备
- 设备GUID
- 媒体类型
- 媒体尺寸
- 队列
- 用户
- 制片人
- StatusList – 具有以下状态的数组 (错误, 等待, 进行中, 完全的, 取消, 已删除, 打印请求, 不支持).
以下状态区分活动作业和完成作业:
- 活动作业(错误、等待、进行中、已取消、PrintRequest 和 NotSupported 状态)
- 已完成的作业(已完成、已删除)
前任:
{“SerialNumber”:336484,”StatusList”:[“Waiting”,”Error”],”Producer”:”Editor”}
回复:
返回由请求正文过滤器过滤的公司职位
成功:
- 200 OK : 返回工作列表
[{
“DocumentGUID”: “3dfd53fd-2d6b-11e6-853c-793ef2c92c66”,
“文档”:“Ducky.tif”,
“工作”: [
“29F9ED80-F45D-4A2B-B067-BDD638D1E6FD”,
“29680F35-4C41-4025-8915-3C688DABD456”
],
“设备”: [
“03ca4950-0f14-4e58-9bf9-a036c2e1b316”,
“0cc6bcfe-8ada-4c4a-852a-952d720d3b51”
],
“媒体”: [“10 英寸卷”, “17 英寸卷”],
“MediaType”: [“SemiMatte 250g/m2”],
“队列”:[“AD3AFA36-BF8B-4AE7-9553-206A0AD339B8”],
“状态”:“进行中”,
“用户”:[“wendell.lucas”],
“制片人”:“Hotfolder”,
“进度”:70
}, {
“DocumentGUID”: “a7dcef15-7283-4eb1-ac96-94a6d5e859bd”,
“文档”:“柠檬水.jpg”,
“工作”: [
“65eec7e8-c05b-429c-8b8a-8ce16fc55010”,
“d43e9158-39c1-46b9-98b3-3418126e5255”
}],
“媒体”: [“100 英寸卷”],
“MediaType”: [“Paper 250g 09.05.2016”],
“队列”: [],
“状态”:“完成”,
“用户”:[“julia.bailey”],
“制片人”:“布局”,
“进度”:0
}]
错误:
- 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
- 401 Unauthorized : {“Message”:”Invalid MisKey”}
- 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
- 400 错误请求: {“Message”:””DocumentGUID” value required”}
- 415 不支持的媒体类型: {“消息”:“预期类型:应用程序/json”}
- 500 内部服务器错误: {“消息”:“内部服务器错误”}
设置文档缩略图
添加或替换现有文档的缩略图。 缩略图需要是 RGB 或 RGBA PNG。
网址:
发布:http://api.aurelon.com/api/v2/document/thumbnail
请求标头:
内容类型:多部分/表单数据
MisKey :见认证
HardwareHash :见认证
序列号:见认证
应用程序版本:请参阅身份验证
请求正文:
表格数据1:必填
- 名称:JsonString
- 内容类型:应用程序/json
- JSON 对象包含:
- DocumentGUID – 必需 – 文档 GUID
- PageNumber –从 1 到缩略图所属文档页数的整数。
前任:
{“DocumentGUID”:”00092EA6-fb01-11e5-9b85-793ef2c92c66″,”PageNumber”:1}
表格数据2:必填
- 名称:缩略图.png
- 内容类型:图片/png
- PNG的二进制内容
回复:
包含操作结果的内容类型 application/json。
成功:
- 200 OK : {“Message”:”文档缩略图保存成功”}
错误:
- 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
- 401 Unauthorized : {“Message”:”Invalid MisKey”}
- 404 未找到: {“消息”:“未找到 DocumentGUID”}
- 415 不支持的媒体类型: {“消息”:“此请求格式不正确”}
- 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
- 400 错误请求: {“Message”:””DocumentGUID” value required”}
- 500 内部服务器错误: {“消息”:“内部服务器错误”}
获取文档缩略图
获取文档页面的缩略图
网址:
获取 http://api.aurelon.com/api/v2/document/<文档GUID> /缩略图/<页码>
请求标头:
MisKey :见认证
HardwareHash :见认证
序列号:见认证
应用程序版本:请参阅身份验证
回复:
内容类型为 image/png,包含页面缩略图的 PNG。 或内容类型为 application/json 时出现错误内容。
成功:
- 200 OK:文档页面 PNG 缩略图
错误:
- 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
- 401 Unauthorized : {“Message”:”Invalid MisKey”}
- 404 未找到: {“消息”:“未找到 DocumentGUID”}
- 400 错误请求: {“Message”:”PageNumber is not found”}
- 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
- 500 内部服务器错误: {“消息”:“内部服务器错误”}