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
GenerateDraftWordDocument Parameters:
NameParameterData TypeRequiredDescription
DocumentInfobodystringYesThe DocumentInfo result of the registration wizard.
CustomDatabodystringNoHier 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.
FilebodyDocumentBase64FileNoThe document to update.
DocumentBase64File Parameters:
NameParameterData TypeRequiredDescription
ContentTypeformstringNo
ContentformstringNo
GenerateDraftWordDocumentResponse Parameters:
NameParameterData TypeRequiredDescription
FileformDocumentBase64FileNoContains the file

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

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

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