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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/GeneratePowerPointDocument HTTP/1.1
Host: digiofficeapigateway.deltares.nl
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GeneratePowerPointDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.Operations.PowerPoint">
<DataSourceEntityID>String</DataSourceEntityID>
<DocumentGeneratorDocumentID>00000000-0000-0000-0000-000000000000</DocumentGeneratorDocumentID>
<RecreateDocument>false</RecreateDocument>
<RegisteredDocumentID>00000000-0000-0000-0000-000000000000</RegisteredDocumentID>
</GeneratePowerPointDocument>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GeneratePowerPointDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.DTO.PowerPoint"> <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID> </GeneratePowerPointDocumentResponse>