export class GenerateWordDocumentResponse implements IGenerateWordDocumentResponse
{
/**
* Contains the registration ID of the generated (corporate identity) document
*/
// @ApiMember(Description="Contains the registration ID of the generated (corporate identity) document", IsRequired=true)
public DocumentID?: string;
public constructor(init?: Partial<GenerateWordDocumentResponse>) { (Object as any).assign(this, init); }
}
/**
* Generate new or update a (corporate identity) document based on an existing document registration.
*/
// @Api(Description="Generate new or update a (corporate identity) document based on an existing document registration.")
export class GenerateWordDocument implements IGenerateWordDocument
{
/**
* ID of the current document registration
*/
// @ApiMember(Description="ID of the current document registration", IsRequired=true)
public RegisteredDocumentID?: string;
/**
* Recreate document
*/
// @ApiMember(Description="Recreate document", IsRequired=true)
public RecreateDocument: boolean;
/**
* ID of the document generator configuration
*/
// @ApiMember(Description="ID of the document generator configuration")
public DocumentGeneratorDocumentID?: string;
/**
* 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.
*/
// @ApiMember(Description="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.")
public DataSourceEntityID?: string;
public constructor(init?: Partial<GenerateWordDocument>) { (Object as any).assign(this, init); }
}
TypeScript GenerateWordDocument DTOs
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/GenerateWordDocument HTTP/1.1
Host: digiofficeapigateway.deltares.nl
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GenerateWordDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.Operations.Word">
<DataSourceEntityID>String</DataSourceEntityID>
<DocumentGeneratorDocumentID>00000000-0000-0000-0000-000000000000</DocumentGeneratorDocumentID>
<RecreateDocument>false</RecreateDocument>
<RegisteredDocumentID>00000000-0000-0000-0000-000000000000</RegisteredDocumentID>
</GenerateWordDocument>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GenerateWordDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.DTO.Word"> <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID> </GenerateWordDocumentResponse>