DigiOffice Gateway Web Services

<back to all web services

GetTemporaryLinkDetails

The following routes are available for this service:
GET/api/temporarylinkdetails/{DocumentID}
<?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 TemporaryLinkDetailsResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Title=null,
        /** @var string|null */
        public ?string $Message=null,
        /** @var string|null */
        public ?string $SubMessage=null,
        /** @var int */
        public int $NumberOfAttachments=0,
        /** @var int */
        public int $TotalSizeInBytes=0,
        /** @var bool|null */
        public ?bool $IsValid=null
    ) {
    }

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

class GetTemporaryLinkDetails implements JsonSerializable
{
    public function __construct(
        /** @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;
    }
}

PHP GetTemporaryLinkDetails 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.

GET /api/temporarylinkdetails/{DocumentID} HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Title":"String","Message":"String","SubMessage":"String","NumberOfAttachments":0,"TotalSizeInBytes":0,"IsValid":false}