| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RegisteredDocumentID | query | Guid | Yes | ID of the current document registration |
| RecreateDocument | query | bool | Yes | Recreate document |
| DocumentGeneratorDocumentID | query | Guid? | No | ID of the document generator configuration |
| DataSourceEntityID | query | string | No | 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentID | form | Guid | Yes | Contains 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
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"}