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
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Generate new or update a (corporate identity) document based on an existing document registration.
*/
@Api(Description="Generate new or update a (corporate identity) document based on an existing document registration.")
open class GenerateExcelDocument : IGenerateExcelDocument
{
    /**
    * ID of the current document registration
    */
    @ApiMember(Description="ID of the current document registration", IsRequired=true)
    var RegisteredDocumentID:UUID? = null

    /**
    * Recreate document
    */
    @ApiMember(Description="Recreate document", IsRequired=true)
    var RecreateDocument:Boolean? = null

    /**
    * ID of the document generator configuration
    */
    @ApiMember(Description="ID of the document generator configuration")
    var DocumentGeneratorDocumentID:UUID? = null

    /**
    * 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.
    */
    @ApiMember(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.")
    var DataSourceEntityID:String? = null
}

open class GenerateExcelDocumentResponse : IGenerateExcelDocumentResponse
{
    /**
    * Contains the registration ID of the generated (corporate identity) document
    */
    @ApiMember(Description="Contains the registration ID of the generated (corporate identity) document", IsRequired=true)
    var DocumentID:UUID? = null
}

Kotlin GenerateExcelDocument DTOs

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

HTTP + CSV

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

POST /csv/reply/GenerateExcelDocument HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"RegisteredDocumentID":"00000000-0000-0000-0000-000000000000","RecreateDocument":false,"DocumentGeneratorDocumentID":"00000000-0000-0000-0000-000000000000","DataSourceEntityID":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"DocumentID":"00000000-0000-0000-0000-000000000000"}