DigiOffice API Services Services

GetDocumentUploads

The following routes are available for this service:
GET	/api/documentuploads

<?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 GetDocumentUploads implements IPageOptions, ISearchCriteria, JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ViewID=null,
        /** @var int */
        public int $PageSize=0,
        /** @var int */
        public int $PageNumber=0,
        /** @var string|null */
        public ?string $SearchCriteria=null,
        /** @var string|null */
        public ?string $ExplorerID=null,
        /** @var string|null */
        public ?string $Path=null
    ) {
    }

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

PHP GetDocumentUploads DTOs

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

HTTP + XML

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

GET /api/documentuploads HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml

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

<ArrayOfDocumentUpload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <DocumentUpload>
    <AssignedTo>String</AssignedTo>
    <AssignedToGroup>String</AssignedToGroup>
    <Description>String</Description>
    <Extension>String</Extension>
    <FileDate>0001-01-01T00:00:00</FileDate>
    <FileName>String</FileName>
    <HasPreview>false</HasPreview>
    <ID>0</ID>
    <Notes>String</Notes>
    <UploadedBy>String</UploadedBy>
  </DocumentUpload>
</ArrayOfDocumentUpload>