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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.DocumentGenerator.SDK.Operations.Word;
using IDB.DocumentGenerator.SDK.DTO;
using IDB.DocumentGenerator.SDK.DTO.Word;

namespace IDB.DocumentGenerator.SDK.DTO
{
    public partial class DocumentBase64File
    {
        public virtual string ContentType { get; set; }
        public virtual string Content { get; set; }
    }

}

namespace IDB.DocumentGenerator.SDK.DTO.Word
{
    public partial class GenerateDraftWordDocumentResponse
        : IGenerateDraftDocumentResponse
    {
        ///<summary>
        ///Contains the file
        ///</summary>
        [ApiMember(Description="Contains the file")]
        public virtual DocumentBase64File File { get; set; }
    }

}

namespace IDB.DocumentGenerator.SDK.Operations.Word
{
    ///<summary>
    ///Generate a new or update a (corporate identity) MS Word document without registration.
    ///</summary>
    [Api(Description="Generate a new or update a (corporate identity) MS Word document without registration.")]
    public partial class GenerateDraftWordDocument
        : IGenerateDraftOfficeDocument
    {
        ///<summary>
        ///The DocumentInfo result of the registration wizard.
        ///</summary>
        [ApiMember(Description="The DocumentInfo result of the registration wizard.", IsRequired=true)]
        public virtual string DocumentInfo { get; set; }

        ///<summary>
        ///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.
        ///</summary>
        [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 virtual string CustomData { get; set; }

        ///<summary>
        ///The document to update.
        ///</summary>
        [ApiMember(Description="The document to update.")]
        public virtual DocumentBase64File File { get; set; }
    }

}

C# GenerateDraftWordDocument DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"DocumentInfo":"String","CustomData":"String","File":{"ContentType":"String","Content":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"File":{"ContentType":"String","Content":"String"}}