DigiOffice Gateway Web Services

<back to all web services

GenerateWordDocument

Generate new or update a (corporate identity) document based on an existing document registration.

Requires Authentication
GenerateWordDocument Parameters:
NameParameterData TypeRequiredDescription
RegisteredDocumentIDqueryGuidYesID of the current document registration
RecreateDocumentqueryboolYesRecreate document
DocumentGeneratorDocumentIDqueryGuid?NoID of the document generator configuration
DataSourceEntityIDquerystringNoID 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.
GenerateWordDocumentResponse Parameters:
NameParameterData TypeRequiredDescription
DocumentIDformGuidYesContains the registration ID of the generated (corporate identity) document

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/GenerateWordDocument 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"}