| 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: Optional[int] = None
@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: Optional[int] = None
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: Optional[bool] = None
Python GetDocumentViewDetails DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"Key":"String","IncludeExplorers":false}
HTTP/1.1 200 OK
Content-Type: application/json
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}]}