DigiOffice Gateway Web Services

GetDocumentViewDetails

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

import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetDocumentViewDetails
{
    var Key:String? = null
    var IncludeExplorers:Boolean? = null
}

open class DocumentView : MobileView()
{
    @DataMember
    var TranslateKey:String? = null

    @DataMember
    var SiteMapKey:String? = null
}

@DataContract
open class MobileView
{
    @DataMember
    var ID:UUID? = null

    @DataMember
    var Title:String? = null

    @DataMember
    var ImageUrl:String? = null

    @DataMember
    var ChildrenCount:Int? = null

    @DataMember
    var Order:Int? = null

    @DataMember
    var Explorers:ArrayList<Explorer> = ArrayList<Explorer>()
}

open class Explorer
{
    var ID:UUID? = null
    var Title:String? = null
    var Order:Int? = null
}

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