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.*;

public class dtos
{

    public static class RecordSeriesListRequest
    {
        public Boolean IncludeStats = null;
        
        public Boolean isIncludeStats() { return IncludeStats; }
        public RecordSeriesListRequest setIncludeStats(Boolean value) { this.IncludeStats = value; return this; }
    }

    public static class RecordSeriesListResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<RecordSeriesDto> Series = new ArrayList<RecordSeriesDto>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public RecordSeriesListResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<RecordSeriesDto> getSeries() { return Series; }
        public RecordSeriesListResponse setSeries(ArrayList<RecordSeriesDto> value) { this.Series = value; return this; }
    }

    public static class RecordSeriesDto
    {
        public Integer SeriesId = null;
        public String SourceKey = null;
        public String Code = null;
        public String Name = null;
        public Integer Years = null;
        public Boolean Permanent = null;
        public String RetClass = null;
        public String TriggerEvent = null;
        public String Method = null;
        public Boolean ImageAndDestroy = null;
        public String Citation = null;
        public String FieldsJson = null;
        public Boolean Retired = null;
        public RecordSeriesStats Stats = null;
        public ArrayList<ScheduleLogDto> History = new ArrayList<ScheduleLogDto>();
        
        public Integer getSeriesId() { return SeriesId; }
        public RecordSeriesDto setSeriesId(Integer value) { this.SeriesId = value; return this; }
        public String getSourceKey() { return SourceKey; }
        public RecordSeriesDto setSourceKey(String value) { this.SourceKey = value; return this; }
        public String getCode() { return Code; }
        public RecordSeriesDto setCode(String value) { this.Code = value; return this; }
        public String getName() { return Name; }
        public RecordSeriesDto setName(String value) { this.Name = value; return this; }
        public Integer getYears() { return Years; }
        public RecordSeriesDto setYears(Integer value) { this.Years = value; return this; }
        public Boolean isPermanent() { return Permanent; }
        public RecordSeriesDto setPermanent(Boolean value) { this.Permanent = value; return this; }
        public String getRetClass() { return RetClass; }
        public RecordSeriesDto setRetClass(String value) { this.RetClass = value; return this; }
        public String getTriggerEvent() { return TriggerEvent; }
        public RecordSeriesDto setTriggerEvent(String value) { this.TriggerEvent = value; return this; }
        public String getMethod() { return Method; }
        public RecordSeriesDto setMethod(String value) { this.Method = value; return this; }
        public Boolean isImageAndDestroy() { return ImageAndDestroy; }
        public RecordSeriesDto setImageAndDestroy(Boolean value) { this.ImageAndDestroy = value; return this; }
        public String getCitation() { return Citation; }
        public RecordSeriesDto setCitation(String value) { this.Citation = value; return this; }
        public String getFieldsJson() { return FieldsJson; }
        public RecordSeriesDto setFieldsJson(String value) { this.FieldsJson = value; return this; }
        public Boolean isRetired() { return Retired; }
        public RecordSeriesDto setRetired(Boolean value) { this.Retired = value; return this; }
        public RecordSeriesStats getStats() { return Stats; }
        public RecordSeriesDto setStats(RecordSeriesStats value) { this.Stats = value; return this; }
        public ArrayList<ScheduleLogDto> getHistory() { return History; }
        public RecordSeriesDto setHistory(ArrayList<ScheduleLogDto> value) { this.History = value; return this; }
    }

    public static class RecordSeriesStats
    {
        public Integer Total = null;
        public Integer Running = null;
        public Integer Eligible = null;
        public Integer Held = null;
        public Integer Unstarted = null;
        
        public Integer getTotal() { return Total; }
        public RecordSeriesStats setTotal(Integer value) { this.Total = value; return this; }
        public Integer getRunning() { return Running; }
        public RecordSeriesStats setRunning(Integer value) { this.Running = value; return this; }
        public Integer getEligible() { return Eligible; }
        public RecordSeriesStats setEligible(Integer value) { this.Eligible = value; return this; }
        public Integer getHeld() { return Held; }
        public RecordSeriesStats setHeld(Integer value) { this.Held = value; return this; }
        public Integer getUnstarted() { return Unstarted; }
        public RecordSeriesStats setUnstarted(Integer value) { this.Unstarted = value; return this; }
    }

    public static class ScheduleLogDto
    {
        public Integer LogId = null;
        public Integer SeriesId = null;
        public String Verb = null;
        public String Actor = null;
        public String What = null;
        public String WhenLabel = null;
        
        public Integer getLogId() { return LogId; }
        public ScheduleLogDto setLogId(Integer value) { this.LogId = value; return this; }
        public Integer getSeriesId() { return SeriesId; }
        public ScheduleLogDto setSeriesId(Integer value) { this.SeriesId = value; return this; }
        public String getVerb() { return Verb; }
        public ScheduleLogDto setVerb(String value) { this.Verb = value; return this; }
        public String getActor() { return Actor; }
        public ScheduleLogDto setActor(String value) { this.Actor = value; return this; }
        public String getWhat() { return What; }
        public ScheduleLogDto setWhat(String value) { this.What = value; return this; }
        public String getWhenLabel() { return WhenLabel; }
        public ScheduleLogDto setWhenLabel(String value) { this.WhenLabel = value; return this; }
    }

}

Java 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>