Documentos

Añadir documento

Añade un documento junto con sus metadatos opcionales y una miniatura opcional. El DocumentGUID se devuelve en la respuesta.
 
URL:
POST http://api.aurelon.com/api/v2/document
 
Cabeceras de solicitud:
Tipo de contenido : multipart/form-data
MisKey : ver Autenticación
HardwareHash : ver Autenticación
Número de serie : ver Autenticación
AplicaciónVersión : ver Autenticación
 
Cuerpo de la solicitud:
Datos del formulario 1: obligatorio

    • Nombre: JsonString
    • Content-Type: application/json
  • Objeto JSON que contiene:
  • DocumentGUID – opcional – el GUID del documento, cuando se especifica este GUID se utiliza y si existe se añade una nueva revisión del mismo documento y se hace actual.
    • Nombre – obligatorio – nombre del documento
  • Tipo – obligatorio – tipo de contenido del documento
  • Meta – Objeto JSON que contiene los metadatos del documento
  • Dimensiones – Tamaño del documento en unidades

 
 
Datos del formulario 2: opcional

    • Nombre: Nombre original del documento
    • Content-Type: application/octet-stream
  • Contenido binario del documento

 
Datos del formulario 3: opcional

    • Nombre: Thumbnail.png
    • Tipo de contenido: image/png
  • Contenido binario de la miniatura del documento

 
Respuesta:
Tipo de contenido application/json que contiene el resultado de la operación.
 
El éxito:

  • 200 OK : {«Message»:»Document successfully saved», «DocumentGUID»:»00000000-0000-0000-0000-000000000000″}

 
Error:

  • 401 No autorizado : {«Mensaje»: «HardwareHash inválido»}
  • 401 No autorizado : {«Mensaje»: «Clave errónea inválida»}
  • 415 Tipo de medio no soportado : {«Mensaje»: «Esta solicitud no tiene el formato adecuado»}
  • 401 No autorizado : {«Mensaje»: «»MisKey» o «HardwareHash», «SerialNumber» y «ApplicationVersion» son obligatorios»}
  • 500 Internal Server Error : {«Mensaje»: «Error interno del servidor»}

 

Obtener la lista de documentos

Obtener una lista filtrada de todos los documentos de la organización
 
URL:
POST http://api.aurelon.com/api/v2/document/list
 
Cabeceras de solicitud:
Tipo de contenido : application/json
MisKey : ver Autenticación
HardwareHash : ver Autenticación
Número de serie : ver Autenticación
AplicaciónVersión : ver Autenticación
 
Cuerpo de la solicitud:
Objeto JSON que contiene uno o más de los siguientes filtros:

  • Número de serie
  • Trabajo
  • JobGUID
  • Dispositivo
  • DeviceGUID
  • MediaType
  • MediaSize
  • Cola de espera
  • Usuario
  • Productor
  • StatusList – una matriz con los siguientes estados (Error, Esperando, En progreso, Completado, Cancelado, Borrado, Solicitud de impresión, NotSupported).

Los siguientes estados diferencian entre trabajos activos y completos:

  • Activo trabajos (estados Error, En espera, En curso, Cancelado, Solicitud de impresión y No admitido)
  • Completado trabajo (Completado, Borrado)

 
Ex:
{«SerialNumber»:336484, «StatusList»:[«Waiting», «Error»], «Producer»: «Editor»}
 
Respuesta:
Devuelve los trabajos de la empresa filtrados por el filtro del cuerpo de la solicitud
 
El éxito:

  • 200 OK : Devuelve la lista de trabajos

[{
«DocumentGUID»: «3dfd53fd-2d6b-11e6-853c-793ef2c92c66»,
«Documento»: «Ducky.tif»,
«Trabajos»: [
«29F9ED80-F45D-4A2B-B067-BDD638D1E6FD»,
«29680F35-4C41-4025-8915-3C688DABD456»
],
«Dispositivos»: [
«03ca4950-0f14-4e58-9bf9-a036c2e1b316»,
«0cc6bcfe-8ada-4c4a-852a-952d720d3b51»
],
«Medios»: [«Rollo de 10 pulgadas», «Rollo de 17 pulgadas»],
«MediaType»: [«SemiMatte 250g/m2»],
«Cola»: [ «AD3AFA36-BF8B-4AE7-9553-206A0AD339B8» ],
«Estado»: «InProgress»,
«Usuarios»: [«wendell.lucas»],
«Productor»: «Carpeta caliente»,
«Progreso»: 70
}, {
«DocumentGUID»: «a7dcef15-7283-4eb1-ac96-94a6d5e859bd»,
«Documento»: «Limonada.jpg»,
«Trabajos»: [
«65eec7e8-c05b-429c-8b8a-8ce16fc55010»,
«d43e9158-39c1-46b9-98b3-3418126e5255»
}],
«Medios»: [«rollo de 100 pulgadas»],
«MediaType»: [«Papel 250g 09.05.2016»],
«Cola»: [],
«Estado»: «Completado»,
«Usuarios»: [«julia.bailey»],
«Productor»: «Diseño»,
«Progreso»: 0
}]
 
