DigiOffice Gateway Web Services

<back to all web services

GetDocumentViewDetails

Requires Authentication
The following routes are available for this service:
GET/api/getdocumentviewdetails
GetDocumentViewDetails Parameters:
NameParameterData TypeRequiredDescription
ViewIDqueryGuidNo
IncludeExplorersqueryboolNo
DocumentView Parameters:
NameParameterData TypeRequiredDescription
TranslateKeyformstringNo
SiteMapKeyformstringNo
MobileView Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
TitleformstringNo
ImageUrlformstringNo
ChildrenCountformint?No
OrderformintNo
ExplorersformList<Explorer>No
IsDirectSearchformboolNo
Explorer Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
TitleformstringNo
OrderformintNo

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/getdocumentviewdetails HTTP/1.1 
Host: test-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
}