DigiOffice Gateway Web Services

GetDocumentViewDetails

The following routes are available for this service:
GET POST	/api/documentviews/{Key}

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.API.DTO.Document.Operations
Imports IDB.API.DTO.Document
Imports IDB.API.DTO.MobileViews
Imports IDB.API.DTO.Navigation

Namespace Global

    Namespace IDB.API.DTO.Document

        Public Partial Class DocumentView
            Inherits MobileView
            <DataMember>
            Public Overridable Property TranslateKey As String

            <DataMember>
            Public Overridable Property SiteMapKey As String
        End Class
    End Namespace

    Namespace IDB.API.DTO.Document.Operations

        Public Partial Class GetDocumentViewDetails
            Public Overridable Property Key As String
            Public Overridable Property IncludeExplorers As Boolean
        End Class
    End Namespace

    Namespace IDB.API.DTO.MobileViews

        <DataContract>
        Public Partial Class MobileView
            Public Sub New()
                Explorers = New List(Of Explorer)
            End Sub

            <DataMember>
            Public Overridable Property ID As Guid

            <DataMember>
            Public Overridable Property Title As String

            <DataMember>
            Public Overridable Property ImageUrl As String

            <DataMember>
            Public Overridable Property ChildrenCount As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property Order As Integer

            <DataMember>
            Public Overridable Property Explorers As List(Of Explorer)
        End Class
    End Namespace

    Namespace IDB.API.DTO.Navigation

        Public Partial Class Explorer
            Public Overridable Property ID As Guid
            Public Overridable Property Title As String
            Public Overridable Property Order As Integer
        End Class
    End Namespace
End Namespace

VB.NET GetDocumentViewDetails 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.

POST /api/documentviews/{Key} HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetDocumentViewDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <IncludeExplorers>false</IncludeExplorers>
  <Key>String</Key>
</GetDocumentViewDetails>

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>
  <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>