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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<FFFieldRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FFField>
    <FFFieldExtended>
      <FFSectionId>00000000-0000-0000-0000-000000000000</FFSectionId>
      <FieldTypeId>0</FieldTypeId>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <Text>String</Text>
      <height>0</height>
      <width>0</width>
      <x>0</x>
      <y>0</y>
      <IsYesNo>false</IsYesNo>
      <Name>String</Name>
    </FFFieldExtended>
  </FFField>
</FFFieldRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FFFieldResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FFField>
    <FFFieldExtended>
      <FFSectionId>00000000-0000-0000-0000-000000000000</FFSectionId>
      <FieldTypeId>0</FieldTypeId>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <Text>String</Text>
      <height>0</height>
      <width>0</width>
      <x>0</x>
      <y>0</y>
      <IsYesNo>false</IsYesNo>
      <Name>String</Name>
    </FFFieldExtended>
  </FFField>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</FFFieldResponse>