Trendsic Platform Service

<back to all web services

FormReadinessRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/readiness
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 FormReadinessResponse implements IConvertible
{
    List<FormReadinessCheck>? Checks = [];
    List<String>? Changes = [];
    int? NextVersion;
    bool? IsFirstPublish;
    bool? NothingChanged;
    bool? CanPublish;
    int? DraftRev;
    ResponseStatus? ResponseStatus;

    FormReadinessResponse({this.Checks,this.Changes,this.NextVersion,this.IsFirstPublish,this.NothingChanged,this.CanPublish,this.DraftRev,this.ResponseStatus});
    FormReadinessResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Checks = JsonConverters.fromJson(json['Checks'],'List<FormReadinessCheck>',context!);
        Changes = JsonConverters.fromJson(json['Changes'],'List<String>',context!);
        NextVersion = json['NextVersion'];
        IsFirstPublish = json['IsFirstPublish'];
        NothingChanged = json['NothingChanged'];
        CanPublish = json['CanPublish'];
        DraftRev = json['DraftRev'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Checks': JsonConverters.toJson(Checks,'List<FormReadinessCheck>',context!),
        'Changes': JsonConverters.toJson(Changes,'List<String>',context!),
        'NextVersion': NextVersion,
        'IsFirstPublish': IsFirstPublish,
        'NothingChanged': NothingChanged,
        'CanPublish': CanPublish,
        'DraftRev': DraftRev,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

class FormReadinessRequest implements IConvertible
{
    String? FormUID;

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

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

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

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

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

Dart FormReadinessRequest 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}/readiness HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormReadinessResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CanPublish>false</CanPublish>
  <Changes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Changes>
  <Checks>
    <FormReadinessCheck>
      <FixFieldKey>String</FixFieldKey>
      <FixLabel>String</FixLabel>
      <FixTab>String</FixTab>
      <Level>String</Level>
      <Text>String</Text>
    </FormReadinessCheck>
  </Checks>
  <DraftRev>0</DraftRev>
  <IsFirstPublish>false</IsFirstPublish>
  <NextVersion>0</NextVersion>
  <NothingChanged>false</NothingChanged>
  <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>
</FormReadinessResponse>