DigiOffice Gateway Web Services

<back to all web services

GetDocumentViewDetails

Requires Authentication
The following routes are available for this service:
GET POST/api/documentviews/{Key}
GetDocumentViewDetails Parameters:
NameParameterData TypeRequiredDescription
KeypathstringNo
IncludeExplorersbodyboolNo
DocumentView Parameters:
NameParameterData TypeRequiredDescription
TranslateKeyformstringNo
SiteMapKeyformstringNo
MobileView Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
TitleformstringNo
ImageUrlformstringNo
ChildrenCountformint?No
OrderformintNo
ExplorersformList<Explorer>No
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.

POST /api/documentviews/{Key} HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	__type: "IDB.API.DTO.Document.Operations.GetDocumentViewDetails, IDB.API.DTO",
	Key: String,
	IncludeExplorers: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	__type: "IDB.API.DTO.Document.DocumentView, IDB.API.DTO",
	TranslateKey: String,
	SiteMapKey: String,
	Title: String,
	ImageUrl: String,
	ChildrenCount: 0,
	Order: 0,
	Explorers: 
	[
		{
			__type: "IDB.API.DTO.Navigation.Explorer, IDB.API.DTO",
			Title: String,
			Order: 0
		}
	]
}