Trendsic Platform Service

RecordSeriesListRequest

The following routes are available for this service:
GET,OPTIONS	/v1/records/series

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class RecordSeriesDto
    {
        public virtual int SeriesId { get; set; }
        public virtual string SourceKey { get; set; }
        public virtual string Code { get; set; }
        public virtual string Name { get; set; }
        public virtual int Years { get; set; }
        public virtual bool Permanent { get; set; }
        public virtual string RetClass { get; set; }
        public virtual string TriggerEvent { get; set; }
        public virtual string Method { get; set; }
        public virtual bool ImageAndDestroy { get; set; }
        public virtual string Citation { get; set; }
        public virtual string FieldsJson { get; set; }
        public virtual bool Retired { get; set; }
        public virtual RecordSeriesStats Stats { get; set; }
        public virtual List<ScheduleLogDto> History { get; set; } = [];
    }

    public partial class RecordSeriesListRequest
    {
        public virtual bool IncludeStats { get; set; }
    }

    public partial class RecordSeriesListResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<RecordSeriesDto> Series { get; set; } = [];
    }

    public partial class RecordSeriesStats
    {
        public virtual int Total { get; set; }
        public virtual int Running { get; set; }
        public virtual int Eligible { get; set; }
        public virtual int Held { get; set; }
        public virtual int Unstarted { get; set; }
    }

    public partial class ScheduleLogDto
    {
        public virtual int LogId { get; set; }
        public virtual int? SeriesId { get; set; }
        public virtual string Verb { get; set; }
        public virtual string Actor { get; set; }
        public virtual string What { get; set; }
        public virtual string WhenLabel { get; set; }
    }

}

C# 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>