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

export class RecordsOkResponse
{
    public ResponseStatus: ResponseStatus;
    public Ok: boolean;
    public Id: number;
    public Key: string;
    public Matches: string[] = [];

    public constructor(init?: Partial<RecordsOkResponse>) { (Object as any).assign(this, init); }
}

export class RecordSeriesSaveRequest
{
    public SeriesId: number;
    public Code: string;
    public Name: string;
    public Years: number;
    public Permanent: boolean;
    public RetClass: string;
    public TriggerEvent: string;
    public Method: string;
    public ImageAndDestroy: boolean;
    public Citation: string;
    public FieldsJson: string;

    public constructor(init?: Partial<RecordSeriesSaveRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
	]
}