Adicionar documento
Adiciona um documento juntamente com os seus metadados opcionais e uma miniatura opcional. O DocumentGUID é devolvido na resposta.
URL:
PÓS http://api.aurelon.com/api/v2/document
Pedir cabeçalhos:
Content-Type : dados multipartes/formato
MisKey : ver Autenticação
HardwareHash : ver Autenticação
SerialNumber : ver Autenticação
ApplicationVersion : ver Autenticação
Pedido de corpo:
Dados do formulário 1: necessário
-
- Nome: JsonString
- Tipo de conteúdo: aplicação/json
- JSON Objecto contendo:
- DocumentGUID – opcional – o GUIA DO DOCUMENTO, quando especificado este GUID é utilizado e se existir uma nova revisão do mesmo documento é adicionada e tornada actual.
- Nome – obrigatório – nome do documento
- Tipo – necessário – tipo de conteúdo do documento
- Meta – JSON objecto contendo os metadados sobre o documento
- Dimensões – Tamanho do documento em unidades
Dados do formulário 2: opcional
-
- Nome: Nome original do documento
- Tipo de conteúdo: aplicação/octet-stream
- Conteúdo binário do documento
Dados do formulário 3: opcional
-
- Nome: Thumbnail.png
- Content-Type: imagem/png
- Conteúdo binário do thumbnail do documento
Resposta:
Aplicação do tipo de conteúdo/json contendo o resultado da operação.
O sucesso:
- 200 OK : {“Message”:”Document successfully saved”, “DocumentGUID”:”00000000-0000-0000-0000-000000000000″}
Erro:
- 401 Não Autorizado : {“Mensagem”: “Invalid HardwareHash”}
- 401 Não Autorizado : {“Mensagem”: “Inválido MisKey”}
- 415 Tipo de meios de comunicação não suportados : {“Mensagem”: “Este pedido não está devidamente formatado”}
- 401 Não Autorizado : {“Mensagem”: “”MisKey” ou “HardwareHash”, cabeçalho “SerialNumber” e “ApplicationVersion” são necessários”}
- 500 Erro do Servidor Interno : {“Mensagem”: “Erro do Servidor Interno”}
Obter Lista de Documentos
Obter uma lista filtrada de todos os documentos da organização
URL:
PÓS-QUADRO http://api.aurelon.com/api/v2/document/list
Pedir cabeçalhos:
Content-Type : aplicação/json
MisKey : ver Autenticação
HardwareHash : ver Autenticação
SerialNumber : ver Autenticação
ApplicationVersion : ver Autenticação
Pedido de corpo:
Objecto JSON contendo um ou mais dos seguintes filtros:
- SerialNumber
- Emprego
- JobGUID
- Dispositivo
- DeviceGUID
- MediaType
- MediaSize
- Fila
- Utilizador
- Produtor
- StatusList – um conjunto com os seguintes estatutos (Erro, À espera, InProgress, Concluído, Cancelado, Eliminado, PrintRequest, NãoSuportado).
Onde os seguintes estatutos diferenciam entre empregos activos e empregos completos:
- Activo empregos (Erro, Espera, InProgressar, Cancelado, Solicitação de Impressão e Status NãoSuportado)
- Concluído trabalho (Concluído, Apagado)
Ex:
{“SerialNumber”:336484, “StatusList”:[“Waiting”, “Error”], “Producer”: “Editor”}
Resposta:
Devolver os trabalhos da empresa filtrados por pedido de filtro corporal
O sucesso:
- 200 OK : Lista de empregos de retorno
[{
“DocumentGUID”: “3dfd53fd-2d6b-11e6-853c-793ef2c92c66”,
“Documento”: “Ducky.tif”,
“Empregos”: [
“29F9ED80-F45D-4A2B-B067-BDD638D1E6FD”,
“29680F35-4C41-4025-8915-3C688DABD456”
],
“Dispositivos”: [
“03ca4950-0f14-4e58-9bf9-a036c2e1b316”,
“0cc6bcfe-8ada-4c4a-852a-952d720d3b51”
],
“Media”: [“Rolo 10 polegadas”, “Rolo 17 polegadas”],
“MediaType”: [“SemiMatte 250g/m2”],
“Fila de espera”: [“AD3AFA36-BF8B-4AE7-9553-206A0AD339B8” ],
“Estado”: “InProgress”,
“Utilizadores”: [“wendell.lucas”],
“Produtor”: “Pasta quente”,
“Progresso”: 70
}, {
“DocumentGUID”: “a7dcef15-7283-4eb1-ac96-94a6d5e859bd”,
“Documento”: “Lemonade.jpg”,
“Empregos”: [
“65eec7e8-c05b-429c-8b8a-8ce16fc55010”,
“d43e9158-39c1-46b9-98b3-3418126e5255”
}],
“Media”: [“rolo de 100 polegadas”],
“MediaType”: [“Paper 250g 09.05.2016”],
“Fila de espera”: [],
“Estado”: “Concluído”,
“Utilizadores”: [“julia.bailey”],
“Produtor”: “Layout”,
“Progresso”: 0
}]
Erro:
- 401 Não Autorizado : {“Mensagem”: “Invalid HardwareHash”}
- 401 Não Autorizado : {“Mensagem”: “Inválido MisKey”}
- 401 Não Autorizado : {“Mensagem”: “”MisKey” ou “HardwareHash”, cabeçalho “SerialNumber” e “ApplicationVersion” são necessários”}
- 400 Mau Pedido : {“Message”:””DocumentGUID” valor requerido”}
- 415 Tipo de meios de comunicação não suportados : {“Mensagem”: “Tipo esperado: aplicação/json”}
- 500 Erro do Servidor Interno : {“Mensagem”: “Erro do Servidor Interno”}
Conjunto de miniaturas de documentos
Adiciona ou substitui uma miniatura de um documento existente. A miniatura tem de ser um RGB ou RGBA PNG.
URL:
POST: http://api.aurelon.com/api/v2/document/thumbnail
Pedir cabeçalhos:
Content-Type : dados multipartes/formato
MisKey : ver Autenticação
HardwareHash : ver Autenticação
SerialNumber : ver Autenticação
ApplicationVersion : ver Autenticação
Pedido de corpo:
Dados do formulário 1: necessário
- Nome: JsonString
- Tipo de conteúdo: aplicação/json
- Objecto JSON contendo:
- DocumentGUID – necessário – o documento GUIA
- PageNumber – número inteiro de 1 até à contagem da página a que pertence a miniatura do documento.
Ex:
{“DocumentGUID”:”00092EA6-fb01-11e5-9b85-793ef2c92c66″,”PageNumber”:1}
Dados do formulário 2: necessário
- Nome: Thumbnail.png
- Content-Type: imagem/png
- Conteúdo binário da PNG
Resposta:
Aplicação do tipo de conteúdo/json contendo o resultado da operação.
O sucesso:
- 200 OK : {“Mensagem”: “Miniatura de documento guardada com sucesso”}
Erro:
- 401 Não Autorizado : {“Mensagem”: “Invalid HardwareHash”}
- 401 Não Autorizado : {“Mensagem”: “Inválido MisKey”}
- 404 Não Encontrado : {“Mensagem”: “DocumentGUID não foi encontrado”}
- 415 Tipo de meios de comunicação não suportados : {“Mensagem”: “Este pedido não está devidamente formatado”}
- 401 Não Autorizado : {“Mensagem”: “”MisKey” ou “HardwareHash”, cabeçalho “SerialNumber” e “ApplicationVersion” são necessários”}
- 400 Mau Pedido : {“Message”:””DocumentGUID” valor requerido”}
- 500 Erro do Servidor Interno : {“Mensagem”: “Erro do Servidor Interno”}
Obter miniatura de documento
Obter a miniatura de uma página do documento
URL:
GET< DocumentGUID>/thumbnail/ <PageNumber>
Pedir cabeçalhos:
MisKey : ver Autenticação
HardwareHash : ver Autenticação
SerialNumber : ver Autenticação
ApplicationVersion : ver Autenticação
Resposta:
O tipo de conteúdo é imagem/png e contém a PNG da miniatura da página. Ou tipo de aplicação de conteúdo/json quando com o conteúdo de erro.
O sucesso:
- 200 OK : Página do documento PNG thumbnail
Erro:
- 401 Não Autorizado : {“Mensagem”: “Invalid HardwareHash”}
- 401 Não Autorizado : {“Mensagem”: “Inválido MisKey”}
- 404 Não Encontrado : {“Mensagem”: “DocumentGUID não foi encontrado”}
- 400 Mau Pedido : {“Mensagem”: “PageNumber não é encontrado”}
- 401 Não Autorizado : {“Mensagem”: “”MisKey” ou “HardwareHash”, cabeçalho “SerialNumber” e “ApplicationVersion” são necessários”}
- 500 Erro do Servidor Interno : {“Mensagem”: “Erro do Servidor Interno”}