| GET,OPTIONS | /v1/records/series |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;
namespace CRM.AgencyPlatform.API.Internal
{
public partial class RecordSeriesDto
{
public virtual int SeriesId { get; set; }
public virtual string SourceKey { get; set; }
public virtual string Code { get; set; }
public virtual string Name { get; set; }
public virtual int Years { get; set; }
public virtual bool Permanent { get; set; }
public virtual string RetClass { get; set; }
public virtual string TriggerEvent { get; set; }
public virtual string Method { get; set; }
public virtual bool ImageAndDestroy { get; set; }
public virtual string Citation { get; set; }
public virtual string FieldsJson { get; set; }
public virtual bool Retired { get; set; }
public virtual RecordSeriesStats Stats { get; set; }
public virtual List<ScheduleLogDto> History { get; set; } = [];
}
public partial class RecordSeriesListRequest
{
public virtual bool IncludeStats { get; set; }
}
public partial class RecordSeriesListResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual List<RecordSeriesDto> Series { get; set; } = [];
}
public partial class RecordSeriesStats
{
public virtual int Total { get; set; }
public virtual int Running { get; set; }
public virtual int Eligible { get; set; }
public virtual int Held { get; set; }
public virtual int Unstarted { get; set; }
}
public partial class ScheduleLogDto
{
public virtual int LogId { get; set; }
public virtual int? SeriesId { get; set; }
public virtual string Verb { get; set; }
public virtual string Actor { get; set; }
public virtual string What { get; set; }
public virtual string WhenLabel { get; set; }
}
}
C# RecordSeriesListRequest DTOs
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.
GET /v1/records/series HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Series:
[
{
SeriesId: 0,
SourceKey: String,
Code: String,
Name: String,
Years: 0,
Permanent: False,
RetClass: String,
TriggerEvent: String,
Method: String,
ImageAndDestroy: False,
Citation: String,
FieldsJson: String,
Retired: False,
Stats:
{
Total: 0,
Running: 0,
Eligible: 0,
Held: 0,
Unstarted: 0
},
History:
[
{
LogId: 0,
SeriesId: 0,
Verb: String,
Actor: String,
What: String,
WhenLabel: String
}
]
}
]
}