DigiOffice Gateway Web Services

<back to all web services

GetDocumentViews

Requires Authentication
The following routes are available for this service:
GET/api/documentviews
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDocumentViews:
    include_explorers: Optional[bool] = None
    workspace_i_d: Optional[str] = None

Python 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: digiofficeapigateway.deltares.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
			}
		]
	}
]