| GET,OPTIONS | /v1/records/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 RecordDto:
record_id: int = 0
record_key: Optional[str] = None
name: Optional[str] = None
series_id: Optional[int] = None
series_key: Optional[str] = None
classification: Optional[str] = None
format: Optional[str] = None
phase: Optional[str] = None
trigger_date: Optional[str] = None
staged: bool = False
hold_id: Optional[int] = None
hold_key: Optional[str] = None
owner_name: Optional[str] = None
branch: Optional[str] = None
barcode: Optional[str] = None
loc_json: Optional[str] = None
meta_json: Optional[str] = None
files_json: Optional[str] = None
versions_json: Optional[str] = None
related_json: Optional[str] = None
disposed_json: Optional[str] = None
created_label: Optional[str] = None
updated_label: Optional[str] = None
lifecycle: Optional[str] = None
ret_kind: Optional[str] = None
eligible_date: Optional[str] = None
months_left: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecordsSearchResponse:
response_status: Optional[ResponseStatus] = None
records: List[RecordDto] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecordsSearchRequest:
q: Optional[str] = None
page: int = 0
page_size: int = 0
Python RecordsSearchRequest DTOs
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.
GET /v1/records/search HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<RecordsSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Records>
<RecordDto>
<Barcode>String</Barcode>
<Branch>String</Branch>
<Classification>String</Classification>
<CreatedLabel>String</CreatedLabel>
<DisposedJson>String</DisposedJson>
<EligibleDate>String</EligibleDate>
<FilesJson>String</FilesJson>
<Format>String</Format>
<HoldId>0</HoldId>
<HoldKey>String</HoldKey>
<Lifecycle>String</Lifecycle>
<LocJson>String</LocJson>
<MetaJson>String</MetaJson>
<MonthsLeft>0</MonthsLeft>
<Name>String</Name>
<OwnerName>String</OwnerName>
<Phase>String</Phase>
<RecordId>0</RecordId>
<RecordKey>String</RecordKey>
<RelatedJson>String</RelatedJson>
<RetKind>String</RetKind>
<SeriesId>0</SeriesId>
<SeriesKey>String</SeriesKey>
<Staged>false</Staged>
<TriggerDate>String</TriggerDate>
<UpdatedLabel>String</UpdatedLabel>
<VersionsJson>String</VersionsJson>
</RecordDto>
</Records>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</RecordsSearchResponse>