DigiOffice Gateway Web Services

GetDocumentViewDetails

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

namespace IDB.API.DTO.Document

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Explorer() = 
        member val ID:Guid = new Guid() with get,set
        member val Title:String = null with get,set
        member val Order:Int32 = new Int32() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type MobileView() = 
        [<DataMember>]
        member val ID:Guid = new Guid() with get,set

        [<DataMember>]
        member val Title:String = null with get,set

        [<DataMember>]
        member val ImageUrl:String = null with get,set

        [<DataMember>]
        member val ChildrenCount:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val Order:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Explorers:ResizeArray<Explorer> = new ResizeArray<Explorer>() with get,set

    [<AllowNullLiteral>]
    type DocumentView() = 
        inherit MobileView()
        [<DataMember>]
        member val TranslateKey:String = null with get,set

        [<DataMember>]
        member val SiteMapKey:String = null with get,set

    [<AllowNullLiteral>]
    type GetDocumentViewDetails() = 
        member val Key:String = null with get,set
        member val IncludeExplorers:Boolean = new Boolean() with get,set

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