DigiOffice Gateway Web Services

GenerateDraftWordDocument

Generate a new or update a (corporate identity) MS Word document without registration.

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

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
    End Namespace

    Namespace IDB.DocumentGenerator.SDK.DTO.Word

        Public Partial Class GenerateDraftWordDocumentResponse
            Implements IGenerateDraftDocumentResponse
            '''<Summary>
            '''Contains the file
            '''</Summary>
            <ApiMember(Description:="Contains the file")>
            Public Overridable Property File As DocumentBase64File
        End Class
    End Namespace

    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
            Implements IGenerateDraftOfficeDocument
            '''<Summary>
            '''The DocumentInfo result of the registration wizard.
            '''</Summary>
            <ApiMember(Description:="The DocumentInfo result of the registration wizard.", IsRequired:=true)>
            Public Overridable Property DocumentInfo As String

            '''<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 Overridable Property CustomData As String

            '''<Summary>
            '''The document to update.
            '''</Summary>
            <ApiMember(Description:="The document to update.")>
            Public Overridable Property File As DocumentBase64File
        End Class
    End Namespace
End Namespace

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