Trendsic Platform Service

<back to all web services

FFFieldTypeRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET/v1/FFFieldType/{SectionTypeId}/{FFAgentConfigId}
"use strict";
export class FFFieldType {
    /** @param {{Id?:number,SectionTypeId?:number,Name?:string,width?:number,height?:number,CanDuplicate?:boolean,IsYesNo?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    SectionTypeId;
    /** @type {string} */
    Name;
    /** @type {number} */
    width;
    /** @type {number} */
    height;
    /** @type {boolean} */
    CanDuplicate;
    /** @type {boolean} */
    IsYesNo;
}
export class FFFieldTypeResponse {
    /** @param {{ResponseStatus?:ResponseStatus,FFFieldType?:FFFieldType[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {FFFieldType[]} */
    FFFieldType = [];
}
export class FFFieldTypeRequest {
    /** @param {{SectionTypeId?:number,FFAgentConfigId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    SectionTypeId;
    /** @type {string} */
    FFAgentConfigId;
}

JavaScript FFFieldTypeRequest 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/FFFieldType/{SectionTypeId}/{FFAgentConfigId} 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
		}
	},
	FFFieldType: 
	[
		{
			Id: 0,
			SectionTypeId: 0,
			Name: String,
			width: 0,
			height: 0,
			CanDuplicate: False,
			IsYesNo: False
		}
	]
}