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

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

    [<AllowNullLiteral>]
    type GeneratePowerPointDocumentResponse() = 
        ///<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)>]
        member val DocumentID:Guid = new Guid() with get,set

    ///<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.")>]
    [<AllowNullLiteral>]
    type GeneratePowerPointDocument() = 
        ///<summary>
        ///ID of the current document registration
        ///</summary>
        [<ApiMember(Description="ID of the current document registration", IsRequired=true)>]
        member val RegisteredDocumentID:Guid = new Guid() with get,set

        ///<summary>
        ///Recreate document
        ///</summary>
        [<ApiMember(Description="Recreate document", IsRequired=true)>]
        member val RecreateDocument:Boolean = new Boolean() with get,set

        ///<summary>
        ///ID of the document generator configuration
        ///</summary>
        [<ApiMember(Description="ID of the document generator configuration")>]
        member val DocumentGeneratorDocumentID:Nullable<Guid> = new Nullable<Guid>() with 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.")>]
        member val DataSourceEntityID:String = null with get,set

F# GeneratePowerPointDocument DTOs

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

HTTP + JSV

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

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

{
	RecreateDocument: False,
	DocumentGeneratorDocumentID: 00000000-0000-0000-0000-000000000000,
	DataSourceEntityID: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}