Dokument hinzufügen
Fügt ein Dokument zusammen mit seinen optionalen Metadaten und einer optionalen Miniaturansicht hinzu. Die DocumentGUID wird in der Antwort zurückgegeben.
URL:
POST http://api.aurelon.com/api/v2/document
Kopfzeilen anfordern:
Inhalt-Typ : multipart/form-data
MisKey : siehe Authentifizierung
HardwareHash : siehe Authentifizierung
SerienNummer : siehe Authentifizierung
AnwendungsVersion : siehe Authentifizierung
Anfrage Körper:
Formulardaten 1: erforderlich
-
- Name: JsonString
- Inhalt-Typ: application/json
- JSON-Objekt enthält:
- DocumentGUID – optional – die GUID des Dokuments. Wenn sie angegeben ist, wird diese GUID verwendet und, falls vorhanden, eine neue Revision desselben Dokuments hinzugefügt und auf den neuesten Stand gebracht.
- Name – erforderlich – Name des Dokuments
- Typ – erforderlich – Inhaltstyp des Dokuments
- Meta – JSON-Objekt, das die Metadaten über das Dokument enthält
- Abmessungen – Größe des Dokuments in Einheiten
Formulardaten 2: fakultativ
-
- Name: Originalname des Dokuments
- Inhalt-Typ: application/octet-stream
- Binärer Inhalt des Dokuments
Formulardaten 3: fakultativ
-
- Name: Vorschaubild.png
- Inhalt-Typ: image/png
- Binärer Inhalt der Miniaturansicht des Dokuments
Antwort:
Inhaltstyp application/json, der das Ergebnis der Operation enthält.
Erfolg:
- 200 OK : {„Message“:“Document successfully saved“, „DocumentGUID“:“00000000-0000-0000-0000-000000000000″}
Fehler:
- 401 Nicht autorisiert : {„Meldung“: „Ungültiger HardwareHash“}
- 401 Nicht autorisiert : {„Message“: „Ungültiger MisKey“}
- 415 Nicht unterstützter Medientyp : {„Message“: „Diese Anfrage ist nicht richtig formatiert“}
- 401 Nicht autorisiert : {„Meldung“: „“MisKey“ oder „HardwareHash“, „SerialNumber“ und „ApplicationVersion“ header are required“}
- 500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}
Dokumentenliste abrufen
Abrufen einer gefilterten Liste aller Dokumente in der Organisation
URL:
POST http://api.aurelon.com/api/v2/document/list
Kopfzeilen anfordern:
Inhalt-Typ : application/json
MisKey : siehe Authentifizierung
HardwareHash : siehe Authentifizierung
SerienNummer : siehe Authentifizierung
AnwendungsVersion : siehe Authentifizierung
Anfrage Körper:
JSON-Objekt, das einen oder mehrere der folgenden Filter enthält:
- SerienNummer
- Job
- JobGUID
- Gerät
- GeräteGUID
- MediaType
- MediaSize
- Warteschlange
- Benutzer
- Produzent
- StatusList – ein Array mit den folgenden Zuständen (Fehler, Warten, InProgress, Abgeschlossen, Abgesagt, Gelöscht, PrintRequest, NotSupported).
Bei den folgenden Status wird zwischen aktiven und abgeschlossenen Aufträgen unterschieden:
- Aktiv Aufträge (Status Error, Waiting, InProgress, Canceled, PrintRequest und NotSupported)
- Erledigt Auftrag (Erledigt, Gelöscht)
Ex:
{„SerialNumber“:336484, „StatusList“:[„Waiting“, „Error“], „Producer“: „Editor“}
Antwort:
Rückgabe der Unternehmensjobs, gefiltert nach dem Filter des Anfragekörpers
Erfolg:
- 200 OK : Rückgabe der Auftragsliste
[{
„DocumentGUID“: „3dfd53fd-2d6b-11e6-853c-793ef2c92c66“,
„Dokument“: „Ducky.tif“,
„Arbeitsplätze“: [
„29F9ED80-F45D-4A2B-B067-BDD638D1E6FD“,
„29680F35-4C41-4025-8915-3C688DABD456“
],
„Geräte“: [
„03ca4950-0f14-4e58-9bf9-a036c2e1b316“,
„0cc6bcfe-8ada-4c4a-852a-952d720d3b51“
],
„Medien“: [„Rolle 10 Zoll“, „Rolle 17 Zoll“],
„MediaType“: [„SemiMatte 250g/m2“],
„Warteschlange“: [ „AD3AFA36-BF8B-4AE7-9553-206A0AD339B8“ ],
„Status“: „Im Gange“,
„Benutzer“: [„wendell.lucas“],
„Hersteller“: „Hotfolder“,
„Fortschritt“: 70
}, {
„DocumentGUID“: „a7dcef15-7283-4eb1-ac96-94a6d5e859bd“,
„Dokument“: „Limonade.jpg“,
„Arbeitsplätze“: [
„65eec7e8-c05b-429c-8b8a-8ce16fc55010“,
„d43e9158-39c1-46b9-98b3-3418126e5255“
}],
„Medien“: [„100-Zoll-Rolle“],
„MediaType“: [„Papier 250g 09.05.2016“],
„Warteschlange“: [],
„Status“: „Abgeschlossen“,
„Benutzer“: [„julia.bailey“],
„Hersteller“: „Layout“,
„Fortschritt“: 0
}]
Fehler:
- 401 Nicht autorisiert : {„Meldung“: „Ungültiger HardwareHash“}
- 401 Nicht autorisiert : {„Message“: „Ungültiger MisKey“}
- 401 Nicht autorisiert : {„Meldung“: „“MisKey“ oder „HardwareHash“, „SerialNumber“ und „ApplicationVersion“ header are required“}
- 400 Bad Request : {„Message“:““DocumentGUID“ Wert erforderlich“}
- 415 Nicht unterstützter Medientyp : {„Message“: „Erwarteter Typ: application/json“}
- 500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}
Dokument-Miniaturansicht festlegen
Hinzufügen oder Ersetzen einer Miniaturansicht eines vorhandenen Dokuments. Die Miniaturansicht muss ein RGB- oder RGBA-PNG sein.
URL:
POST: http://api.aurelon.com/api/v2/document/thumbnail
Kopfzeilen anfordern:
Inhalt-Typ : multipart/form-data
MisKey : siehe Authentifizierung
HardwareHash : siehe Authentifizierung
SerienNummer : siehe Authentifizierung
AnwendungsVersion : siehe Authentifizierung
Anfrage Körper:
Formulardaten 1: erforderlich
- Name: JsonString
- Inhalt-Typ: application/json
- JSON-Objekt enthält:
- DocumentGUID – erforderlich – die GUID des Dokuments
- Seitennummer – Ganzzahlige Zahl von 1 bis Seitenzahl der Seite des Dokuments, zu dem die Miniaturansicht gehört.
Ex:
{„DocumentGUID“:“00092EA6-fb01-11e5-9b85-793ef2c92c66″,“PageNumber“:1}
Formulardaten 2: erforderlich
- Name: Vorschaubild.png
- Inhalt-Typ: image/png
- Binärer Inhalt des PNGs
Antwort:
Inhaltstyp application/json, der das Ergebnis der Operation enthält.
Erfolg:
- 200 OK : {„Message“: „Dokument-Miniaturansicht erfolgreich gespeichert“}
Fehler:
- 401 Nicht autorisiert : {„Meldung“: „Ungültiger HardwareHash“}
- 401 Nicht autorisiert : {„Message“: „Ungültiger MisKey“}
- 404 Nicht gefunden : {„Message“: „DocumentGUID wird nicht gefunden“}
- 415 Nicht unterstützter Medientyp : {„Message“: „Diese Anfrage ist nicht richtig formatiert“}
- 401 Nicht autorisiert : {„Meldung“: „“MisKey“ oder „HardwareHash“, „SerialNumber“ und „ApplicationVersion“ header are required“}
- 400 Bad Request : {„Message“:““DocumentGUID“ Wert erforderlich“}
- 500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}
Dokument-Miniaturansicht abrufen
Miniaturansicht einer Seite des Dokuments abrufen
URL:
GET http://api.aurelon.com/api/v2/document/<DocumentGUID>/thumbnail/ <PageNumber>
Kopfzeilen anfordern:
MisKey : siehe Authentifizierung
HardwareHash : siehe Authentifizierung
SerienNummer : siehe Authentifizierung
AnwendungsVersion : siehe Authentifizierung
Antwort:
Der Inhaltstyp ist image/png und enthält die PNG-Datei der Miniaturansicht der Seite. Oder der Inhaltstyp application/json, wenn es sich um einen Fehlerinhalt handelt.
Erfolg:
- 200 OK : Dokument Seite PNG-Miniaturansicht
Fehler:
- 401 Nicht autorisiert : {„Meldung“: „Ungültiger HardwareHash“}
- 401 Nicht autorisiert : {„Message“: „Ungültiger MisKey“}
- 404 Nicht gefunden : {„Message“: „DocumentGUID wird nicht gefunden“}
- 400 Bad Request : {„Message“: „PageNumber wird nicht gefunden“}
- 401 Nicht autorisiert : {„Meldung“: „“MisKey“ oder „HardwareHash“, „SerialNumber“ und „ApplicationVersion“ header are required“}
- 500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}