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

namespace IDB.DocumentGenerator.SDK.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DocumentBase64File() = 
        member val ContentType:String = null with get,set
        member val Content:String = null with get,set

    [<AllowNullLiteral>]
    type GenerateDraftWordDocumentResponse() = 
        ///<summary>
        ///Contains the file
        ///</summary>
        [<ApiMember(Description="Contains the file")>]
        member val File:DocumentBase64File = null with get,set

    ///<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.")>]
    [<AllowNullLiteral>]
    type GenerateDraftWordDocument() = 
        ///<summary>
        ///The DocumentInfo result of the registration wizard.
        ///</summary>
        [<ApiMember(Description="The DocumentInfo result of the registration wizard.", IsRequired=true)>]
        member val DocumentInfo:String = null with 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.")>]
        member val CustomData:String = null with get,set

        ///<summary>
        ///The document to update.
        ///</summary>
        [<ApiMember(Description="The document to update.")>]
        member val File:DocumentBase64File = null with get,set

F# 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>