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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Key: String,
	IncludeExplorers: False
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TranslateKey: String,
	SiteMapKey: String,
	Title: String,
	ImageUrl: String,
	ChildrenCount: 0,
	Order: 0,
	Explorers: 
	[
		{
			Title: String,
			Order: 0
		}
	]
}