DigiOffice Gateway Web Services

<back to all web services

GetDocumentViews

Requires Authentication
The following routes are available for this service:
GET/api/documentviews
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.API.DTO.Document.Operations

Namespace Global

    Namespace IDB.API.DTO.Document.Operations

        Public Partial Class GetDocumentViews
            Public Overridable Property IncludeExplorers As Boolean
            Public Overridable Property WorkspaceID As Nullable(Of Guid)
        End Class
    End Namespace
End Namespace

VB.NET GetDocumentViews DTOs

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/documentviews HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfDocumentView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <DocumentView>
    <ChildrenCount xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">0</ChildrenCount>
    <Explorers xmlns:d3p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Navigation" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">
      <d3p1:Explorer>
        <d3p1:ID>00000000-0000-0000-0000-000000000000</d3p1:ID>
        <d3p1:Order>0</d3p1:Order>
        <d3p1:Title>String</d3p1:Title>
      </d3p1: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>
    <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>
</ArrayOfDocumentView>