Trendsic Platform Service

RecordSeriesListRequest

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

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

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class RecordSeriesDto
            Public Overridable Property SeriesId As Integer
            Public Overridable Property SourceKey As String
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property Years As Integer
            Public Overridable Property Permanent As Boolean
            Public Overridable Property RetClass As String
            Public Overridable Property TriggerEvent As String
            Public Overridable Property Method As String
            Public Overridable Property ImageAndDestroy As Boolean
            Public Overridable Property Citation As String
            Public Overridable Property FieldsJson As String
            Public Overridable Property Retired As Boolean
            Public Overridable Property Stats As RecordSeriesStats
            Public Overridable Property History As List(Of ScheduleLogDto) = New List(Of ScheduleLogDto)
        End Class

        Public Partial Class RecordSeriesListRequest
            Public Overridable Property IncludeStats As Boolean
        End Class

        Public Partial Class RecordSeriesListResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Series As List(Of RecordSeriesDto) = New List(Of RecordSeriesDto)
        End Class

        Public Partial Class RecordSeriesStats
            Public Overridable Property Total As Integer
            Public Overridable Property Running As Integer
            Public Overridable Property Eligible As Integer
            Public Overridable Property Held As Integer
            Public Overridable Property Unstarted As Integer
        End Class

        Public Partial Class ScheduleLogDto
            Public Overridable Property LogId As Integer
            Public Overridable Property SeriesId As Integer?
            Public Overridable Property Verb As String
            Public Overridable Property Actor As String
            Public Overridable Property What As String
            Public Overridable Property WhenLabel As String
        End Class
    End Namespace
End Namespace

VB.NET RecordSeriesListRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv

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