Error:

  • 401 No autorizado : {«Mensaje»: «HardwareHash inválido»}
  • 401 No autorizado : {«Mensaje»: «Clave errónea inválida»}
  • 401 No autorizado : {«Mensaje»: «»MisKey» o «HardwareHash», «SerialNumber» y «ApplicationVersion» son obligatorios»}
  • 400 Bad Request : {«Mensaje»:»»DocumentGUID» valor requerido»}
  • 415 Tipo de medio no soportado : {«Mensaje»: «Tipo esperado: application/json»}
  • 500 Internal Server Error : {«Mensaje»: «Error interno del servidor»}

Establecer la miniatura del documento

Añade o sustituye una miniatura de un documento existente. La miniatura debe ser un PNG RGB o RGBA.
 
URL:
POST: http://api.aurelon.com/api/v2/document/thumbnail
 
Cabeceras de solicitud:
Tipo de contenido : multipart/form-data
MisKey : ver Autenticación
HardwareHash : ver Autenticación
Número de serie : ver Autenticación
AplicaciónVersión : ver Autenticación
 
Cuerpo de la solicitud:
Datos del formulario 1: obligatorio

  • Nombre: JsonString
  • Content-Type: application/json
  • Objeto JSON que contiene:
  • DocumentGUID – requerido – el GUID del documento
  • Número de página número entero de 1 a número de página la página del documento al que pertenece la miniatura.

 
Ex:
{«DocumentGUID»:»00092EA6-fb01-11e5-9b85-793ef2c92c66″,»PageNumber»:1}
Datos del formulario 2: obligatorio

  • Nombre: Thumbnail.png
  • Tipo de contenido: image/png
  • Contenido binario del PNG

 
Respuesta:
Tipo de contenido application/json que contiene el resultado de la operación.
 
El éxito:

  • 200 OK : {«Message»: «Document thumbnail successfully saved»}

 
Error:

  • 401 No autorizado : {«Mensaje»: «HardwareHash inválido»}
  • 401 No autorizado : {«Mensaje»: «Clave errónea inválida»}
  • 404 No se encuentra : {«Mensaje»: «No se encuentra el DocumentGUID»}
  • 415 Tipo de medio no soportado : {«Mensaje»: «Esta solicitud no tiene el formato adecuado»}
  • 401 No autorizado : {«Mensaje»: «»MisKey» o «HardwareHash», «SerialNumber» y «ApplicationVersion» son obligatorios»}
  • 400 Bad Request : {«Mensaje»:»»DocumentGUID» valor requerido»}
  • 500 Internal Server Error : {«Mensaje»: «Error interno del servidor»}

 

Obtener la miniatura del documento

Obtener la miniatura de una página del documento
 
URL:
GET http://api.aurelon.com/api/v2/document/<DocumentGUID>/thumbnail/ <PageNumber>
 
Cabeceras de solicitud:
MisKey : ver Autenticación
HardwareHash : ver Autenticación
Número de serie : ver Autenticación
AplicaciónVersión : ver Autenticación
 
Respuesta:
El tipo de contenido es image/png y contiene el PNG de la miniatura de la página. O el tipo de contenido application/json cuando con el contenido de error.
 
El éxito:

  • 200 OK : Miniatura PNG de la página del documento

 
Error:

  • 401 No autorizado : {«Mensaje»: «HardwareHash inválido»}
  • 401 No autorizado : {«Mensaje»: «Clave errónea inválida»}
  • 404 No se encuentra : {«Mensaje»: «No se encuentra el DocumentGUID»}
  • 400 Bad Request : {«Mensaje»: «Número de página no se encuentra»}
  • 401 No autorizado : {«Mensaje»: «»MisKey» o «HardwareHash», «SerialNumber» y «ApplicationVersion» son obligatorios»}
  • 500 Internal Server Error : {«Mensaje»: «Error interno del servidor»}
Updated on mayo 10, 2022

Was this article helpful?