DigiOffice API Services Services

GenerateWordPrintableDocument

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

The following routes are available for this service:
POST	/api/documentgenerator/word/generateprintabledocument

"use strict";
export class DocumentBase64File {
    /** @param {{ContentType?:string,Content?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ContentType;
    /** @type {string} */
    Content;
}
export class GenerateWordPrintableDocumentResponse {
    /** @param {{File?:DocumentBase64File}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {DocumentBase64File}
     * @description The file to print */
    File;
}
/** @typedef {'Colour'|'Invisible'} */
export var PrintLogoStyle;
(function (PrintLogoStyle) {
    PrintLogoStyle["Colour"] = "Colour"
    PrintLogoStyle["Invisible"] = "Invisible"
})(PrintLogoStyle || (PrintLogoStyle = {}));
export class WordPageSetup {
    /** @param {{FirstPageTray?:number,OtherPagesTray?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    FirstPageTray;
    /** @type {number} */
    OtherPagesTray;
}
export class GenerateWordPrintableDocument {
    /** @param {{RegisteredDocumentID?:string,WorkingFile?:DocumentBase64File,LogoStyle?:PrintLogoStyle,PageSetup?:WordPageSetup}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description ID of the current document registration */
    RegisteredDocumentID;
    /**
     * @type {DocumentBase64File}
     * @description The unsaved active document to print instead of the saved document. */
    WorkingFile;
    /**
     * @type {PrintLogoStyle}
     * @description When printing on stationary use PrintLogoStyle.Hidden to remove subsidary logo's from the document */
    LogoStyle;
    /**
     * @type {WordPageSetup}
     * @description Represents a subset of the page setup properties of a section. */
    PageSetup;
}

JavaScript GenerateWordPrintableDocument DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/documentgenerator/word/generateprintabledocument HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"RegisteredDocumentID":"00000000-0000-0000-0000-000000000000","WorkingFile":{"ContentType":"String","Content":"String"},"LogoStyle":"Colour","PageSetup":{"FirstPageTray":0,"OtherPagesTray":0}}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"File":{"ContentType":"String","Content":"String"}}