Spojování souborů do PDF či PDF/A dokumentu

Webová služba Concat umožňuje spojit dva a více souborů do jednoho PDF či PDF/A dokumentu. Lze také nastavit některé konverzní vlastnosti známé z metody ConvertFileEx jako např. přidání metadat, anotace, vodoznaku. Tyto volby se aplikují na každý jednotlivý soubor před slučováním.

Popis služby Concat včetně WSDL schématu a příklad požadavku a odpovědi pro SOAP 1.1 a SOAP 1.2 je umístěn na http://localhost/ltd/ltd.asmx?op=Concat.

Parametr "localhost" je název používaný pro lokální počítač; namísto něj zapište jméno/IP adresu LTD serveru (dle nastavení v IIS).

Požadavek

POST /ltd/ltd.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://software602.com/longtermdocs/Concat"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Concat xmlns="http://software602.com/longtermdocs/">
      <FileList>
        <ConcatFile>
          <Name>string</Name>
          <Data>base64Binary</Data>
        </ConcatFile>
        <ConcatFile>
          <Name>string</Name>
          <Data>base64Binary</Data>
        </ConcatFile>
      </FileList>
      <ConcatOptions>
        <Pack>boolean</Pack>
        <Linearize>boolean</Linearize>
        <ConcatToFirstFile>boolean</ConcatToFirstFile>
        <FFSErrCodes>boolean</FFSErrCodes>
      </ConcatOptions>
      <Options>
        <RemoveEmptyPages>boolean</RemoveEmptyPages>
        <ReportLanguage>string</ReportLanguage>
        <OCRLanguage>string</OCRLanguage>
        <OCRRecognitionDpi>int</OCRRecognitionDpi>
        <ForceShell>string</ForceShell>
        <PdfFormat>PDF or PDF_A_1b or PDF_A_1a or PDF_A_2b or PDF_A_2a or PDF_A_2u or PDF_A_3b or PDF_A_3a or PDF_A_3u or PDF_X_1 or PDF_X_3 or PDF_X_4 or PDF_X_5</PdfFormat>
        <ForcePDFVersion>string</ForcePDFVersion>
        <BarcodeInfo>
          <PosX>double</PosX>
          <PosY>double</PosY>
          <Width>double</Width>
          <Height>double</Height>
          <Type>Barcode_1D_UPCVersionA or Barcode_1D_UPCVersionE or Barcode_1D_UPCSupplemental2Digit or Barcode_1D_UPCSupplemental5Digit or Barcode_1D_EAN13 or Barcode_1D_EAN8 or Barcode_1D_Interleaved2of5 or Barcode_1D_Standard2of5 or Barcode_1D_Industrial2of5 or Barcode_1D_Code39 or Barcode_1D_Code39Extended or Barcode_1D_Codabar or Barcode_1D_PostNet or Barcode_1D_Bookland or Barcode_1D_ISBN or Barcode_1D_JAN13 or Barcode_1D_MSIMod10 or Barcode_1D_MSI2Mod10 or Barcode_1D_MSIMod11 or Barcode_1D_MSIMod11Mod10 or Barcode_1D_ModifiedPlessey or Barcode_1D_Code11 or Barcode_1D_USD8 or Barcode_1D_UCC12 or Barcode_1D_UCC13 or Barcode_1D_LOGMARS or Barcode_1D_Code128 or Barcode_1D_Code128A or Barcode_1D_Code128B or Barcode_1D_Code128C or Barcode_1D_ITF14 or Barcode_1D_Code93 or Barcode_1D_TelePen or Barcode_PDF417 or Barcode_QR or Barcode_DataMatrix</Type>
          <Data>string</Data>
          <Description>string</Description>
          <Pages>string</Pages>
        </BarcodeInfo>
        <ZFO>
          <AttSettings>
            <ConversionHandling>IGNORE_ATTACHMENTS or ATTACH_WITHOUT_CONVERSION or CONVERT_FAILURE_END or CONVERT_FAILURE_SKIP or CONVERT_FAILURE_ATTACH_ORIGINAL or CONVERT_ALWAYS_ATTACH_ORIGINAL or CONCAT_FAILURE_END or CONCAT_FAILURE_SKIP or CONCAT_FAILURE_ATTACH_ORIGINAL or CONCAT_FAILURE_ATTACH_ERR_PAGE_AND_ORIGINAL</ConversionHandling>
            <AllowedFiletypes>string</AllowedFiletypes>
          </AttSettings>
          <ConvertDZ>boolean</ConvertDZ>
        </ZFO>
        <EML>
          <AttSettings>
            <ConversionHandling>IGNORE_ATTACHMENTS or ATTACH_WITHOUT_CONVERSION or CONVERT_FAILURE_END or CONVERT_FAILURE_SKIP or CONVERT_FAILURE_ATTACH_ORIGINAL or CONVERT_ALWAYS_ATTACH_ORIGINAL or CONCAT_FAILURE_END or CONCAT_FAILURE_SKIP or CONCAT_FAILURE_ATTACH_ORIGINAL or CONCAT_FAILURE_ATTACH_ERR_PAGE_AND_ORIGINAL</ConversionHandling>
            <AllowedFiletypes>string</AllowedFiletypes>
          </AttSettings>
          <CertificatePath>string</CertificatePath>
          <Decrypt>boolean</Decrypt>
          <ExportSignature>boolean</ExportSignature>
          <HeaderLanguage>string</HeaderLanguage>
        </EML>
        <HTML>
          <Header>string</Header>
          <AvoidTextBreak>boolean</AvoidTextBreak>
          <AvoidImageBreak>boolean</AvoidImageBreak>
          <ArchiveHeaderLanguage>string</ArchiveHeaderLanguage>
          <HeaderHeight>int</HeaderHeight>
          <Footer>string</Footer>
          <FooterHeight>int</FooterHeight>
          <PageEncoding>string</PageEncoding>
          <AutoDetectEncoding>boolean</AutoDetectEncoding>
          <BaseURL>string</BaseURL>
          <DownloadReferencedFiles>boolean</DownloadReferencedFiles>
          <DoArchive>boolean</DoArchive>
          <FitWidth>boolean</FitWidth>
          <FitHeight>boolean</FitHeight>
          <AutoSize>boolean</AutoSize>
          <CustomPageHeight>int</CustomPageHeight>
          <CustomPageWidth>int</CustomPageWidth>
        </HTML>
        <AllowAnnotations>boolean</AllowAnnotations>
        <Annotations>
          <PDF_Annotation>
            <Format>Points or Relative</Format>
            <Pos_X>int</Pos_X>
            <Pos_Y>int</Pos_Y>
            <Size_X>int</Size_X>
            <Size_Y>int</Size_Y>
            <Text>string</Text>
            <Page>int</Page>
          </PDF_Annotation>
          <PDF_Annotation>
            <Format>Points or Relative</Format>
            <Pos_X>int</Pos_X>
            <Pos_Y>int</Pos_Y>
            <Size_X>int</Size_X>
            <Size_Y>int</Size_Y>
            <Text>string</Text>
            <Page>int</Page>
          </PDF_Annotation>
        </Annotations>
        <Header>
          <Text>string</Text>
          <Height>int</Height>
          <HorizontalAlignment>Left or Center or Right</HorizontalAlignment>
          <VerticalAlignment>Top or Center or Bottom</VerticalAlignment>
          <Mode>FirstPage or AllPages or LastPage or UserDefined</Mode>
          <Pages>string</Pages>
          <FontName>string</FontName>
          <FontSize>int</FontSize>
          <Transparency>int</Transparency>
        </Header>
        <Footer>
          <Text>string</Text>
          <Height>int</Height>
          <HorizontalAlignment>Left or Center or Right</HorizontalAlignment>
          <VerticalAlignment>Top or Center or Bottom</VerticalAlignment>
          <Mode>FirstPage or AllPages or LastPage or UserDefined</Mode>
          <Pages>string</Pages>
          <FontName>string</FontName>
          <FontSize>int</FontSize>
          <Transparency>int</Transparency>
        </Footer>
        <PageFormat>Custom or A0 or A1 or A10 or A2 or A3 or A4 or A5 or A6 or A7 or A8 or A9 or ArchA or ArchB or ArchC or ArchD or ArchE or B0 or B1 or B2 or B3 or B4 or B5 or Flsa or HalfLetter or Ledger or Legal or Letter or Letter11x17 or Note</PageFormat>
        <PageOrientation>Portrait or Landscape</PageOrientation>
        <UsePageCompression>boolean</UsePageCompression>
        <Metadata>
          <Title>string</Title>
          <Subject>string</Subject>
          <Author>string</Author>
          <Keywords>string</Keywords>
        </Metadata>
        <UseImageCompression>boolean</UseImageCompression>
        <UsePDFCompression>boolean</UsePDFCompression>
        <DownsizeResolution>int</DownsizeResolution>
        <CompressMethod>int</CompressMethod>
        <JpegQuality>int</JpegQuality>
        <ConvertToCMYK>boolean</ConvertToCMYK>
        <RemoveDuplicateImages>boolean</RemoveDuplicateImages>
        <ConversionTimeout>int</ConversionTimeout>
        <AddWatermark>boolean</AddWatermark>
        <Watermark>
          <Mode>FirstPage or AllPages or LastPage or UserDefined</Mode>
          <Pages>string</Pages>
          <Angle>int</Angle>
          <Strength>int</Strength>
          <FontSize>int</FontSize>
          <Text>string</Text>
          <Font>string</Font>
          <Layer>Top or Bottom</Layer>
        </Watermark>
        <AddStamp>boolean</AddStamp>
        <Stamp>
          <Mode>FirstPage or AllPages or LastPage or UserDefined</Mode>
          <Path>string</Path>
          <Pages>string</Pages>
          <PosX>int</PosX>
          <PosY>int</PosY>
          <Width>float</Width>
          <Height>float</Height>
          <AutoPlacement>boolean</AutoPlacement>
          <AutoPosHorizontal>Left or Center or Right</AutoPosHorizontal>
          <AutoPosVertical>Top or Center or Bottom</AutoPosVertical>
          <Layer>Top or Bottom</Layer>
          <ResampleImage>boolean</ResampleImage>
        </Stamp>
        <AddAttachements>boolean</AddAttachements>
        <AttachementList>
          <string>string</string>
          <string>string</string>
        </AttachementList>
        <AppendFilesAtEnd>
          <string>string</string>
          <string>string</string>
        </AppendFilesAtEnd>
        <EnableMerge>boolean</EnableMerge>
        <Merge>
          <Mode>Overwrite or Begin or End</Mode>
          <SaveCopyOnMerge>boolean</SaveCopyOnMerge>
        </Merge>
        <AddSecurity>boolean</AddSecurity>
        <Security>
          <EncryptionAlgorithm>PdfEncryptionNone or PdfEncryption40BitRC4 or PdfEncryption128BitRC4 or PdfEncryption128BitAES or PdfEncryption256BitAES</EncryptionAlgorithm>
          <UserPasswordCrypted>string</UserPasswordCrypted>
          <UserPasswordPlaintext>string</UserPasswordPlaintext>
          <OwnerPasswordCrypted>string</OwnerPasswordCrypted>
          <OwnerPasswordPlaintext>string</OwnerPasswordPlaintext>
          <OpenPasswordPlaintext>string</OpenPasswordPlaintext>
          <Permissions>
            <CanPrint>boolean</CanPrint>
            <CanCopy>boolean</CanCopy>
            <CanModify>boolean</CanModify>
            <CanAddNotes>boolean</CanAddNotes>
            <CanFillFields>boolean</CanFillFields>
            <CanCopyAccess>boolean</CanCopyAccess>
            <CanAssemble>boolean</CanAssemble>
            <CanPrintFull>boolean</CanPrintFull>
          </Permissions>
        </Security>
        <AddSignature>boolean</AddSignature>
        <Signature>
          <CertificateID>string</CertificateID>
          <PrivateKeyPIN>string</PrivateKeyPIN>
          <AddTimeStamp>boolean</AddTimeStamp>
          <CreateBES>boolean</CreateBES>
          <ShowValidationStatus>boolean</ShowValidationStatus>
          <Page>int</Page>
          <Text>string</Text>
          <ImagePath>string</ImagePath>
          <PosX>int</PosX>
          <PosY>int</PosY>
          <Width>int</Width>
          <Height>int</Height>
          <LocationInfo>string</LocationInfo>
          <ContactInfo>string</ContactInfo>
          <Reason>string</Reason>
        </Signature>
        <AddTimeStamp>boolean</AddTimeStamp>
        <TimeStamp>
          <LocationInfo>string</LocationInfo>
          <ContactInfo>string</ContactInfo>
          <Reason>string</Reason>
        </TimeStamp>
        <PreserveExistingSignatures>boolean</PreserveExistingSignatures>
        <ConvertSignedPDF>boolean</ConvertSignedPDF>
        <StrictSignedPDFConversion>boolean</StrictSignedPDFConversion>
        <ReturnErrorIfNotModified>boolean</ReturnErrorIfNotModified>
        <XMLReportTemplate>string</XMLReportTemplate>
        <XMLReportSignaturesTemplate>string</XMLReportSignaturesTemplate>
        <AddXMLReportToXMP>boolean</AddXMLReportToXMP>
        <ReturnFullXMPReport>boolean</ReturnFullXMPReport>
        <MaxInputFileSize>int</MaxInputFileSize>
        <AllowedFileTypes>string</AllowedFileTypes>
        <EnableOCR>boolean</EnableOCR>
        <ForceOCR>boolean</ForceOCR>
        <AddSourceAsPDFA3AssociatedFile>boolean</AddSourceAsPDFA3AssociatedFile>
        <ForcePDFAIfErrors>boolean</ForcePDFAIfErrors>
        <ForceImagePDFAIfErrors>boolean</ForceImagePDFAIfErrors>
        <ForceImagePDFAResolution>int</ForceImagePDFAResolution>
        <HttpHeaders>string</HttpHeaders>
      </Options>
    </Concat>
  </soap:Body>
