DigiOffice Gateway Web Services

GenerateWordPrintableDocument

Generate a (corporate identity) printable document based on an existing document registration or working file.

The following routes are available for this service:
POST	/api/documentgenerator/word/generateprintabledocument

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; }
    }

    public enum PrintLogoStyle
    {
        Colour,
        Invisible,
    }

}

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

    public partial class WordPageSetup
    {
        public virtual int FirstPageTray { get; set; }
        public virtual int OtherPagesTray { get; set; }
    }

}

namespace IDB.DocumentGenerator.SDK.Operations.Word
{
    ///<summary>
    ///Generate a (corporate identity) printable document based on an existing document registration or working file.
    ///</summary>
    [Api(Description="Generate a (corporate identity) printable document based on an existing document registration or working file.")]
    public partial class GenerateWordPrintableDocument
        : IRegisteredDocumentRequest
    {
        ///<summary>
        ///ID of the current document registration
        ///</summary>
        [ApiMember(Description="ID of the current document registration", IsRequired=true)]
        public virtual Guid RegisteredDocumentID { get; set; }

        ///<summary>
        ///The unsaved active document to print instead of the saved document.
        ///</summary>
        [ApiMember(Description="The unsaved active document to print instead of the saved document.")]
        public virtual DocumentBase64File WorkingFile { get; set; }

        ///<summary>
        ///When printing on stationary use PrintLogoStyle.Hidden to remove subsidary logo's from the document
        ///</summary>
        [ApiMember(Description="When printing on stationary use PrintLogoStyle.Hidden to remove subsidary logo's from the document")]
        public virtual PrintLogoStyle LogoStyle { get; set; }

        ///<summary>
        ///Represents a subset of the page setup properties of a section.
        ///</summary>
        [ApiMember(Description="Represents a subset of the page setup properties of a section.")]
        public virtual WordPageSetup PageSetup { get; set; }
    }

}

C# GenerateWordPrintableDocument 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

HTTP + JSON

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

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

{"RegisteredDocumentID":"00000000-0000-0000-0000-000000000000","WorkingFile":{"ContentType":"String","Content":"String"},"LogoStyle":"Colour","PageSetup":{"FirstPageTray":0,"OtherPagesTray":0}}

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

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