DigiOffice Gateway Web Services

<back to all web services

GenerateExcelDocument

Generate new or update a (corporate identity) document based on an existing document registration.

Requires Authentication
"use strict";
export class GenerateExcelDocumentResponse {
    /** @param {{DocumentID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Contains the registration ID of the generated (corporate identity) document */
    DocumentID;
}
export class GenerateExcelDocument {
    /** @param {{RegisteredDocumentID?:string,RecreateDocument?:boolean,DocumentGeneratorDocumentID?:string,DataSourceEntityID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description ID of the current document registration */
    RegisteredDocumentID;
    /**
     * @type {boolean}
     * @description Recreate document */
    RecreateDocument;
    /**
     * @type {?string}
     * @description ID of the document generator configuration */
    DocumentGeneratorDocumentID;
    /**
     * @type {string}
     * @description ID of the entity (corresponding to the entityType configured at the DocumentGeneratorDocument) to use as the datasource. Leave blank to fall back on the current document registration. */
    DataSourceEntityID;
}

JavaScript GenerateExcelDocument 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 /xml/reply/GenerateExcelDocument HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GenerateExcelDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.Operations.Excel">
  <DataSourceEntityID>String</DataSourceEntityID>
  <DocumentGeneratorDocumentID>00000000-0000-0000-0000-000000000000</DocumentGeneratorDocumentID>
  <RecreateDocument>false</RecreateDocument>
  <RegisteredDocumentID>00000000-0000-0000-0000-000000000000</RegisteredDocumentID>
</GenerateExcelDocument>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GenerateExcelDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.DTO.Excel">
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
</GenerateExcelDocumentResponse>