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
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class GeneratePowerPointDocumentResponse implements IGeneratePowerPointDocumentResponse, JsonSerializable
{
    public function __construct(
        /** @description Contains the registration ID of the generated (corporate identity) document */
        // @ApiMember(Description="Contains the registration ID of the generated (corporate identity) document", IsRequired=true)
        /** @var string */
        public string $DocumentID=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['DocumentID'])) $this->DocumentID = $o['DocumentID'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->DocumentID)) $o['DocumentID'] = $this->DocumentID;
        return empty($o) ? new class(){} : $o;
    }
}

/** @description 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 IGenerateOfficeDocument, JsonSerializable
{
    public function __construct(
        /** @description ID of the current document registration */
        // @ApiMember(Description="ID of the current document registration", IsRequired=true)
        /** @var string */
        public string $RegisteredDocumentID='',

        /** @description Recreate document */
        // @ApiMember(Description="Recreate document", IsRequired=true)
        /** @var bool|null */
        public ?bool $RecreateDocument=null,

        /** @description ID of the document generator configuration */
        // @ApiMember(Description="ID of the document generator configuration")
        /** @var string|null */
        public ?string $DocumentGeneratorDocumentID=null,

        /** @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. */
        // @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.")
        /** @var string|null */
        public ?string $DataSourceEntityID=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['RegisteredDocumentID'])) $this->RegisteredDocumentID = $o['RegisteredDocumentID'];
        if (isset($o['RecreateDocument'])) $this->RecreateDocument = $o['RecreateDocument'];
        if (isset($o['DocumentGeneratorDocumentID'])) $this->DocumentGeneratorDocumentID = $o['DocumentGeneratorDocumentID'];
        if (isset($o['DataSourceEntityID'])) $this->DataSourceEntityID = $o['DataSourceEntityID'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->RegisteredDocumentID)) $o['RegisteredDocumentID'] = $this->RegisteredDocumentID;
        if (isset($this->RecreateDocument)) $o['RecreateDocument'] = $this->RecreateDocument;
        if (isset($this->DocumentGeneratorDocumentID)) $o['DocumentGeneratorDocumentID'] = $this->DocumentGeneratorDocumentID;
        if (isset($this->DataSourceEntityID)) $o['DataSourceEntityID'] = $this->DataSourceEntityID;
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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: dogw.klokgroep.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

{
	
}