Trendsic Platform Service

<back to all web services

RecordSeriesListRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/series
import Foundation
import ServiceStack

public class RecordSeriesListRequest : Codable
{
    public var includeStats:Bool

    required public init(){}
}

public class RecordSeriesListResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var series:[RecordSeriesDto] = []

    required public init(){}
}

public class RecordSeriesDto : Codable
{
    public var seriesId:Int
    public var sourceKey:String
    public var code:String
    public var name:String
    public var years:Int
    public var permanent:Bool
    public var retClass:String
    public var triggerEvent:String
    public var method:String
    public var imageAndDestroy:Bool
    public var citation:String
    public var fieldsJson:String
    public var retired:Bool
    public var stats:RecordSeriesStats
    public var history:[ScheduleLogDto] = []

    required public init(){}
}

public class RecordSeriesStats : Codable
{
    public var total:Int
    public var running:Int
    public var eligible:Int
    public var held:Int
    public var unstarted:Int

    required public init(){}
}

public class ScheduleLogDto : Codable
{
    public var logId:Int
    public var seriesId:Int?
    public var verb:String
    public var actor:String
    public var what:String
    public var whenLabel:String

    required public init(){}
}


Swift RecordSeriesListRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}]}]}