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