DigiOffice Gateway Web Services

<back to all web services

GenerateWordDocument

Generate new or update a (corporate identity) document based on an existing document registration.

Requires Authentication
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.Word;

namespace IDB.DocumentGenerator.SDK.DTO.Word
{
    public partial class GenerateWordDocumentResponse
        : IGenerateWordDocumentResponse
    {
        ///<summary>
        ///Contains the registration ID of the generated (corporate identity) document
        ///</summary>
        [ApiMember(Description="Contains the registration ID of the generated (corporate identity) document", IsRequired=true)]
        public virtual Guid DocumentID { get; set; }
    }

}

namespace IDB.DocumentGenerator.SDK.Operations.Word
{
    ///<summary>
    ///Generate new or update a (corporate identity) document based on an existing document registration.
    ///</summary>
    [Api(Description="Generate new or update a (corporate identity) document based on an existing document registration.")]
    public partial class GenerateWordDocument
        : IGenerateWordDocument
    {
        ///<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>
        ///Recreate document
        ///</summary>
        [ApiMember(Description="Recreate document", IsRequired=true)]
        public virtual bool RecreateDocument { get; set; }

        ///<summary>
        ///ID of the document generator configuration
        ///</summary>
        [ApiMember(Description="ID of the document generator configuration")]
        public virtual Guid? DocumentGeneratorDocumentID { get; set; }

        ///<summary>
        ///ID of the entity (corresponding to the entityType configured at the DocumentGeneratorDocument) to use as the datasource. Leave blank to fall back on the current document registration.
        ///</summary>
        [ApiMember(Description="ID of the entity (corresponding to the entityType configured at the DocumentGeneratorDocument) to use as the datasource. Leave blank to fall back on the current document registration.")]
        public virtual string DataSourceEntityID { get; set; }
    }

}

C# GenerateWordDocument 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 /xml/reply/GenerateWordDocument HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GenerateWordDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.Operations.Word">
  <DataSourceEntityID>String</DataSourceEntityID>
  <DocumentGeneratorDocumentID>00000000-0000-0000-0000-000000000000</DocumentGeneratorDocumentID>
  <RecreateDocument>false</RecreateDocument>
  <RegisteredDocumentID>00000000-0000-0000-0000-000000000000</RegisteredDocumentID>
</GenerateWordDocument>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GenerateWordDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.DocumentGenerator.SDK.DTO.Word">
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
</GenerateWordDocumentResponse>