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
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class GeneratePowerPointDocumentResponse implements IGeneratePowerPointDocumentResponse, IConvertible
{
    /**
    * Contains the registration ID of the generated (corporate identity) document
    */
    // @ApiMember(Description="Contains the registration ID of the generated (corporate identity) document", IsRequired=true)
    String? DocumentID;

    GeneratePowerPointDocumentResponse({this.DocumentID});
    GeneratePowerPointDocumentResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        DocumentID = json['DocumentID'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'DocumentID': DocumentID
    };

    getTypeName() => "GeneratePowerPointDocumentResponse";
    TypeContext? context = _ctx;
}

/**
* Generate new or update a (corporate identity) document based on an existing document registration.
*/
// @Api(Description="Generate new or update a (corporate identity) document based on an existing document registration.")
class GeneratePowerPointDocument implements IGeneratePowerPointDocument, IConvertible
{
    /**
    * ID of the current document registration
    */
    // @ApiMember(Description="ID of the current document registration", IsRequired=true)
    String? RegisteredDocumentID;

    /**
    * Recreate document
    */
    // @ApiMember(Description="Recreate document", IsRequired=true)
    bool? RecreateDocument;

    /**
    * ID of the document generator configuration
    */
    // @ApiMember(Description="ID of the document generator configuration")
    String? DocumentGeneratorDocumentID;

    /**
    * 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.
    */
    // @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.")
    String? DataSourceEntityID;

    GeneratePowerPointDocument({this.RegisteredDocumentID,this.RecreateDocument,this.DocumentGeneratorDocumentID,this.DataSourceEntityID});
    GeneratePowerPointDocument.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RegisteredDocumentID = json['RegisteredDocumentID'];
        RecreateDocument = json['RecreateDocument'];
        DocumentGeneratorDocumentID = json['DocumentGeneratorDocumentID'];
        DataSourceEntityID = json['DataSourceEntityID'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RegisteredDocumentID': RegisteredDocumentID,
        'RecreateDocument': RecreateDocument,
        'DocumentGeneratorDocumentID': DocumentGeneratorDocumentID,
        'DataSourceEntityID': DataSourceEntityID
    };

    getTypeName() => "GeneratePowerPointDocument";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
    'GeneratePowerPointDocumentResponse': TypeInfo(TypeOf.Class, create:() => GeneratePowerPointDocumentResponse()),
    'GeneratePowerPointDocument': TypeInfo(TypeOf.Class, create:() => GeneratePowerPointDocument()),
});

Dart 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"}