| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<GetDocumentSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
<AllVersions>false</AllVersions>
<Archived>false</Archived>
<ExcludeID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</ExcludeID>
<PageNumber>0</PageNumber>
<PageSize>0</PageSize>
<SearchCriteria>String</SearchCriteria>
</GetDocumentSearch>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SearchResultOfDocumentIdentifierguidGNR3VCgI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Common">
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
<d2p1:DocumentIdentifier>
<d2p1:DisplayName>String</d2p1:DisplayName>
<d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
</d2p1:DocumentIdentifier>
</Results>
<Total>0</Total>
</SearchResultOfDocumentIdentifierguidGNR3VCgI>