Trendsic Platform Service

<back to all web services

RecordSeriesListRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/series
RecordSeriesListRequest Parameters:
NameParameterData TypeRequiredDescription
IncludeStatsqueryboolNo
RecordSeriesListResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
SeriesformList<RecordSeriesDto>No
RecordSeriesDto Parameters:
NameParameterData TypeRequiredDescription
SeriesIdformintNo
SourceKeyformstringNo
CodeformstringNo
NameformstringNo
YearsformintNo
PermanentformboolNo
RetClassformstringNo
TriggerEventformstringNo
MethodformstringNo
ImageAndDestroyformboolNo
CitationformstringNo
FieldsJsonformstringNo
RetiredformboolNo
StatsformRecordSeriesStatsNo
HistoryformList<ScheduleLogDto>No
RecordSeriesStats Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
RunningformintNo
EligibleformintNo
HeldformintNo
UnstartedformintNo
ScheduleLogDto Parameters:
NameParameterData TypeRequiredDescription
LogIdformintNo
SeriesIdformint?No
VerbformstringNo
ActorformstringNo
WhatformstringNo
WhenLabelformstringNo

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