DigiOffice API Services Services

GenerateDraftExcelDocument

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

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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Generate a new or update a (corporate identity) MS Excel document without registration.
*/
@Api(Description="Generate a new or update a (corporate identity) MS Excel document without registration.")
open class GenerateDraftExcelDocument : IGenerateDraftOfficeDocument
{
    /**
    * The DocumentInfo result of the registration wizard.
    */
    @ApiMember(Description="The DocumentInfo result of the registration wizard.", IsRequired=true)
    override var DocumentInfo:String? = null

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

    /**
    * The document to update.
    */
    @ApiMember(Description="The document to update.")
    override var File:DocumentBase64File? = null
}

open class DocumentBase64File
{
    open var ContentType:String? = null
    open var Content:String? = null
}

open class GenerateDraftExcelDocumentResponse : IGenerateDraftDocumentResponse
{
    /**
    * Contains the file
    */
    @ApiMember(Description="Contains the file")
    override var File:DocumentBase64File? = null
}

Kotlin GenerateDraftExcelDocument 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/excel/generatedraftdocument HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GenerateDraftExcelDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.Operations.Excel">
  <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>
</GenerateDraftExcelDocument>

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

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