Trendsic Platform Service

<back to all web services

FormSettingsRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/settings
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class FormReadinessCheck implements IConvertible
{
    String? Level;
    String? Text;
    String? FixTab;
    String? FixFieldKey;
    String? FixLabel;

    FormReadinessCheck({this.Level,this.Text,this.FixTab,this.FixFieldKey,this.FixLabel});
    FormReadinessCheck.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Level = json['Level'];
        Text = json['Text'];
        FixTab = json['FixTab'];
        FixFieldKey = json['FixFieldKey'];
        FixLabel = json['FixLabel'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Level': Level,
        'Text': Text,
        'FixTab': FixTab,
        'FixFieldKey': FixFieldKey,
        'FixLabel': FixLabel
    };

    getTypeName() => "FormReadinessCheck";
    TypeContext? context = _ctx;
}

class FormSettingsResponse implements IConvertible
{
    String? SettingsJson;
    int? SettingsRev;
    String? Link;
    String? LinkPaused;
    List<FormReadinessCheck>? OfferChecks = [];
    int? DraftsInProgress;
    ResponseStatus? ResponseStatus;

    FormSettingsResponse({this.SettingsJson,this.SettingsRev,this.Link,this.LinkPaused,this.OfferChecks,this.DraftsInProgress,this.ResponseStatus});
    FormSettingsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SettingsJson = json['SettingsJson'];
        SettingsRev = json['SettingsRev'];
        Link = json['Link'];
        LinkPaused = json['LinkPaused'];
        OfferChecks = JsonConverters.fromJson(json['OfferChecks'],'List<FormReadinessCheck>',context!);
        DraftsInProgress = json['DraftsInProgress'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SettingsJson': SettingsJson,
        'SettingsRev': SettingsRev,
        'Link': Link,
        'LinkPaused': LinkPaused,
        'OfferChecks': JsonConverters.toJson(OfferChecks,'List<FormReadinessCheck>',context!),
        'DraftsInProgress': DraftsInProgress,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "FormSettingsResponse";
    TypeContext? context = _ctx;
}

class FormSettingsRequest implements IConvertible
{
    String? FormUID;

    FormSettingsRequest({this.FormUID});
    FormSettingsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        FormUID = json['FormUID'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'FormUID': FormUID
    };

    getTypeName() => "FormSettingsRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'FormReadinessCheck': TypeInfo(TypeOf.Class, create:() => FormReadinessCheck()),
    'FormSettingsResponse': TypeInfo(TypeOf.Class, create:() => FormSettingsResponse()),
    'List<FormReadinessCheck>': TypeInfo(TypeOf.Class, create:() => <FormReadinessCheck>[]),
    'FormSettingsRequest': TypeInfo(TypeOf.Class, create:() => FormSettingsRequest()),
});

Dart FormSettingsRequest 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.

GET /v1/forms/{FormUID}/settings HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
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>