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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * 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.")
    public static class GenerateDraftWordDocument implements IGenerateDraftOfficeDocument
    {
        /**
        * The DocumentInfo result of the registration wizard.
        */
        @ApiMember(Description="The DocumentInfo result of the registration wizard.", IsRequired=true)
        public String DocumentInfo = null;

        /**
        * 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 String CustomData = null;

        /**
        * The document to update.
        */
        @ApiMember(Description="The document to update.")
        public DocumentBase64File File = null;
        
        public String getDocumentInfo() { return DocumentInfo; }
        public GenerateDraftWordDocument setDocumentInfo(String value) { this.DocumentInfo = value; return this; }
        public String getCustomData() { return CustomData; }
        public GenerateDraftWordDocument setCustomData(String value) { this.CustomData = value; return this; }
        public DocumentBase64File getFile() { return File; }
        public GenerateDraftWordDocument setFile(DocumentBase64File value) { this.File = value; return this; }
    }

    public static class DocumentBase64File
    {
        public String ContentType = null;
        public String Content = null;
        
        public String getContentType() { return ContentType; }
        public DocumentBase64File setContentType(String value) { this.ContentType = value; return this; }
        public String getContent() { return Content; }
        public DocumentBase64File setContent(String value) { this.Content = value; return this; }
    }

    public static class GenerateDraftWordDocumentResponse implements IGenerateDraftDocumentResponse
    {
        /**
        * Contains the file
        */
        @ApiMember(Description="Contains the file")
        public DocumentBase64File File = null;
        
        public DocumentBase64File getFile() { return File; }
        public GenerateDraftWordDocumentResponse setFile(DocumentBase64File value) { this.File = value; return this; }
    }

}

Java 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>