DigiOffice Gateway Web Services

<back to all web services

GenerateWordPrintableDocument

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

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
        : IGenerateWordPrintableDocumentResponse
    {
        ///<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
        : IGenerateWordPrintableDocument, 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

POST /api/documentgenerator/word/generateprintabledocument HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GenerateWordPrintableDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.Operations.Word">
  <LogoStyle>Colour</LogoStyle>
  <PageSetup xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.DTO.Word">
    <d2p1:FirstPageTray>0</d2p1:FirstPageTray>
    <d2p1:OtherPagesTray>0</d2p1:OtherPagesTray>
  </PageSetup>
  <RegisteredDocumentID>00000000-0000-0000-0000-000000000000</RegisteredDocumentID>
  <WorkingFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.DTO">
    <d2p1:Content>String</d2p1:Content>
    <d2p1:ContentType>String</d2p1:ContentType>
  </WorkingFile>
</GenerateWordPrintableDocument>

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

<GenerateWordPrintableDocumentResponse 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>
</GenerateWordPrintableDocumentResponse>