Web2Print Cloud Lab
1 Table of Contents
2 Overview
The
Article element represents an article configuration. Within this element you can set all parameters that are required to calculate an article or place an order. The element is also used to provide additional information about the selected article that is being returned by the calculation call.
3 Elements
| Name | Type | Datatype | Example | Default | Description |
|---|
| Amount
| optional
| int(>0)
| 1
| 1
| Amount of articles to be calculated/ordered. Let's say you want to order business cards 250 pieces each and with 4 different designs. Then you have to use this element and set it to 4.
|
| CustomerNote
| optional
| string(1000)
| -
| -
| This field can be used to attach a note during the order process entered by the customer. This note has public visibility. Must be in English.
|
| FabricationType
| required
| string
| Digital; Offset; SilkScreen; LaserGravure; Plot
| -
| Type of fabrication. If you leave out this element, you'll get a list of available fabrication types for the requested article configuration in the FabricationTypes element.
|
| | Digital: Digital printing process for small amounts of copies in RGB-Colormodel.
|
| | Offset: Offset printing process in CMYK, HKS, Pantone etc. For large amounts of copies.
|
| | SilkScreen: Silkscreen printing process for small amounts of copies and specific post processings.
|
| | LaserGravure: Laser gravue process for stamps etc.
|
| | HandPainted: For hand crafted paintings.
|
| | Plot: Plotted document.
|
| FinanceNote
| optional
| string(1000)
| -
| -
| This field can be used to attach an internal note during the order process. This note will be visible to the finance dept. in the backoffice. Must be in English.
|
| Id
| req./opt.
| int
| 1
| -
| Numeric Id to identify the article. Can be omitted if Identifier is supplied instead.
|
| Identifier
| req./opt.
| string
| ARTICLE_1
| -
| Textual identifier to identify the article. Can be omitted if Id is supplied instead.
|
| IdMaterial
| req./opt.
| int
| 36
| -
| Identifies the Material for the current article using the Id value of the Material element. During the calculation process you can leave out this element to get a list of materials and the associated IDs. Those items will be attached to a Materials element and appended to the Article element. When placing an order, the element is required.
|
| Material
| req./opt.
| string
| BRIEF_80_UNGESTR
| -
| Identifies the Material for the current article using the Key value of the Material element. During the calculation process you can leave out this element to get a list of materials and the associated Keys. Those items will be attached to a Materials element and appended to the Article element. When placing an order, the element is required.
|
| InternalJobNumber
| optional
| string
| -
| -
| Job number that will be generated during the order call. It identifies the article of a certain order.
|
| NumberColorsBack
| required
| int
| 1
| -
| Number of colors on the back page for the current FabricationType. Either NumberColorsFront or NumberColorsBack needs to be greater than 0. If you leave either of the elements, you'll find a list of available color codes in the NumbersColors element.
|
| NumberColorsFront
| required
| int
| 4
| -
| Number of colors on the front page for the current FabricationType. Either NumberColorsFront or NumberColorsBack needs to be greater than 0. If you leave either of the elements, you'll find a list of available color codes in the NumbersColors element.
|
| PageLengthOpen
| required
| float(>0)
| 11.69
| -
| Requested page length of the unprocessed article. Unit depends on the selected SystemOfMeasurement in the Header element. Example uses inches.
|
| PageOrientation
| optional
| string
| Portrait; Landscape
| Portrait
| Page orientation.
|
| PageWidthOpen
| required
| float(>0)
| 16.54
| -
| Requested page width of the unprocessed article. Unit depends on the selected SystemOfMeasurement in the Header element. Example uses inches.
|
| Payment
| required
| element
| -
| -
| Identifies the type of payment. See here.
|
| PriceType
| optional
| string
| Discount; Standard; Express; Overnight
| -
| Production profile that influences the time it takes to produce the article. Discount will take longer than Overnight. It does not reflect the shipment process. If you don't change this element, you'll get a list of available production profiles for the requested article configuration.
|
| PrintData
| req./opt.
| element
| -
| -
| Holds a list of print data locations which will be downloaded during the order call. Required if the article type requires user-supplied print data.
|
| PrintingMethod
| required
| string
| OneOff; GangRun
| -
| Type of production. If you leave out this element, you'll get a list of available printing methods for the requested article configuration.
|
| | OneOff: Single job production process. For exclusive prints. Jobs are not being collected before printing starts.
|
| | GangRun: Jobs are being collected and placed on a big sheet to reduce printing costs.
|
| Processings
| optional
| element
| -
| -
| Holds a list of processings that will be applied to the current article configuration. If omitted or left empty, all available processings will be returned and attached to this element.
|
| Run
| required
| int(>0)
| 250
| -
| How many copies are requested for calculation/order for the current article.
|
3.1 Example
XML:
<Article>
<Id>493</Id>
<PrintingMethod>OneOff</PrintingMethod>
<FabricationType>Plot</FabricationType>
<PageLengthOpen>11.69</PageLengthOpen>
<PageWidthOpen>16.54</PageWidthOpen>
<PageOrientation>Portrait</PageOrientation>
<NumberColorsFront>4</NumberColorsFront>
<NumberColorsBack>0</NumberColorsBack>
<Amount>1</Amount>
<Run>1</Run>
<Payment>
<Type>CIA</Type>
</Payment>
<IdMaterial>53</IdMaterial>
</Article>
JSON:
"Article": {
"Id": 493,
"Amount": 1,
"Run": 1,
"PrintingMethod": "OneOff",
"FabricationType": "Plot",
"PageLengthOpen": 11.69,
"PageWidthOpen": 16.54,
"NumberColorsFront": 4,
"NumberColorsBack": 0,
"PageOrientation": "Portrait",
"Payment": {
"Type": "CIA"
},
"IdMaterial": 53
}
3.1.1 Additional response elements
| Name | Type | Datatype | Example | Default | Description |
|---|
| Materials
| optional
| element
| -
| -
| List of available materials for the current article configuration. Name and description of the material are translated according to the Language element of the Header element.
|
| MaxAreaToCalculate
| optional
| float
| -
| -
| Maximum area in m² or inch²(depending on SystemOfMeasurement setting) that can be calculated for this article configuration.
|
| MinAreaToCalculate
| optional
| float
| -
| -
| Minumum area in m² or inch²(depending on SystemOfMeasurement setting) that can be calculated for this article configuration.
|
| NumbersColors
| optional
| element
| -
| -
| A list of NumbersColors elements for available color code combinations.
|
| PrintingMethods
| optional
| element
| -
| -
| List of available printing methods for the current article configuration.
|
| FabricationTypes
| optional
| element
| -
| -
| List of available fabrication types for the current article configuration.
|
| Resolution
| optional
| int
| 300
| -
| Required resolution of the print data in DPI(dots per inch). Any images or documents that should be printed using this article need to have a minumum resolution to meet certain quality standards. Any data that has lower resolution than the value in the Resolution element can result in low quality prints.
|
3.1.1.1 Example - Materials
XML
<Materials>
<Material>
<Id>36</Id>
<Key>BRIEF_80_UNGESTR</Key>
<Grammage>80</Grammage>
<Name>80 g/m² Letter paper</Name>
<Description />
</Material>
...
</Materials>
JSON
"Materials": [
{
"Id": 37,
"Key": "BRIEF_90_UNGESTR",
"Grammage": 90,
"Name": "90 g/m² Letter paper",
"Description": ""
},
...
]