Trendsic Platform Service

<back to all web services

FormSettingsSaveRequest

Requires Authentication
The following routes are available for this service:
PUT/v1/forms/{FormUID}/settings
"use strict";
export class FormReadinessCheck {
    /** @param {{Level?:string,Text?:string,FixTab?:string,FixFieldKey?:string,FixLabel?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Level;
    /** @type {string} */
    Text;
    /** @type {string} */
    FixTab;
    /** @type {string} */
    FixFieldKey;
    /** @type {string} */
    FixLabel;
}
export class FormSettingsResponse {
    /** @param {{SettingsJson?:string,SettingsRev?:number,Link?:string,LinkPaused?:string,OfferChecks?:FormReadinessCheck[],DraftsInProgress?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SettingsJson;
    /** @type {number} */
    SettingsRev;
    /** @type {string} */
    Link;
    /** @type {string} */
    LinkPaused;
    /** @type {FormReadinessCheck[]} */
    OfferChecks = [];
    /** @type {number} */
    DraftsInProgress;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class FormSettingsSaveRequest {
    /** @param {{FormUID?:string,SettingsJson?:string,SettingsRev?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FormUID;
    /** @type {string} */
    SettingsJson;
    /** @type {number} */
    SettingsRev;
}

JavaScript FormSettingsSaveRequest 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.

PUT /v1/forms/{FormUID}/settings HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormSettingsSaveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
  <SettingsJson>String</SettingsJson>
  <SettingsRev>0</SettingsRev>
</FormSettingsSaveRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DraftsInProgress>0</DraftsInProgress>
  <Link>String</Link>
  <LinkPaused>String</LinkPaused>
  <OfferChecks>
    <FormReadinessCheck>
      <FixFieldKey>String</FixFieldKey>
      <FixLabel>String</FixLabel>
      <FixTab>String</FixTab>
      <Level>String</Level>
      <Text>String</Text>
    </FormReadinessCheck>
  </OfferChecks>
  <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>
  <SettingsJson>String</SettingsJson>
  <SettingsRev>0</SettingsRev>
</FormSettingsResponse>