DigiOffice Gateway Web Services

GenerateDraftWordDocument

Generate a new or update a (corporate identity) MS Word document without registration.

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

"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 GenerateDraftWordDocumentResponse {
    /** @param {{File?:DocumentBase64File}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {DocumentBase64File}
     * @description Contains the file */
    File;
}
export class GenerateDraftWordDocument {
    /** @param {{DocumentInfo?:string,CustomData?:string,File?:DocumentBase64File}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The DocumentInfo result of the registration wizard. */
    DocumentInfo;
    /**
     * @type {string}
     * @description Hier kan de (dynamische) data voor het document geplaatst worden, de data kan middels tekstblokken en placeholders worden geplaatst.Het formaat binnen CustomData staat vrij maar vereist een 'root' element. */
    CustomData;
    /**
     * @type {DocumentBase64File}
     * @description The document to update. */
    File;
}

JavaScript GenerateDraftWordDocument DTOs

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

HTTP + XML

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

POST /api/documentgenerator/word/generatedraftdocument HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<GenerateDraftWordDocumentResponse 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>
</GenerateDraftWordDocumentResponse>