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

HTTP + OTHER

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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}]}]}