DigiOffice Gateway Web Services

<back to all web services

GenerateWordPrintableDocument

Generate a (corporate identity) printable document based on an existing document registration or working file.

export class DocumentBase64File
{
    public ContentType: string;
    public Content: string;

    public constructor(init?: Partial<DocumentBase64File>) { (Object as any).assign(this, init); }
}

export class GenerateWordPrintableDocumentResponse implements IGenerateDraftDocumentResponse
{
    /** @description The file to print */
    // @ApiMember(Description="The file to print")
    public File: DocumentBase64File;

    public constructor(init?: Partial<GenerateWordPrintableDocumentResponse>) { (Object as any).assign(this, init); }
}

export enum PrintLogoStyle
{
    Colour = 'Colour',
    Invisible = 'Invisible',
}

export class WordPageSetup
{
    public FirstPageTray: number;
    public OtherPagesTray: number;

    public constructor(init?: Partial<WordPageSetup>) { (Object as any).assign(this, init); }
}

/** @description Generate a (corporate identity) printable document based on an existing document registration or working file. */
// @Api(Description="Generate a (corporate identity) printable document based on an existing document registration or working file.")
export class GenerateWordPrintableDocument implements IRegisteredDocumentRequest
{
    /** @description ID of the current document registration */
    // @ApiMember(Description="ID of the current document registration", IsRequired=true)
    public RegisteredDocumentID: string;

    /** @description The unsaved active document to print instead of the saved document. */
    // @ApiMember(Description="The unsaved active document to print instead of the saved document.")
    public WorkingFile: DocumentBase64File;

    /** @description When printing on stationary use PrintLogoStyle.Hidden to remove subsidary logo's from the document */
    // @ApiMember(Description="When printing on stationary use PrintLogoStyle.Hidden to remove subsidary logo's from the document")
    public LogoStyle: PrintLogoStyle;

    /** @description Represents a subset of the page setup properties of a section. */
    // @ApiMember(Description="Represents a subset of the page setup properties of a section.")
    public PageSetup: WordPageSetup;

    public constructor(init?: Partial<GenerateWordPrintableDocument>) { (Object as any).assign(this, init); }
}

TypeScript GenerateWordPrintableDocument DTOs

POST /api/documentgenerator/word/generateprintabledocument HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GenerateWordPrintableDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.Operations.Word">
  <LogoStyle>Colour</LogoStyle>
  <PageSetup xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.DTO.Word">
    <d2p1:FirstPageTray>0</d2p1:FirstPageTray>
    <d2p1:OtherPagesTray>0</d2p1:OtherPagesTray>
  </PageSetup>
  <RegisteredDocumentID>00000000-0000-0000-0000-000000000000</RegisteredDocumentID>
  <WorkingFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.DTO">
    <d2p1:Content>String</d2p1:Content>
    <d2p1:ContentType>String</d2p1:ContentType>
  </WorkingFile>
</GenerateWordPrintableDocument>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GenerateWordPrintableDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.DTO.Word">
  <File xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.DTO">
    <d2p1:Content>String</d2p1:Content>
    <d2p1:ContentType>String</d2p1:ContentType>
  </File>
</GenerateWordPrintableDocumentResponse>