DigiOffice Gateway Web Services

<back to all web services

UpdateDocumentRegistration

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 RegisterDocumentResponse implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $IsSucces=null,
        /** @var string */
        public string $DocumentId='',
        /** @var array<string>|null */
        public ?array $ErrorMessages=null,
        /** @var string|null */
        public ?string $Ooxml=null,
        /** @description Is it a corporate identity document? */
        // @ApiMember(Description="Is it a corporate identity document?", IsRequired=true)
        /** @var bool|null */
        public ?bool $IsCorporateIdentity=null,

        /** @var array<string,string>|null */
        public ?array $DocumentVariables=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['IsSucces'])) $this->IsSucces = $o['IsSucces'];
        if (isset($o['DocumentId'])) $this->DocumentId = $o['DocumentId'];
        if (isset($o['ErrorMessages'])) $this->ErrorMessages = JsonConverters::fromArray('string', $o['ErrorMessages']);
        if (isset($o['Ooxml'])) $this->Ooxml = $o['Ooxml'];
        if (isset($o['IsCorporateIdentity'])) $this->IsCorporateIdentity = $o['IsCorporateIdentity'];
        if (isset($o['DocumentVariables'])) $this->DocumentVariables = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['DocumentVariables']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->IsSucces)) $o['IsSucces'] = $this->IsSucces;
        if (isset($this->DocumentId)) $o['DocumentId'] = $this->DocumentId;
        if (isset($this->ErrorMessages)) $o['ErrorMessages'] = JsonConverters::toArray('string', $this->ErrorMessages);
        if (isset($this->Ooxml)) $o['Ooxml'] = $this->Ooxml;
        if (isset($this->IsCorporateIdentity)) $o['IsCorporateIdentity'] = $this->IsCorporateIdentity;
        if (isset($this->DocumentVariables)) $o['DocumentVariables'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->DocumentVariables);
        return empty($o) ? new class(){} : $o;
    }
}

class RegistrationValue implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $Key='',
        /** @var string|null */
        public ?string $Value=null,
        /** @var string|null */
        public ?string $ShadowValue=null
    ) {
    }

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

class Transition implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ID='',
        /** @var string|null */
        public ?string $Reason=null,
        /** @var DateTime|null */
        public ?DateTime $DelayDate=null,
        /** @var string|null */
        public ?string $DelayReason=null,
        /** @var array<int>|null */
        public ?array $UserIDs=null,
        /** @var array<int>|null */
        public ?array $GroupIDs=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ID'])) $this->ID = $o['ID'];
        if (isset($o['Reason'])) $this->Reason = $o['Reason'];
        if (isset($o['DelayDate'])) $this->DelayDate = JsonConverters::from('DateTime', $o['DelayDate']);
        if (isset($o['DelayReason'])) $this->DelayReason = $o['DelayReason'];
        if (isset($o['UserIDs'])) $this->UserIDs = JsonConverters::fromArray('int', $o['UserIDs']);
        if (isset($o['GroupIDs'])) $this->GroupIDs = JsonConverters::fromArray('int', $o['GroupIDs']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ID)) $o['ID'] = $this->ID;
        if (isset($this->Reason)) $o['Reason'] = $this->Reason;
        if (isset($this->DelayDate)) $o['DelayDate'] = JsonConverters::to('DateTime', $this->DelayDate);
        if (isset($this->DelayReason)) $o['DelayReason'] = $this->DelayReason;
        if (isset($this->UserIDs)) $o['UserIDs'] = JsonConverters::toArray('int', $this->UserIDs);
        if (isset($this->GroupIDs)) $o['GroupIDs'] = JsonConverters::toArray('int', $this->GroupIDs);
        return empty($o) ? new class(){} : $o;
    }
}

class Process implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ID=0,
        /** @var string|null */
        public ?string $Title=null,
        /** @var string|null */
        public ?string $Description=null,
        /** @var string|null */
        public ?string $Note=null,
        /** @var string|null */
        public ?string $Coordinator=null,
        /** @var bool|null */
        public ?bool $Urgent=null,
        /** @var array<Transition>|null */
        public ?array $Transitions=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ID'])) $this->ID = $o['ID'];
        if (isset($o['Title'])) $this->Title = $o['Title'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['Note'])) $this->Note = $o['Note'];
        if (isset($o['Coordinator'])) $this->Coordinator = $o['Coordinator'];
        if (isset($o['Urgent'])) $this->Urgent = $o['Urgent'];
        if (isset($o['Transitions'])) $this->Transitions = JsonConverters::fromArray('Transition', $o['Transitions']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ID)) $o['ID'] = $this->ID;
        if (isset($this->Title)) $o['Title'] = $this->Title;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->Note)) $o['Note'] = $this->Note;
        if (isset($this->Coordinator)) $o['Coordinator'] = $this->Coordinator;
        if (isset($this->Urgent)) $o['Urgent'] = $this->Urgent;
        if (isset($this->Transitions)) $o['Transitions'] = JsonConverters::toArray('Transition', $this->Transitions);
        return empty($o) ? new class(){} : $o;
    }
}

class UpdateDocumentRegistration implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $DocumentID='',
        /** @var array<RegistrationValue>|null */
        public ?array $Values=null,
        /** @var array<Process>|null */
        public ?array $Processes=null,
        /** @var bool|null */
        public ?bool $GenerateOoxml=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['DocumentID'])) $this->DocumentID = $o['DocumentID'];
        if (isset($o['Values'])) $this->Values = JsonConverters::fromArray('RegistrationValue', $o['Values']);
        if (isset($o['Processes'])) $this->Processes = JsonConverters::fromArray('Process', $o['Processes']);
        if (isset($o['GenerateOoxml'])) $this->GenerateOoxml = $o['GenerateOoxml'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->DocumentID)) $o['DocumentID'] = $this->DocumentID;
        if (isset($this->Values)) $o['Values'] = JsonConverters::toArray('RegistrationValue', $this->Values);
        if (isset($this->Processes)) $o['Processes'] = JsonConverters::toArray('Process', $this->Processes);
        if (isset($this->GenerateOoxml)) $o['GenerateOoxml'] = $this->GenerateOoxml;
        return empty($o) ? new class(){} : $o;
    }
}

PHP UpdateDocumentRegistration DTOs

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

HTTP + CSV

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

POST /csv/reply/UpdateDocumentRegistration HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DocumentID":"00000000-0000-0000-0000-000000000000","Values":[{"Key":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String"}],"Processes":[{"ID":0,"Title":"String","Description":"String","Note":"String","Coordinator":"String","Urgent":false,"Transitions":[{"ID":"00000000-0000-0000-0000-000000000000","Reason":"String","DelayDate":"0001-01-01T00:00:00.0000000","DelayReason":"String","UserIDs":[0],"GroupIDs":[0]}]}],"GenerateOoxml":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"IsSucces":false,"DocumentId":"00000000-0000-0000-0000-000000000000","ErrorMessages":["String"],"Ooxml":"String","IsCorporateIdentity":false,"DocumentVariables":null}