Trendsic Platform Service

RecordSeriesListRequest

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 .xml suffix or ?format=xml

HTTP + 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>