</soap:Envelope>

<FileList> – seznam souborů, které se mají spojit.
[povinný element]

<ConcatFile> – soubor ke spojení.
[povinný element]

<Name>
[povinný element]

Vstup Popis

string

Název vstupního souboru včetně přípony.

<Data>
[povinný element]

Vstup Popis

Base64Binary

Data vstupního souboru zakódovaná Base64.

</ConcatFile>

<ConcatFile> – druhý soubor ke spojení.
[povinný element]

<Name>
[povinný element]

Vstup Popis

string

Název vstupního souboru včetně přípony.

<Data>
[povinný element]

Vstup Popis

Base64Binary

Data vstupního souboru zakódovaná Base64.

</ConcatFile>

</FileList>

<ConcatOptions> - volitelné volby pro spojení souborů.
[nepovinný element]

<Pack>
[nepovinný element]

Vstup Popis

boolean

Logická hodnota definuje, zda metoda má zabalit vytvořený dokument pro snížení jeho velikosti. Pokud je nastaveno, proces ukládání může být u některých dokumentů pomalejší.

<Linearize>
[nepovinný element]

Vstup Popis

boolean

Logická hodnota, která povoluje režim Fast Web View (rychlého prohlížení webu). Linearizace přehází obsah PDF souboru tak, že umístí všechny informace potřebné k zobrazení první stránky blízko začátku souboru. To umožní uživateli vidět první stránku, zatímco zbývající část souboru se stále stahuje z webu.

