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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /jsv/reply/GenerateExcelDocument HTTP/1.1 
Host: dogw.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RecreateDocument: False,
	DocumentGeneratorDocumentID: 00000000-0000-0000-0000-000000000000,
	DataSourceEntityID: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}