Trendsic Platform Service

<back to all web services

RecordSeriesListRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/series
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type RecordSeriesStats() = 
        member val Total:Int32 = new Int32() with get,set
        member val Running:Int32 = new Int32() with get,set
        member val Eligible:Int32 = new Int32() with get,set
        member val Held:Int32 = new Int32() with get,set
        member val Unstarted:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type ScheduleLogDto() = 
        member val LogId:Int32 = new Int32() with get,set
        member val SeriesId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Verb:String = null with get,set
        member val Actor:String = null with get,set
        member val What:String = null with get,set
        member val WhenLabel:String = null with get,set

    [<AllowNullLiteral>]
    type RecordSeriesDto() = 
        member val SeriesId:Int32 = new Int32() with get,set
        member val SourceKey:String = null with get,set
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val Years:Int32 = new Int32() with get,set
        member val Permanent:Boolean = new Boolean() with get,set
        member val RetClass:String = null with get,set
        member val TriggerEvent:String = null with get,set
        member val Method:String = null with get,set
        member val ImageAndDestroy:Boolean = new Boolean() with get,set
        member val Citation:String = null with get,set
        member val FieldsJson:String = null with get,set
        member val Retired:Boolean = new Boolean() with get,set
        member val Stats:RecordSeriesStats = null with get,set
        member val History:ResizeArray<ScheduleLogDto> = new ResizeArray<ScheduleLogDto>() with get,set

    [<AllowNullLiteral>]
    type RecordSeriesListResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Series:ResizeArray<RecordSeriesDto> = new ResizeArray<RecordSeriesDto>() with get,set

    [<AllowNullLiteral>]
    type RecordSeriesListRequest() = 
        member val IncludeStats:Boolean = new Boolean() with get,set

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