| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,DELETE,OPTIONS | /v1/FFSection/{Id} | ||
|---|---|---|---|
| POST,PUT,OPTIONS | /v1/FFSection |
export class FFSection
{
public Id: string;
public FFAgentConfigId: string;
public SectionTypeId: number;
public Nickname: string;
public ShowHeader: boolean;
public Header: string;
public height: number;
public width: number;
public x: number;
public y: number;
public IsActive: boolean;
public HasBorder: boolean;
public BorderColor: string;
public BorderWidth: number;
public BorderRadius: number;
public DateCreated: string;
public DateModified: string;
public constructor(init?: Partial<FFSection>) { (Object as any).assign(this, init); }
}
export class FFField
{
public Id: string;
public FFSectionId: string;
public FieldTypeId: number;
public x: number;
public y: number;
public height: number;
public width: number;
public Text: string;
public constructor(init?: Partial<FFField>) { (Object as any).assign(this, init); }
}
export class FFFieldExtended extends FFField
{
public Name: string;
public IsYesNo: boolean;
public constructor(init?: Partial<FFFieldExtended>) { super(init); (Object as any).assign(this, init); }
}
export class FFSectionExtended extends FFSection
{
public SectionTypeDesc: string;
public FFFields: FFFieldExtended[] = [];
public constructor(init?: Partial<FFSectionExtended>) { super(init); (Object as any).assign(this, init); }
}
export class FFSectionResponse
{
public ResponseStatus: ResponseStatus;
public FFSection: FFSectionExtended;
public constructor(init?: Partial<FFSectionResponse>) { (Object as any).assign(this, init); }
}
export class FFSectionRequest
{
public Id: string;
public FFSection: FFSectionExtended;
public constructor(init?: Partial<FFSectionRequest>) { (Object as any).assign(this, init); }
}
TypeScript FFSectionRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/FFSection HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Id: 00000000000000000000000000000000,
FFSection:
{
SectionTypeDesc: String,
FFFields:
[
{
Name: String,
IsYesNo: False,
Id: 00000000000000000000000000000000,
FFSectionId: 00000000000000000000000000000000,
FieldTypeId: 0,
x: 0,
y: 0,
height: 0,
width: 0,
Text: String
}
],
Id: 00000000000000000000000000000000,
FFAgentConfigId: 00000000000000000000000000000000,
SectionTypeId: 0,
Nickname: String,
ShowHeader: False,
Header: String,
height: 0,
width: 0,
x: 0,
y: 0,
IsActive: False,
HasBorder: False,
BorderColor: String,
BorderWidth: 0,
BorderRadius: 0,
DateCreated: 0001-01-01,
DateModified: 0001-01-01
}
}
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
}
},
FFSection:
{
SectionTypeDesc: String,
FFFields:
[
{
Name: String,
IsYesNo: False,
Id: 00000000000000000000000000000000,
FFSectionId: 00000000000000000000000000000000,
FieldTypeId: 0,
x: 0,
y: 0,
height: 0,
width: 0,
Text: String
}
],
Id: 00000000000000000000000000000000,
FFAgentConfigId: 00000000000000000000000000000000,
SectionTypeId: 0,
Nickname: String,
ShowHeader: False,
Header: String,
height: 0,
width: 0,
x: 0,
y: 0,
IsActive: False,
HasBorder: False,
BorderColor: String,
BorderWidth: 0,
BorderRadius: 0,
DateCreated: 0001-01-01,
DateModified: 0001-01-01
}
}