DigiOffice Gateway Web Services

<back to all web services

GetMyRecentlyOpenedDocuments

Requires Authentication
The following routes are available for this service:
GET/api/me/documents/recent
<?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 GetMyRecentlyOpenedDocuments implements IPageOptions, JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $OnlyStoredInSharePointOnline=null,
        /** @var string|null */
        public ?string $ProgCode=null,
        /** @var int */
        public int $PageSize=0,
        /** @var int */
        public int $PageNumber=0
    ) {
    }

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

PHP GetMyRecentlyOpenedDocuments 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/me/documents/recent HTTP/1.1 
Host: dogw.klokgroep.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfRecentlyOpenedDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <RecentlyOpenedDocument>
    <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
    <DocumentNumber>String</DocumentNumber>
    <DocumentTitle>String</DocumentTitle>
    <DocumentVersion>String</DocumentVersion>
    <FileExtension>String</FileExtension>
    <FileUrl>String</FileUrl>
    <LastOpenedDate>0001-01-01T00:00:00</LastOpenedDate>
    <ProgCode>String</ProgCode>
  </RecentlyOpenedDocument>
</ArrayOfRecentlyOpenedDocument>