Die Auftragsdaten können Wahlweise über einen XML Import (Hotfolder) oder über einen REST Webservice als JSON Struktur übergeben werden.
...
Name | Datentyp | Pflicht | Beschreibung |
---|---|---|---|
Customer.Name | String | ja | Kundenname; max. 256 Zeichen; Freitext |
Customer.Number | String | nein | Kundennummer; max. 64 Zeichen |
Customer.Address | String | ja | Kundenadresse; max. 512 Zeichen; Freitext |
Customer.ContactPerson | String | nein | Kontaktperson des Kunden; max. 256 Zeichen; Freitext |
Customer.PhoneNumber | String | nein | Telefonnummer(n) des Kunden; max. 64 Zeichen |
Customer.Email | String | nein | Emailadresse(n) des Kunden; max. 256 Zeichen |
Customer.PostalAddress | String | nein | Formatierte Postadresse des Kunden; Freitext; CData-Section für Mehrzeiligkeit (siehe Beispiel) |
Layout.Height | Integer | ja | Höhe des Motivs in Mikrometer |
Layout.Width | Integer | ja | Breite des Motivs in Mikrometer |
Layout.CMYK | Byte/Boolean | nein | CMYK-Motiv; 0/1; default = 1 |
Layout.BlackWhite | Byte/Boolean | nein | Graustufen-Motiv; 0/1; default = 0 |
Layout.SpotColors[].SpotColor name | String | nein | Spotfarbnamen; zusammen max. 512 Zeichen |
Order.StudioName | String | ja | Studioname; max. 256 Zeichen |
Order.Number | String | ja | Auftragsnummer; max. 64 Zeichen |
Order.Position | Integer | ja | Auftragsposition |
Order.Priority | Integer | ja | Priorität; 1-N (1 = hoch) |
Order.FinishingDateTime | DateTime | ja | Fertigstellungsdatum zu dem die Gestaltung beendet sein muss |
Order.PublicationDate | Date | nein | Erscheindatum; YYYY-MM-DD |
Order.Edition | String | nein | Ausgabe; max. 256 Zeichen; Freitext |
Order.Rubric | String | nein | Rubrik(en) (z.B. R1 > R2 > ... RN); max. 256 Zeichen; Freitext |
Order.ContactPerson | String | nein | Kontaktperson des Verlags (Name, Email, Telnr.); max. 256 Zeichen |
Order.OrderGroup | String | nein | Gruppierung von Gestaltungsaufrägen (z.B. Kollektiv-Kennung); max 32 Zeichen |
Order.Tags[].Tag.name | String | nein | Stichworte; max. 255 Zeichen |
DesignOrderNote | String | nein | Gestaltungshinweis; max. 512 Zeichen |
CorrectionNote | String | nein | Korrekturhinweis; max. 512 Zeichen |
TemplateFileNames[].FileName name | String | nein | Dateinamen der Gestaltungsvorlagen (Logos, Texte, Schriften) |
ExternalMotifFileName | String | ja | Motiv-Dateiname für den Export; max. 256 Zeichen |
Acceptance.Text | String | nein | Abnahmetext (für Korrekturworkflow); max. 512 Zeichen |
Acceptance.Resubmission | Byte/Boolean | nein | Wiedervorlagekennzeichen; 0/1; default = 0 |
Acceptance.ReactionDeadline | DateTime | ja | Späteste Reaktionszeit (für Kundenkorrektur); YYYY-MM-DDTHH:MM:SS |
Acceptance.Emails[].Email address | String | nein | Emailadresse( n ) für den Korrektur-Workflow (TO/CC/BCC); max. 256 Zeichen je Adresse |
Acceptance.CCEmails[].Email address | String | nein | |
Acceptance.BCCEmails[].Email address | String | nein | |
Acceptance.FaxNumbers[].Fax number | String | nein | Faxnummer( n ) für den Korrektur-Workflow; max. 32 Zeichen eWorxx versendet automatisch ein Fax, wenn Resubmission=1 ist, und keine Email-Adressen vorhanden sind. |
...
Codeblock | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
<?xml version="1.0" encoding="utf-8"?> <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="DesignOrder"> <xs:complexType> <xs:sequence> <xs:element name="Customer"> <xs:complexType> <xs:sequence> <xs:element name="Name" type="xs:string" /> <xs:element name="Number" type="xs:string" minOccurs="0"/> <xs:element name="Address" type="xs:string" /> <xs:element name="ContactPerson" type="xs:string" minOccurs="0"/> <xs:element name="PhoneNumber" type="xs:string" minOccurs="0"/> <xs:element name="Email" type="xs:string" minOccurs="0"/> <xs:element name="PostalAddress" type="xs:string" minOccurs="0"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="Layout"> <xs:complexType> <xs:sequence> <xs:element name="Height" type="xs:unsignedInt" /> <xs:element name="Width" type="xs:unsignedShort" /> <xs:element name="CMYK" type="xs:unsignedByte" minOccurs="0"/> <xs:element name="BlackWhite" type="xs:unsignedByte" minOccurs="0"/> <xs:element name="SpotColors" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:element maxOccurs="unbounded" name="SpotColor"> <xs:complexType> <xs:attribute name="name" type="xs:string" use="required" /> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="Order"> <xs:complexType> <xs:sequence> <xs:element name="StudioName" type="xs:string" /> <xs:element name="Number" type="xs:unsignedInt" /> <xs:element name="Position" type="xs:unsignedByte" /> <xs:element name="Priority" type="xs:unsignedByte" /> <xs:element name="FinishingDateTime" type="xs:dateTime" /> <xs:element name="PublicationDate" type="xs:date" minOccurs="0" /> <xs:element name="Edition" type="xs:string" minOccurs="0" /> <xs:element name="Rubric" type="xs:string" minOccurs="0" /> <xs:element name="ContactPerson" type="xs:string" minOccurs="0" /> <xs:element name="OrderGroup" type="xs:string" minOccurs="0" /> </xs:sequence> <xs:element name="Tags" minOccurs="0" > </xs<xs:complexType> </xs:element> <xs:element name="DesignOrderNote" type="sequence> <xs:element maxOccurs="unbounded" name="Tag"> <xs:complexType> <xs:attribute name="name" type="xs:string" use="required" /> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="DesignOrderNote" type="xs:string" minOccurs="0" /> <xs:element name="CorrectionNote" type="xs:string" minOccurs="0" /> <xs:element name="TemplateFileNames" minOccurs="0" > <xs:complexType> <xs:sequence> <xs:element maxOccurs="unbounded" name="FileName"> <xs:complexType> <xs:attribute name="name" type="xs:string" use="required" /> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="ExternalMotifFileName" type="xs:string" /> <xs:element name="Acceptance" minOccurs="0" > <xs:complexType> <xs:sequence> <xs:element name="Text" type="xs:string" minOccurs="0" /> <xs:element name="Resubmission" type="xs:unsignedByte" minOccurs="0" /> <xs:element name="ReactionDeadline" type="xs:dateTime" /> <xs:element name="Emails" minOccurs="0" > <xs:complexType> <xs:sequence> <xs:element maxOccurs="unbounded" name="Email"> <xs:complexType> <xs:attribute name="address" type="xs:string" use="required" /> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="CCEmails" minOccurs="0" > <xs:complexType> <xs:sequence> <xs:element name="Email"> <xs:complexType> <xs:attribute name="address" type="xs:string" use="required" /> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="BCCEmails" minOccurs="0" > <xs:complexType> <xs:sequence> <xs:element name="Email"> <xs:complexType> <xs:attribute name="address" type="xs:string" use="required" /> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="FaxNumbers" minOccurs="0" > <xs:complexType> <xs:sequence> <xs:element maxOccurs="unbounded" name="Fax"> <xs:complexType> <xs:attribute name="number" type="xs:string" use="required" /> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema> |
...
Codeblock | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
<?xml version="1.0" encoding="utf-8"?> <DesignOrder> <Customer> <Name>Max Mustermann</Name> <Number>CUST-99-2500</Number> <Address>12345 Irgendwo</Address> <ContactPerson>Hugo Müller</ContactPerson> <PhoneNumber>0345/1234567</PhoneNumber> <Email>Max.Mustermann@email.com</Email> <PostalAddress><![CDATA[Max Mustermann Friedhofsstraße 42 12345 Irgendwo]]></PostalAddress> </Customer> <Layout> <Height>120000</Height> <Width>45000</Width> <CMYK>1</CMYK> <BlackWhite>0</BlackWhite> <SpotColors> <SpotColor name="HKS13"/> <SpotColor name="HKS57"/> </SpotColors> </Layout> <Order> <StudioName>Studio1</StudioName> <Number>9900001</Number> <Position>1</Position> <Priority>2</Priority> <FinishingDateTime>2020-12-03T10:15:30</FinishingDateTime> <PublicationDate>2020-12-06</PublicationDate> <Edition>Ausgabe</Edition> <Rubric>Rubrik</Rubric> <ContactPerson>Sekretariat Anzeigenverkauf</ContactPerson> <OrderGroup>Eigenanzeigen</OrderGroup> <PublicationDate>2020-12-06</PublicationDate><Tags> <Edition>Ausgabe</Edition> <Tag name="GEST"/> <Rubric>Rubrik</Rubric> <Tag name="ID"/> <ContactPerson>Sekrätariat Anzeigenverkauf</ContactPerson> <Tag name="INET Internet"/> <OrderGroup>Eigenanzeigen</OrderGroup> </Tags> </Order> <DesignOrderNote>Bitte in schwarz/weiß</DesignOrderNote> <CorrectionNote>Keine weiße Schriftfarbe verwenden</CorrectionNote> <TemplateFileNames> <FileName name="Vorlage.txt"/> <FileName name="Logo.jpg"/> </TemplateFileNames> <ExternalMotifFileName>9900001_1.pdf</ExternalMotifFileName> <Acceptance> <Text>Abnahmetext</Text> <Resubmission>0</Resubmission> <ReactionDeadline>2020-12-02T10:15:30</ReactionDeadline> <Emails> <Email address="max.mustermann@email.de"/> <Email address="kaiser.karl@post.com"/> </Emails> <CCEmails> <Email address="maxi.musterfrau@email.de"/> </CCEmails> <BCCEmails> <Email address="post@versand.de"/> </BCCEmails> <FaxNumbers> <Fax number="053128181111"/> </FaxNumbers> </Acceptance> </DesignOrder> |
...
Name | Datentyp | Pflicht | Beschreibung |
---|---|---|---|
customerNo | String | nein | Kundennummer; max. 64 Zeichen; Freitext |
customerName | String | ja | Kundenname; max. 256 Zeichen; Freitext |
customerAddress | String | ja | Kundenadresse; max. 512 Zeichen; Freitext |
contactPersonOfCustomer | String | nein | Kontaktperson des Kunden; max. 256 Zeichen; Freitext |
customerTelNo | String | nein | Telefonnummer(n) des Kunden; max. 64 Zeichen |
customerEmail | String | nein | Emailadresse(n) des Kunden; max. 256 Zeichen |
postalAddress | String | nein | Formatierte Postadresse; Freitext; Mehrzeiligkeit durch \n |
height | Integer | ja | Höhe des Motivs in Mikrometer; größer 0 |
width | Integer | ja | Breite des Motivs in Mikrometer; größer 0 |
cmyk | Boolean | nein | CMYK-Motiv; false/true; default = true |
blackwhite | Boolean | nein | Graustufen-Motiv; false/true; default = false |
spotColors | Array | nein | Spotfarbnamen; keine leeren Listeneintraege |
designOrderNote | String | nein | Gestaltungshinweis; max. 512 Zeichen |
correctionNote | String | nein | Korrekturhinweis; max. 512 Zeichen |
designStudio | String | ja | Studioname; max. 256 Zeichen |
orderNo | String | ja | Auftragsnummer bzw. Motivnummer; max. 32 Zeichen |
orderPosition | Integer | ja | Auftragsposition; größer 0 |
priority | Integer | ja | Priorität; 1-N (1 = hoch) |
finishingDate | Date | ja | Fertigstellungsdatum zu dem die Gestaltung beendet sein muss (z.B. Rubrikenschluss, Satzschlusszeit) |
publicationDate | Date | nein | Erscheindatum |
edition | String | nein | Ausgabe; max. 256 Zeichen; Freitext |
rubric | String | nein | Rubrik(en) (z.B. R1 > R2 > ... RN); max. 256 Zeichen; Freitext |
contactPersonOfPublisher | String | nein | Kontaktperson des Verlags (Name, Email, Telnr.); max. 256 Zeichen |
orderGroup | String | nein | Auftragsgruppe; max. 32 Zeichen |
externalMotifName | String | ja | Motiv-Dateiname für den Export; max. 256 Zeichen |
acceptanceText | String | nein | Abnahmetext (für Korrekturworkflow); max. 512 Zeichen |
resubmission | Boolean | nein | Wiedervorlagekennzeichen; false/true; default = false |
reactionDeadline | Date | ja | Späteste Reaktionszeit (für Kundenkorrektur), erforderlich wenn resubmission |
emails | Array | nein | Emailadressen für den Korrektur-Workflow (TO/CC/BCC); max. 256 Zeichen je Adresse |
ccEmails | Array | nein | |
bccEamils | Array | nein | |
faxNumbers | Array | nein | Faxnummern für den Korrektur-Workflow; max. 32 Zeichen je Nummer |
tags | Array | nein | Stichworte; max. 255 Zeichen je Stichwort (Leerzeichen erlaubt) |
Das zu übergebende JSON Objekt muss die folgende Struktur aufweisen:
Codeblock | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "acceptanceText": "string", "bccEmails": ["string"], "blackwhite": true, "ccEmails": ["string"], "cmyk": true, "contactPersonOfCustomer": "string", "contactPersonOfPublisher": "string", "correctionNote": "string", "customerAddress": "string", "customerEmail": "string", "customerName": "string", "customerNo": "string", "customerTelNo": "string", "designOrderNote": "string", "designStudio": "string", "edition": "string", "emails": ["string"], "externalMotifName": "string", "finishingDate": "2020-10-02T10:03:29.526Z", "faxNumbers": ["string"], "height": 0, "orderGroup": "string", "orderNo": "string", "orderPosition": 0, "postalAddress": "string", "priority": 0, "publicationDate": "2020-10-02T10:03:29.526Z", "reactionDeadline": "2020-10-02T10:03:29.526Z", "resubmission": true, "rubric": "string", "spotColors": ["string"], "tags": ["string"], "width": 0 } |
Webservice Konfiguration (Storno)
...
Die REST-Schnittstelle ist unter Hostname:Port//service/public/designorder/order-state verfügbar.
Parameter | Datentyp | Pflicht | Beschreibung |
---|---|---|---|
orderNo | String | ja | Auftragsnummer bzw. Motivname (vgl. Importschnittstelle) |
orderPos | Integer | ja | Auftragsposition bzw. Motivnummer |
Als Ergebnis kommt ein JSON mit Status-Key, Status-Text und (optional) Fehlertext.
...