DigiOffice API Services Services

GetDocumentFileDetails

The following routes are available for this service:
GET	/api/documents/{DocumentID}/filedetails

<?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 DocumentFile implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Extension=null,
        /** @var int */
        public int $Size=0,
        /** @var ByteArray|null */
        public ?ByteArray $Content=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Extension'])) $this->Extension = $o['Extension'];
        if (isset($o['Size'])) $this->Size = $o['Size'];
        if (isset($o['Content'])) $this->Content = JsonConverters::from('ByteArray', $o['Content']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Extension)) $o['Extension'] = $this->Extension;
        if (isset($this->Size)) $o['Size'] = $this->Size;
        if (isset($this->Content)) $o['Content'] = JsonConverters::to('ByteArray', $this->Content);
        return empty($o) ? new class(){} : $o;
    }
}

class GetDocumentFileDetails implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $DocumentID='',
        /** @var bool|null */
        public ?bool $IncludeContent=null,
        /** @var string */
        public string $DocumentFieldID=''
    ) {
    }

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

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

GET /api/documents/{DocumentID}/filedetails HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Name":"String","Extension":"String","Size":0,"Content":"AA=="}