Jobs Sync
Liste der aktiven Aufträge in einem RIP synchronisieren
URL:
POST http://api.aurelon.com/
api/v2/job/sync
Kopfzeilen anfordern:
Inhalt-Typ : application/json
HardwareHash : siehe Authentifizierung
SerienNummer : siehe Authentifizierung
AnwendungsVersion : siehe Authentifizierung
Anfrage Körper:
JSON-Objekt enthält:
- ComputerGUID – erforderlich – die Computer-GUID
- JobsList – erforderlich – Array der aktiven JobGUIDs am RIP
Antwort:
Inhaltstyp application/json, der das Ergebnis der Operation enthält.
Erfolg:
- 200 OK : „Auftragsstatus erfolgreich synchronisiert“
Fehler:
- 401 Nicht autorisiert : {„Meldung“: „Ungültiger HardwareHash“}
- 404 Nicht gefunden : {„Meldung“: „ComputerGUID wird nicht gefunden“}
- 415 Nicht unterstützter Medientyp : {„Message“: „Erwarteter Typ: application/json“}
- 401 Nicht autorisiert : {„Meldung“: „“HardwareHash“, „SerialNumber“ und „ApplicationVersion“ header are required“}
- 400 Bad Request : {„Message“:““ComputerGUID“ Wert erforderlich“}
- 400 Bad Request : {„Message“:““JobsList“ Wert erforderlich“}
- 500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}
Job hinzufügen/aktualisieren
Fügt einen Auftrag hinzu oder aktualisiert einen Auftrag, wie durch JobGUID im Body angegeben. Die Informationen über den Auftrag werden aus der Datei Job.xml extrahiert.
URL:
POST: http://api.aurelon.com/api/v2/job
Kopfzeilen anfordern:
Inhalt-Typ : Anwendung/xml
MisKey : siehe Authentifizierung
HardwareHash : siehe Authentifizierung
SerienNummer : siehe Authentifizierung
AnwendungsVersion : siehe Authentifizierung
Anfrage Körper:
Job XML (siehe
Job-XML-Spezifikation
)
Antwort:
Inhaltstyp application/json, der das Ergebnis der Operation enthält.
Erfolg:
- 200 OK : „Auftrag erfolgreich gespeichert“
Fehler:
- 401 Nicht autorisiert : {„Meldung“: „Ungültiger HardwareHash“}
- 401 Nicht autorisiert : {„Message“: „Ungültiger MisKey“}
- 404 Nicht gefunden : {„Meldung“: „DeviceGUID wird nicht gefunden“}
- 415 Nicht unterstützter Medientyp : {„Meldung“: „Erwarteter Typ: application/xml“}
- 401 Nicht autorisiert : {„Meldung“: „“MisKey“ oder „HardwareHash“, „SerialNumber“ und „ApplicationVersion“ header are required“}
- 400 Bad Request : {„Message“:““DeviceGUID“-Wert in xml erforderlich“}
- 500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}
Beispiel für Job-XML:
hier
Auftrag mit Dokument hinzufügen
Fügt einen Auftrag aus einer job.xml und 1 Dokument hinzu. Dieser Aufruf ersetzt den Link des eingebetteten Dokuments durch die DocumentGUID, die dem Dokument zugewiesen ist. Die DocumentGUID wird in der Antwort zurückgegeben.
URL:
POST: http://api.aurelon.com/api/v2/job
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: Job.xml
- Inhalt-Typ: application/xml
- Job XML (siehe
Job-XML-Spezifikation
)
Formulardaten 2: erforderlich
-
- Name: Originalname des Dokuments
- Inhalt-Typ: application/pdf oder image/<format>
- Binärer Inhalt des Dokuments
Antwort:
Inhaltstyp application/json, der das Ergebnis der Operation enthält.
Erfolg:
- 200 OK : {„Message“:“Job successfully saved“, „DocumentGUID“:“00000000-0000-0000-0000-000000000000″}
Fehler:
- 401 Nicht autorisiert : {„Meldung“: „Ungültiger HardwareHash“}
- 401 Nicht autorisiert : {„Message“: „Ungültiger MisKey“}
- 404 Nicht gefunden : {„Meldung“: „DeviceGUID 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“:““DeviceGUID“-Wert in xml erforderlich“}
- 500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}
Beispiel für Job-XML:
hier
Auftragsstatus aktualisieren
Die Informationen über den Auftrag werden aus der Datei Job.xml extrahiert.
URL:
POST: http://api.aurelon.com/api/v2/job/status
Kopfzeilen anfordern:
Inhalt-Typ : application/json
MisKey : siehe Authentifizierung
HardwareHash : siehe Authentifizierung
SerienNummer : siehe Authentifizierung
AnwendungsVersion : siehe Authentifizierung
Anfrage Körper:
JSON-Objekt enthält:
- JobGUID – erforderlich – die Job-GUID
-
- StatusSpooler – einer der Status „Warten“, „Halten“, „Warnung“, „Spooling“, „Bearbeitung“, „Abbruch“, „Bereit“, „Löschen“, „NotSupported“
- Fortschritt – Ganzzahlige Zahl von 0 bis 100, die den Prozentsatz des Druckfortschritts angibt.
- ProgressLabel – Zeichenkette mit zusätzlichen Fortschrittsinformationen
Ex:
{„JobGUID“:“00092EA6-fb01-11e5-9b85-793ef2c92c66″,“StatusSpooler“:“Processing“,“Progress“:30}
Antwort:
Inhaltstyp application/json, der das Ergebnis der Operation enthält.
Erfolg:
- 200 OK : „Auftrag erfolgreich gespeichert“
Fehler:
- 401 Nicht autorisiert : {„Meldung“: „Ungültiger HardwareHash“}
- 401 Nicht autorisiert : {„Message“: „Ungültiger MisKey“}
- 404 Nicht gefunden : {„Meldung“: „JobGUID wurde nicht gefunden“}
- 415 Nicht unterstützter Medientyp : {„Message“: „Erwarteter Typ: application/json“}
- 401 Nicht autorisiert : {„Meldung“: „“MisKey“ oder „HardwareHash“, „SerialNumber“ und „ApplicationVersion“ header are required“}
- 400 Schlechte Anfrage : {„Message“:““JobGUID“ Wert erforderlich“}
- 500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}
Job-Miniaturansicht einstellen
Hinzufügen oder Ersetzen einer Miniaturansicht eines bestehenden Auftrags. Die Miniaturansicht muss ein RGB- oder RGBA-PNG sein.
URL:
POST: http://api.aurelon.com/api/v2/job/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:
- JobGUID – erforderlich – die Job-GUID
- Seitennummer – Ganzzahlige Zahl von 1 bis Seitenzahl der Seite des Auftrags, zu der die Miniaturansicht gehört.
Ex:
{„JobGUID“:“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“: „Job-Thumbnail erfolgreich gespeichert“}
Fehler:
- 401 Nicht autorisiert : {„Meldung“: „Ungültiger HardwareHash“}
- 401 Nicht autorisiert : {„Message“: „Ungültiger MisKey“}
- 404 Nicht gefunden : {„Meldung“: „JobGUID wurde 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“}
Jobliste abrufen
Erhalten Sie eine gefilterte Liste aller Stellen im Unternehmen
URL:
POST http://api.aurelon.com/api/v2/job/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
- DokumentGUID
- 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
[{
„JobGUID“: „88de5c02-cce6-411f-950f-be309caa4439“,
„JobName“: „acox3“,
„Dokumente“: [{
„DocumentGUID“: „f6f2e084-d649-4ba7-ade3-f616657b8c8f“,
„Name“: „acox.jpg“
}],
„Gerät“: „Epson Stylus Pro 4800“,
„GeräteGUID“: „e9af1259-5da3-46a7-bc00-84839d1f3dd6“,
„CreatedDate“: „2016-05-18T06:59:36.727“,
„MediaType“: „ProofMaster Contract Proofing Media SemiGloss 265g“,
„MediaSize“: „Rolle 17 Zoll“,
„Warteschlangen-GUID“: null,
„Warteschlangenname“: null,
„Status“: „Abgeschlossen“,
„Benutzer“: „karl.dunn“,
„Hersteller“: „Layout“,
„Fortschritt“: null
}, {
„JobGUID“: „cc14e944-1e6b-4274-a9b2-38e5721f8f81“,
„JobName“: „apocalypse_2-wallpaper-1920×1080“,
„Dokumente“: [{
„DocumentGUID“: „44555edc-4a25-418f-8c04-1b8311c002a3“,
„Wert“: „apocalypse_2-wallpaper-1920×1080.jpg“
}],
„Gerät“: „Epson Stylus Pro 4800“,
„GeräteGUID“: „ab100a61-9c81-4e1e-aa97-6b07f4046c7a“,
„CreatedDate“: „2016-05-18T06:57:24.427“,
„MediaType“: „ProofMaster Contract Proofing Media SemiGloss 265g“,
„MediaSize“: „Rolle 17 Zoll“,
„Warteschlangen-GUID“: null,
„Warteschlangenname“: null,
„Status“: „Gelöscht“,
„Benutzer“: „lisa.santiago“,
„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“}
- 415 Nicht unterstützter Medientyp : {„Message“: „Erwarteter Typ: application/json“}
- 500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}
Auftragsstatus abrufen
Informationen zum Auftragsstatus abrufen
URL:
GET http://api.aurelon.com/api/v2/job/<JobGUID>/status
Kopfzeilen anfordern:
MisKey : siehe Authentifizierung
HardwareHash : siehe Authentifizierung
SerienNummer : siehe Authentifizierung
AnwendungsVersion : siehe Authentifizierung
Antwort:
Rückgabe von Informationen zu dem durch JobGUID angegebenen Auftrag.
Erfolg:
- 200 OK : Auftragsinfo zurücksenden
{
„Info“: {
„GeräteGUID“: „9B5A192A-272f-11e6-853c-793ef2c92c66“,
„Gerätename“: „PDF CMYK A3+“,
„Warteschlangen-GUID“: null,
„Warteschlangenname“: null,
„Beruf“: „Ducky“,
„Status“: „Abgeschlossen“,
„Benutzer“: „a.f.d“,
„Seiten“: 1,
„Kopien“: 1,
„Größe“: „9,0 MB“,
„Nachricht“: „“,
„PrintMode“: „16pt_C1S > CMYK_GRACoL_600x600“,
„DruckerProfil“: „Standard“,
„DriverSettings“: „X_resolution=DPI=600, \r\nY_resolution=,600 , \r\nInkSet=INK=CMYK „,
„Vorschau“: „https://hub-datacollection./jobs/3dfd53fd-2d6b-11e6-853c-793ef2c92c66/00e2b84a-295e-11e6-853c-793ef2c92c66_thumbnail.png“
},
„Dokumente“: [„Ducky.tif“, „Sticker.tif“, „Tutti-Frutti-9.jpg“],
„Zeit“: {
„Bearbeitungszeit“: „00:00:28“,
„PrintingOrCuttingTime“: „00:00:06“
},
„Zeitschrift“: [{
„Datum“: „2016-06-03T07:37:46Z“,
„Dauer“: „00:00:06“,
„Prozess“: „Spooler“,
„Nachricht“: null
}, {
„Datum“: „2016-06-03T07:37:22Z“,
„Dauer“: „00:00:28“,
„Prozess“: „RIP“,
„Nachricht“: null
}],
„Tinte“: [{
„Name“: „Cyan“,
„VerbrauchteTinte“: null,
„Kosten“: null
}, {
„Name“: „Magenta“,
„VerbrauchteTinte“: null,
„Kosten“: null
}, {
„Name“: „Gelb“,
„VerbrauchteTinte“: null,
„Kosten“: null
}, {
„Name“: „Schwarz“,
„VerbrauchteTinte“: null,
„Kosten“: null
}],
„Medien“: {
„MediaSize“: „A3+“,
„MediaType“: „16pt_C1S“,
„VerwendeteMediaLänge“: null,
„GenutzteMedienflächeBrutto“: 1.72,
„Effizienz“: 9.7,
„Kosten“: null,
„BenutzteMedienblätter“: „1 Stück“,
„JobMediaPriceListName“: null
},
„Nest“: null
}
Fehler:
- 401 Nicht autorisiert : {„Meldung“: „Ungültiger HardwareHash“}
- 401 Nicht autorisiert : {„Message“: „Ungültiger MisKey“}
- 404 Nicht gefunden : {„Meldung“: „JobGUID wurde nicht gefunden“}
- 401 Nicht autorisiert : {„Meldung“: „“MisKey“ oder „HardwareHash“, „SerialNumber“ und „ApplicationVersion“ header are required“}
- 500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}
Auftrag erhalten
Job XML abrufen
URL:
GET http://api.aurelon.com/api/v2/job/<JobGUID>
Kopfzeilen anfordern:
MisKey : siehe Authentifizierung
HardwareHash : siehe Authentifizierung
SerienNummer : siehe Authentifizierung
AnwendungsVersion : siehe Authentifizierung
Antwort:
Der Inhaltstyp ist application/xml und enthält die XML-Datei des Auftrags. Oder der Inhaltstyp application/json, wenn es sich um einen Fehlerinhalt handelt.
Erfolg:
- 200 OK : Auftrag XML
Fehler:
- 401 Nicht autorisiert : {„Meldung“: „Ungültiger HardwareHash“}
- 401 Nicht autorisiert : {„Message“: „Ungültiger MisKey“}
- 404 Nicht gefunden : {„Meldung“: „JobGUID wurde nicht gefunden“}
- 401 Nicht autorisiert : {„Meldung“: „“MisKey“ oder „HardwareHash“, „SerialNumber“ und „ApplicationVersion“ header are required“}
- 500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}
Job-Miniaturansicht erhalten
Miniaturansicht einer Seite des Auftrags abrufen
URL:
GET http://api.aurelon.com/api/v2/job/<JobGUID>/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 : Job Page PNG thumbnail
Fehler:
- 401 Nicht autorisiert : {„Meldung“: „Ungültiger HardwareHash“}
- 401 Nicht autorisiert : {„Message“: „Ungültiger MisKey“}
- 404 Nicht gefunden : {„Meldung“: „JobGUID wurde nicht gefunden“}
- 404 Nicht gefunden : {„Message“: „PageNumber wird nicht gefunden“}
- 401 Nicht autorisiert : {„Meldung“: „“MisKey“ oder „HardwareHash“, „SerialNumber“ und „ApplicationVersion“ header are required“}
- 500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}
Kostenvoranschlag anfordern
Kostenvoranschlag für den Auftrag einholen
URL:
GET http://api.aurelon.com/api/v2/job/<JobGUID>/estimate
Kopfzeilen anfordern:
MisKey : siehe Authentifizierung
HardwareHash : siehe Authentifizierung
SerienNummer : siehe Authentifizierung
AnwendungsVersion : siehe Authentifizierung
Antwort:
Der Inhaltstyp ist application/json und enthält die Daten der Auftragsschätzung. Oder der Inhaltstyp application/json, wenn es sich um einen Fehlerinhalt handelt.
Erfolg:
- 200 OK : Auftragsschätzung json
Fehler:
- 401 Nicht autorisiert : {„Meldung“: „Ungültiger HardwareHash“}
- 401 Nicht autorisiert : {„Message“: „Ungültiger MisKey“}
- 404 Nicht gefunden : {„Meldung“: „JobGUID wurde nicht gefunden“}
- 401 Nicht autorisiert : {„Meldung“: „“MisKey“ oder „HardwareHash“, „SerialNumber“ und „ApplicationVersion“ header are required“}
500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}