| POST | /api/documents/search |
|---|
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 DocumentIdentifier:
id: Optional[str] = None
display_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDocumentSearch(IDocumentSearchCriteria):
search_criteria: Optional[str] = None
page_number: int = 0
page_size: int = 0
exclude_i_d: Optional[List[str]] = None
all_versions: bool = False
archived: Optional[bool] = None
DocumentIdentifier = TypeVar('DocumentIdentifier')
str = TypeVar('str')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchResult(Generic[DocumentIdentifier, str]):
results: Optional[List[DocumentIdentifier]] = None
total: int = 0
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/documents/search HTTP/1.1
Host: doapigw.baasbv.nl
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
SearchCriteria: String,
PageNumber: 0,
PageSize: 0,
ExcludeID:
[
00000000-0000-0000-0000-000000000000
],
AllVersions: False,
Archived: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Results:
[
{
DisplayName: String
}
],
Total: 0
}