DigiOffice Gateway Web Services

<back to all web services

GenerateDraftWordDocument

Generate a new or update a (corporate identity) MS Word document without registration.

Requires Authentication
The following routes are available for this service:
POST/api/documentgenerator/word/generatedraftdocument

export class DocumentBase64File
{
    public ContentType: string;
    public Content: string;

    public constructor(init?: Partial<DocumentBase64File>) { (Object as any).assign(this, init); }
}

export class GenerateDraftWordDocumentResponse implements IGenerateDraftDocumentResponse
{
    /** @description Contains the file */
    // @ApiMember(Description="Contains the file")
    public File: DocumentBase64File;

    public constructor(init?: Partial<GenerateDraftWordDocumentResponse>) { (Object as any).assign(this, init); }
}

/** @description Generate a new or update a (corporate identity) MS Word document without registration. */
// @Api(Description="Generate a new or update a (corporate identity) MS Word document without registration.")
export class GenerateDraftWordDocument implements IGenerateDraftOfficeDocument
{
    /** @description The DocumentInfo result of the registration wizard. */
    // @ApiMember(Description="The DocumentInfo result of the registration wizard.", IsRequired=true)
    public DocumentInfo: string;

    /** @description Hier kan de (dynamische) data voor het document geplaatst worden, de data kan middels tekstblokken en placeholders worden geplaatst.Het formaat binnen CustomData staat vrij maar vereist een 'root' element. */
    // @ApiMember(Description="Hier kan de (dynamische) data voor het document geplaatst worden, de data kan middels tekstblokken en placeholders worden geplaatst.Het formaat binnen CustomData staat vrij maar vereist een 'root' element.")
    public CustomData: string;

    /** @description The document to update. */
    // @ApiMember(Description="The document to update.")
    public File: DocumentBase64File;

    public constructor(init?: Partial<GenerateDraftWordDocument>) { (Object as any).assign(this, init); }
}

TypeScript GenerateDraftWordDocument DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/documentgenerator/word/generatedraftdocument HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GenerateDraftWordDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.Operations.Word">
  <CustomData>String</CustomData>
  <DocumentInfo>String</DocumentInfo>
  <File xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.DTO">
    <d2p1:Content>String</d2p1:Content>
    <d2p1:ContentType>String</d2p1:ContentType>
  </File>
</GenerateDraftWordDocument>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GenerateDraftWordDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.DTO.Word">
  <File xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.DTO">
    <d2p1:Content>String</d2p1:Content>
    <d2p1:ContentType>String</d2p1:ContentType>
  </File>
</GenerateDraftWordDocumentResponse>