export class GenerateExcelDocumentResponse implements IGenerateExcelDocumentResponse
{
/**
* 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<GenerateExcelDocumentResponse>) { (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 GenerateExcelDocument implements IGenerateExcelDocument
{
/**
* 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<GenerateExcelDocument>) { (Object as any).assign(this, init); }
}
TypeScript GenerateExcelDocument DTOs
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/GenerateExcelDocument HTTP/1.1
Host: digiofficeapigateway.deltares.nl
Accept: application/json
Content-Type: application/json
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: application/json
Content-Length: length
{"DocumentID":"00000000-0000-0000-0000-000000000000"}