DigiOffice Gateway Web Services

<back to all web services

GetDocumentViews

Requires Authentication
The following routes are available for this service:
GET/api/documentviews
<?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 GetDocumentViews implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $IncludeExplorers=null,
        /** @var string|null */
        public ?string $WorkspaceID=null
    ) {
    }

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

PHP GetDocumentViews DTOs

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

HTTP + JSV

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

GET /api/documentviews HTTP/1.1 
Host: dogw.klokgroep.nl 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		TranslateKey: String,
		SiteMapKey: String,
		Title: String,
		ImageUrl: String,
		ChildrenCount: 0,
		Order: 0,
		Explorers: 
		[
			{
				Title: String,
				Order: 0
			}
		],
		IsDirectSearch: False
	}
]