DigiOffice Gateway Web Services

<back to all web services

ValidSignNotification

The following routes are available for this service:
POST/api/validsign/notifications
<?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 ValidSignNotification implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Key=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $SessionUser=null,
        /** @var string|null */
        public ?string $PackageId=null,
        /** @var string|null */
        public ?string $Message=null,
        /** @var string|null */
        public ?string $DocumentId=null,
        /** @var string|null */
        public ?string $CreatedDate=null
    ) {
    }

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

PHP ValidSignNotification 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 /api/validsign/notifications HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Key":"String","Name":"String","SessionUser":"String","PackageId":"String","Message":"String","DocumentId":"String","CreatedDate":"String"}