Trendsic Platform Service

<back to all web services

FormSettingsSaveRequest

Requires Authentication
The following routes are available for this service:
PUT/v1/forms/{FormUID}/settings
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class FormSettingsSaveRequest
{
    open var FormUID:UUID? = null
    open var SettingsJson:String? = null
    open var SettingsRev:Int? = null
}

open class FormSettingsResponse
{
    open var SettingsJson:String? = null
    open var SettingsRev:Int? = null
    open var Link:String? = null
    open var LinkPaused:String? = null
    open var OfferChecks:ArrayList<FormReadinessCheck> = ArrayList<FormReadinessCheck>()
    open var DraftsInProgress:Int? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class FormReadinessCheck
{
    open var Level:String? = null
    open var Text:String? = null
    open var FixTab:String? = null
    open var FixFieldKey:String? = null
    open var FixLabel:String? = null
}

Kotlin 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>