| GET POST | /api/documentviews/{Key} |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Explorer:
id: Optional[str] = None
title: Optional[str] = None
order: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MobileView:
id: Optional[str] = None
title: Optional[str] = None
image_url: Optional[str] = None
children_count: Optional[int] = None
order: int = 0
explorers: Optional[List[Explorer]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentView(MobileView):
translate_key: Optional[str] = None
site_map_key: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDocumentViewDetails:
key: Optional[str] = None
include_explorers: bool = False
Python 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: doapigw.baasbv.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
}
]
}