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

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <ChildrenCount xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">0</ChildrenCount>
  <Explorers xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Navigation" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">
    <d2p1:Explorer>
      <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
      <d2p1:Order>0</d2p1:Order>
      <d2p1:Title>String</d2p1:Title>
    </d2p1:Explorer>
  </Explorers>
  <ID xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">00000000-0000-0000-0000-000000000000</ID>
  <ImageUrl xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">String</ImageUrl>
  <IsDirectSearch xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">false</IsDirectSearch>
  <Order xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">0</Order>
  <Title xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">String</Title>
  <SiteMapKey>String</SiteMapKey>
  <TranslateKey>String</TranslateKey>
</DocumentView>