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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class RecordSeriesListRequest
{
    open var IncludeStats:Boolean? = null
}

open class RecordSeriesListResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Series:ArrayList<RecordSeriesDto> = ArrayList<RecordSeriesDto>()
}

open class RecordSeriesDto
{
    open var SeriesId:Int? = null
    open var SourceKey:String? = null
    open var Code:String? = null
    open var Name:String? = null
    open var Years:Int? = null
    open var Permanent:Boolean? = null
    open var RetClass:String? = null
    open var TriggerEvent:String? = null
    open var Method:String? = null
    open var ImageAndDestroy:Boolean? = null
    open var Citation:String? = null
    open var FieldsJson:String? = null
    open var Retired:Boolean? = null
    open var Stats:RecordSeriesStats? = null
    open var History:ArrayList<ScheduleLogDto> = ArrayList<ScheduleLogDto>()
}

open class RecordSeriesStats
{
    open var Total:Int? = null
    open var Running:Int? = null
    open var Eligible:Int? = null
    open var Held:Int? = null
    open var Unstarted:Int? = null
}

open class ScheduleLogDto
{
    open var LogId:Int? = null
    open var SeriesId:Int? = null
    open var Verb:String? = null
    open var Actor:String? = null
    open var What:String? = null
    open var WhenLabel:String? = null
}

Kotlin 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"}]}]}