<ConcatToFirstFile>
[nepovinný element]

Vstup Popis

boolean

Logická hodnota určující připojení souborů k prvnímu souboru z FileList inkrementálním způsobem, bez zrušení elektronického podpisu/pečeti.

<FFSErrCodes>
[nepovinný element]

Vstup Popis

boolean

Logická hodnota určující navrácení chybové informace ve formátu, který je vhodný pro zpracování FormFlow Serverem:

_<result code>

<path of failed file>

<additional info>_

přičemž vrácené chybové kódy mohou nabývat stavů:

-1000 = Nepodařilo se převést dokument do PDF/A.

-1001 = Soubor „Název souboru“ je zamčen pro čtení.

-1002 = Soubor „Název souboru“ je jiného typu, než je přípona souboru .

-1003 = Soubor „Název souboru“ se nepodařilo připojit.

-1004 = Nelze zapsat výstupní soubor.

</ConcatOptions>

Dále lze definovat všechny konverzní <Options>, které jsou dostupné a popsané u metody ConvertFileEx.

Odpověď

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ConcatResponse xmlns="http://software602.com/longtermdocs/">
      <ConcatResult>int</ConcatResult>
      <Output>base64Binary</Output>
      <ErrorMessage>string</ErrorMessage>
    </ConcatResponse>
  </soap:Body>
</soap:Envelope>

<ConcatResult>

Návratová hodnota Popis

int

Číselná reprezentace výsledku metody Concat. 0 = v pořádku.

Jinak viz kapitola Návratové kódy.

<Output>

Návratová hodnota Popis

Base64Binary

Výstupní PDF soubor v kódování Base64.

<ErrorMessage>

Návratová hodnota Popis

string

Obsahuje text chyby v případě neúspěšného spojení.