DigiOffice Gateway Web Services

<back to all web services

GeneratePowerPointDocument

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.PowerPoint;
using IDB.DocumentGenerator.SDK.DTO.PowerPoint;

namespace IDB.DocumentGenerator.SDK.DTO.PowerPoint
{
    public partial class GeneratePowerPointDocumentResponse
        : IGeneratePowerPointDocumentResponse
    {
        ///<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.PowerPoint
{
    ///<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 GeneratePowerPointDocument
        : IGeneratePowerPointDocument
    {
        ///<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# GeneratePowerPointDocument DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/GeneratePowerPointDocument HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RegisteredDocumentID":"00000000-0000-0000-0000-000000000000","RecreateDocument":false,"DocumentGeneratorDocumentID":"00000000-0000-0000-0000-000000000000","DataSourceEntityID":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"DocumentID":"00000000-0000-0000-0000-000000000000"}