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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Key":"String","IncludeExplorers":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"TranslateKey":"String","SiteMapKey":"String","ID":"00000000-0000-0000-0000-000000000000","Title":"String","ImageUrl":"String","ChildrenCount":0,"Order":0,"Explorers":[{"ID":"00000000-0000-0000-0000-000000000000","Title":"String","Order":0}]}