Trendsic Platform Service

<back to all web services

FFFieldRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/FFField/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/FFField
"use strict";
export class FFField {
    /** @param {{Id?:string,FFSectionId?:string,FieldTypeId?:number,x?:number,y?:number,height?:number,width?:number,Text?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    FFSectionId;
    /** @type {number} */
    FieldTypeId;
    /** @type {number} */
    x;
    /** @type {number} */
    y;
    /** @type {number} */
    height;
    /** @type {number} */
    width;
    /** @type {string} */
    Text;
}
export class FFFieldExtended extends FFField {
    /** @param {{Name?:string,IsYesNo?:boolean,Id?:string,FFSectionId?:string,FieldTypeId?:number,x?:number,y?:number,height?:number,width?:number,Text?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {boolean} */
    IsYesNo;
}
export class FFFieldResponse {
    /** @param {{ResponseStatus?:ResponseStatus,FFField?:FFFieldExtended[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {FFFieldExtended[]} */
    FFField = [];
}
export class FFFieldRequest {
    /** @param {{FFField?:FFFieldExtended[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {FFFieldExtended[]} */
    FFField = [];
}

JavaScript FFFieldRequest 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/FFField/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FFField: 
	[
		{
			Name: String,
			IsYesNo: False,
			Id: 00000000000000000000000000000000,
			FFSectionId: 00000000000000000000000000000000,
			FieldTypeId: 0,
			x: 0,
			y: 0,
			height: 0,
			width: 0,
			Text: 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
		}
	},
	FFField: 
	[
		{
			Name: String,
			IsYesNo: False,
			Id: 00000000000000000000000000000000,
			FFSectionId: 00000000000000000000000000000000,
			FieldTypeId: 0,
			x: 0,
			y: 0,
			height: 0,
			width: 0,
			Text: String
		}
	]
}