DigiOffice Gateway Web Services

<back to all web services

GenerateDraftWordDocument

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

Requires Authentication
The following routes are available for this service:
POST/api/documentgenerator/word/generatedraftdocument
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Generate a new or update a (corporate identity) MS Word document without registration.
*/
@Api(Description="Generate a new or update a (corporate identity) MS Word document without registration.")
open class GenerateDraftWordDocument : IGenerateDraftOfficeDocument
{
    /**
    * The DocumentInfo result of the registration wizard.
    */
    @ApiMember(Description="The DocumentInfo result of the registration wizard.", IsRequired=true)
    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.")
    var CustomData:String? = null

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

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

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

Kotlin GenerateDraftWordDocument DTOs

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

HTTP + OTHER

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: doapigw.baasbv.nl 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"DocumentInfo":"String","CustomData":"String","File":{"ContentType":"String","Content":"String"}}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"File":{"ContentType":"String","Content":"String"}}