| GET,OPTIONS | /v1/records/series |
|---|
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 RecordSeriesStats:
total: int = 0
running: int = 0
eligible: int = 0
held: int = 0
unstarted: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScheduleLogDto:
log_id: int = 0
series_id: Optional[int] = None
verb: Optional[str] = None
actor: Optional[str] = None
what: Optional[str] = None
when_label: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecordSeriesDto:
series_id: int = 0
source_key: Optional[str] = None
code: Optional[str] = None
name: Optional[str] = None
years: int = 0
permanent: bool = False
ret_class: Optional[str] = None
trigger_event: Optional[str] = None
method: Optional[str] = None
image_and_destroy: bool = False
citation: Optional[str] = None
fields_json: Optional[str] = None
retired: bool = False
stats: Optional[RecordSeriesStats] = None
history: List[ScheduleLogDto] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecordSeriesListResponse:
response_status: Optional[ResponseStatus] = None
series: List[RecordSeriesDto] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecordSeriesListRequest:
include_stats: bool = False
Python RecordSeriesListRequest 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/series HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<RecordSeriesListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<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>
<Series>
<RecordSeriesDto>
<Citation>String</Citation>
<Code>String</Code>
<FieldsJson>String</FieldsJson>
<History>
<ScheduleLogDto>
<Actor>String</Actor>
<LogId>0</LogId>
<SeriesId>0</SeriesId>
<Verb>String</Verb>
<What>String</What>
<WhenLabel>String</WhenLabel>
</ScheduleLogDto>
</History>
<ImageAndDestroy>false</ImageAndDestroy>
<Method>String</Method>
<Name>String</Name>
<Permanent>false</Permanent>
<RetClass>String</RetClass>
<Retired>false</Retired>
<SeriesId>0</SeriesId>
<SourceKey>String</SourceKey>
<Stats>
<Eligible>0</Eligible>
<Held>0</Held>
<Running>0</Running>
<Total>0</Total>
<Unstarted>0</Unstarted>
</Stats>
<TriggerEvent>String</TriggerEvent>
<Years>0</Years>
</RecordSeriesDto>
</Series>
</RecordSeriesListResponse>