| GET,OPTIONS | /v1/records/series |
|---|
import 'package:servicestack/servicestack.dart';
class RecordSeriesStats implements IConvertible
{
int? Total;
int? Running;
int? Eligible;
int? Held;
int? Unstarted;
RecordSeriesStats({this.Total,this.Running,this.Eligible,this.Held,this.Unstarted});
RecordSeriesStats.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Total = json['Total'];
Running = json['Running'];
Eligible = json['Eligible'];
Held = json['Held'];
Unstarted = json['Unstarted'];
return this;
}
Map<String, dynamic> toJson() => {
'Total': Total,
'Running': Running,
'Eligible': Eligible,
'Held': Held,
'Unstarted': Unstarted
};
getTypeName() => "RecordSeriesStats";
TypeContext? context = _ctx;
}
class ScheduleLogDto implements IConvertible
{
int? LogId;
int? SeriesId;
String? Verb;
String? Actor;
String? What;
String? WhenLabel;
ScheduleLogDto({this.LogId,this.SeriesId,this.Verb,this.Actor,this.What,this.WhenLabel});
ScheduleLogDto.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
LogId = json['LogId'];
SeriesId = json['SeriesId'];
Verb = json['Verb'];
Actor = json['Actor'];
What = json['What'];
WhenLabel = json['WhenLabel'];
return this;
}
Map<String, dynamic> toJson() => {
'LogId': LogId,
'SeriesId': SeriesId,
'Verb': Verb,
'Actor': Actor,
'What': What,
'WhenLabel': WhenLabel
};
getTypeName() => "ScheduleLogDto";
TypeContext? context = _ctx;
}
class RecordSeriesDto implements IConvertible
{
int? SeriesId;
String? SourceKey;
String? Code;
String? Name;
int? Years;
bool? Permanent;
String? RetClass;
String? TriggerEvent;
String? Method;
bool? ImageAndDestroy;
String? Citation;
String? FieldsJson;
bool? Retired;
RecordSeriesStats? Stats;
List<ScheduleLogDto>? History = [];
RecordSeriesDto({this.SeriesId,this.SourceKey,this.Code,this.Name,this.Years,this.Permanent,this.RetClass,this.TriggerEvent,this.Method,this.ImageAndDestroy,this.Citation,this.FieldsJson,this.Retired,this.Stats,this.History});
RecordSeriesDto.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
SeriesId = json['SeriesId'];
SourceKey = json['SourceKey'];
Code = json['Code'];
Name = json['Name'];
Years = json['Years'];
Permanent = json['Permanent'];
RetClass = json['RetClass'];
TriggerEvent = json['TriggerEvent'];
Method = json['Method'];
ImageAndDestroy = json['ImageAndDestroy'];
Citation = json['Citation'];
FieldsJson = json['FieldsJson'];
Retired = json['Retired'];
Stats = JsonConverters.fromJson(json['Stats'],'RecordSeriesStats',context!);
History = JsonConverters.fromJson(json['History'],'List<ScheduleLogDto>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'SeriesId': SeriesId,
'SourceKey': SourceKey,
'Code': Code,
'Name': Name,
'Years': Years,
'Permanent': Permanent,
'RetClass': RetClass,
'TriggerEvent': TriggerEvent,
'Method': Method,
'ImageAndDestroy': ImageAndDestroy,
'Citation': Citation,
'FieldsJson': FieldsJson,
'Retired': Retired,
'Stats': JsonConverters.toJson(Stats,'RecordSeriesStats',context!),
'History': JsonConverters.toJson(History,'List<ScheduleLogDto>',context!)
};
getTypeName() => "RecordSeriesDto";
TypeContext? context = _ctx;
}
class RecordSeriesListResponse implements IConvertible
{
ResponseStatus? ResponseStatus;
List<RecordSeriesDto>? Series = [];
RecordSeriesListResponse({this.ResponseStatus,this.Series});
RecordSeriesListResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
Series = JsonConverters.fromJson(json['Series'],'List<RecordSeriesDto>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
'Series': JsonConverters.toJson(Series,'List<RecordSeriesDto>',context!)
};
getTypeName() => "RecordSeriesListResponse";
TypeContext? context = _ctx;
}
class RecordSeriesListRequest implements IConvertible
{
bool? IncludeStats;
RecordSeriesListRequest({this.IncludeStats});
RecordSeriesListRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
IncludeStats = json['IncludeStats'];
return this;
}
Map<String, dynamic> toJson() => {
'IncludeStats': IncludeStats
};
getTypeName() => "RecordSeriesListRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
'RecordSeriesStats': TypeInfo(TypeOf.Class, create:() => RecordSeriesStats()),
'ScheduleLogDto': TypeInfo(TypeOf.Class, create:() => ScheduleLogDto()),
'RecordSeriesDto': TypeInfo(TypeOf.Class, create:() => RecordSeriesDto()),
'List<ScheduleLogDto>': TypeInfo(TypeOf.Class, create:() => <ScheduleLogDto>[]),
'RecordSeriesListResponse': TypeInfo(TypeOf.Class, create:() => RecordSeriesListResponse()),
'List<RecordSeriesDto>': TypeInfo(TypeOf.Class, create:() => <RecordSeriesDto>[]),
'RecordSeriesListRequest': TypeInfo(TypeOf.Class, create:() => RecordSeriesListRequest()),
});
Dart 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>