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:
All Verbs	/api/documentgenerator/word/generateprintabledocument

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.DocumentGenerator.SDK.Operations.Word
Imports IDB.DocumentGenerator.SDK.DTO
Imports IDB.DocumentGenerator.SDK.DTO.Word

Namespace Global

    Namespace IDB.DocumentGenerator.SDK.DTO

        Public Partial Class DocumentBase64File
            Public Overridable Property ContentType As String
            Public Overridable Property Content As String
        End Class

        Public Enum PrintLogoStyle
            Colour
            Invisible
        End Enum
    End Namespace

    Namespace IDB.DocumentGenerator.SDK.DTO.Word

        Public Partial Class GenerateWordPrintableDocumentResponse
            Implements IGenerateWordPrintableDocumentResponse
            '''<Summary>
            '''The file to print
            '''</Summary>
            <ApiMember(Description:="The file to print")>
            Public Overridable Property File As DocumentBase64File
        End Class

        Public Partial Class WordPageSetup
            Public Overridable Property FirstPageTray As Integer
            Public Overridable Property OtherPagesTray As Integer
        End Class
    End Namespace

    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
            Implements IGenerateWordPrintableDocument
            Implements IRegisteredDocumentRequest
            '''<Summary>
            '''ID of the current document registration
            '''</Summary>
            <ApiMember(Description:="ID of the current document registration", IsRequired:=true)>
            Public Overridable Property RegisteredDocumentID As Guid

            '''<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 Overridable Property WorkingFile As DocumentBase64File

            '''<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 Overridable Property LogoStyle As PrintLogoStyle

            '''<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 Overridable Property PageSetup As WordPageSetup
        End Class
    End Namespace
End Namespace

VB.NET GenerateWordPrintableDocument 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/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>