Trendsic Platform Service

<back to all web services

RecordSeriesSaveRequest

Requires Authentication
The following routes are available for this service:
PATCH,PUT,OPTIONS/v1/records/series/{SeriesId}
POST,OPTIONS/v1/records/series
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecordsOkResponse:
    response_status: Optional[ResponseStatus] = None
    ok: bool = False
    id: int = 0
    key: Optional[str] = None
    matches: List[str] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecordSeriesSaveRequest:
    series_id: int = 0
    code: Optional[str] = None
    name: Optional[str] = None
    years: int = 0
    permanent: bool = False
    ret_class: Optional[str] = None
    trigger_event: Optional[str] = None
    method: Optional[str] = None
    image_and_destroy: bool = False
    citation: Optional[str] = None
    fields_json: Optional[str] = None

Python RecordSeriesSaveRequest 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.

POST /v1/records/series HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	SeriesId: 0,
	Code: String,
	Name: String,
	Years: 0,
	Permanent: False,
	RetClass: String,
	TriggerEvent: String,
	Method: String,
	ImageAndDestroy: False,
	Citation: String,
	FieldsJson: String
}
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
		}
	},
	Ok: False,
	Id: 0,
	Key: String,
	Matches: 
	[
		String
	]
}