DigiOffice Gateway Web Services

<back to all web services

GetDocumentViewDetails

Requires Authentication
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 .csv suffix or ?format=csv

HTTP + CSV

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

{"Key":"String","IncludeExplorers":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"TranslateKey":"String","SiteMapKey":"String","ID":"00000000-0000-0000-0000-000000000000","Title":"String","ImageUrl":"String","ChildrenCount":0,"Order":0,"Explorers":[{"ID":"00000000-0000-0000-0000-000000000000","Title":"String","Order":0}]}