When using the "Pdfa" web service, both the
•"<convert>" and
•"<analyze>"
operations can be used. The "convert" operation is used to convert PDF documents to PDF/A, while the "analyze" operation is used to validate existing PDF/A documents.
convert operation
Used to convert a PDF document to PDF/A.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> |
{ "version": "v10Comfort", |
Used to define the parameters for the PDF/A conversion.
<convert errorReport="message" level="3u" imageQuality="75" successReport="linked" autoTagging="false"> |
"convert": { "autoTagging": false, |
Specifies the compliance level when creating PDF/A documents (as specified in ISO 19005).
1a = PDF/A-1a
1b = PDF/A-1b
2a = PDF/A-2a
2b = PDF/A-2b
2u = PDF/A-2u
3a = PDF/A-3a
3b = PDF/A-3b
3u = PDF/A-3u
imageQuality (default: 75)
The quality for images which must be transformed during the conversion because they use a compression which is not allowed (e.g. JPX is not allowed in PDF/A-1) is defined using this parameter. Values in a range from 1 to 100 are allowed whereby a higher value means better quality, but also larger PDF documents.
This parameter is used to define whether and in which format the XML report for a failed conversion will be returned.
none = An XML report will not be returned
message = The XML report will be returned as part of the error message
file = The XML report will be saved in a file
successReport (default: "none")
This parameter is used to define whether and in which format the XML report for a successful conversion will be returned.
none = An XML report will not be returned
linked = The XML report will be appended at the end of the PDF/A document.
zip = The PDF/A document and the XML report will be packaged together in a ZIP archive.
|
The format of the document generated with "errorReport" and "successReport" is described by the http://schema.webpdf.de/1.0/report/pdfa.xsd schema. |
autoTagging (Default: false)
In order to convert a document to conformity levels PDF/A 1a-3a, the entire document must have appropriate structure information (tags). If auto tagging is enabled, the corresponding structure information (in the form of page tags) will be generated automatically before the actual conversion.
This element can be optionally used to integrate a ZUGFeRD document. The document must at least be converted to PDF/A-3 format.
<zugferd> |
"zugferd": { "version": "V10_COMFORT", |
xmlFile element
ZUGFeRD file (XML) in "Base64 encoded" format. The ZUGFeRD XSD schema will be used to validate the file before embedding. If it is not valid, the operation will be aborted.
version (Default: v10Comfort)
Used to define the version of the ZUGFeRD XML file that should be embedded with "xmlFile". Versions 1.0, 2.0 and 2.1.x are supported. Only the “Comfort” profile is available for version 1.0. Meanwhile, the "Minimum", "Basic WL", "Basic", "EN16931" (Comfort), and "Extended" profiles are supported for version 2.0. Version 2.1.x contains the same profiles as version 2.0 and additionally defines the profile "X-Rechnung".
List of versions with the corresponding profiles:
v10Comfort
v20Minimum
v20BasicWL
v20Basic
v20EN16931
v20Extended
v21Minimum
v21BasicWL
v21Basic
v21EN16931
v21Extended
v21XRechnung
analyze operation
Used to check a PDF document for compliance with PDF/A specifications.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
|
{ |
Used to define the parameters for the PDF/A check.
<analyze level="1b"/>
|
"analyze": { |
PDF/A level that will be used for the compliance check (please refer to the convert operation)