Trendsic Platform Service

<back to all web services

FormFillReplyRequest

The following routes are available for this service:
POST/v1/formfill/status/{Token}/request/send
import 'package:servicestack/servicestack.dart';

class FormFillStage implements IConvertible
{
    String? Id;
    String? Label;
    String? Tone;
    String? Kind;

    FormFillStage({this.Id,this.Label,this.Tone,this.Kind});
    FormFillStage.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Label = json['Label'];
        Tone = json['Tone'];
        Kind = json['Kind'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Label': Label,
        'Tone': Tone,
        'Kind': Kind
    };

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

class FormFillStageSeen implements IConvertible
{
    String? Id;
    DateTime? At;

    FormFillStageSeen({this.Id,this.At});
    FormFillStageSeen.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        At = JsonConverters.fromJson(json['At'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'At': JsonConverters.toJson(At,'DateTime',context!)
    };

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

class FormFillReceiptLine implements IConvertible
{
    String? Channel;
    String? To;
    String? Outcome;

    FormFillReceiptLine({this.Channel,this.To,this.Outcome});
    FormFillReceiptLine.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'Channel': Channel,
        'To': To,
        'Outcome': Outcome
    };

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

class FormFillStatusResponse implements IConvertible
{
    String? Number;
    String? FormName;
    String? Noun;
    String? TenantName;
    String? Stage;
    String? StageKind;
    List<FormFillStage>? Stages = [];
    List<FormFillStageSeen>? Seen = [];
    DateTime? SubmittedAt;
    List<FormFillReceiptLine>? Receipt = [];
    bool? CanWithdraw;
    String? Lang;
    String? NounEs;
    bool? HasRequest;
    String? RequestNote;
    String? Outcome;
    String? DecisionReason;
    String? DecisionNote;
    ResponseStatus? ResponseStatus;

    FormFillStatusResponse({this.Number,this.FormName,this.Noun,this.TenantName,this.Stage,this.StageKind,this.Stages,this.Seen,this.SubmittedAt,this.Receipt,this.CanWithdraw,this.Lang,this.NounEs,this.HasRequest,this.RequestNote,this.Outcome,this.DecisionReason,this.DecisionNote,this.ResponseStatus});
    FormFillStatusResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Number = json['Number'];
        FormName = json['FormName'];
        Noun = json['Noun'];
        TenantName = json['TenantName'];
        Stage = json['Stage'];
        StageKind = json['StageKind'];
        Stages = JsonConverters.fromJson(json['Stages'],'List<FormFillStage>',context!);
        Seen = JsonConverters.fromJson(json['Seen'],'List<FormFillStageSeen>',context!);
        SubmittedAt = JsonConverters.fromJson(json['SubmittedAt'],'DateTime',context!);
        Receipt = JsonConverters.fromJson(json['Receipt'],'List<FormFillReceiptLine>',context!);
        CanWithdraw = json['CanWithdraw'];
        Lang = json['Lang'];
        NounEs = json['NounEs'];
        HasRequest = json['HasRequest'];
        RequestNote = json['RequestNote'];
        Outcome = json['Outcome'];
        DecisionReason = json['DecisionReason'];
        DecisionNote = json['DecisionNote'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Number': Number,
        'FormName': FormName,
        'Noun': Noun,
        'TenantName': TenantName,
        'Stage': Stage,
        'StageKind': StageKind,
        'Stages': JsonConverters.toJson(Stages,'List<FormFillStage>',context!),
        'Seen': JsonConverters.toJson(Seen,'List<FormFillStageSeen>',context!),
        'SubmittedAt': JsonConverters.toJson(SubmittedAt,'DateTime',context!),
        'Receipt': JsonConverters.toJson(Receipt,'List<FormFillReceiptLine>',context!),
        'CanWithdraw': CanWithdraw,
        'Lang': Lang,
        'NounEs': NounEs,
        'HasRequest': HasRequest,
        'RequestNote': RequestNote,
        'Outcome': Outcome,
        'DecisionReason': DecisionReason,
        'DecisionNote': DecisionNote,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

class FormFillFieldError implements IConvertible
{
    String? K;
    String? Msg;

    FormFillFieldError({this.K,this.Msg});
    FormFillFieldError.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class FormFillReplyResponse implements IConvertible
{
    bool? Sent;
    FormFillStatusResponse? Status;
    List<FormFillFieldError>? Errors = [];
    ResponseStatus? ResponseStatus;

    FormFillReplyResponse({this.Sent,this.Status,this.Errors,this.ResponseStatus});
    FormFillReplyResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Sent = json['Sent'];
        Status = JsonConverters.fromJson(json['Status'],'FormFillStatusResponse',context!);
        Errors = JsonConverters.fromJson(json['Errors'],'List<FormFillFieldError>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Sent': Sent,
        'Status': JsonConverters.toJson(Status,'FormFillStatusResponse',context!),
        'Errors': JsonConverters.toJson(Errors,'List<FormFillFieldError>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

class FormFillReplyRequest implements IConvertible
{
    String? Token;
    String? RequestUID;
    String? AnswersJson;
    String? Lang;

    FormFillReplyRequest({this.Token,this.RequestUID,this.AnswersJson,this.Lang});
    FormFillReplyRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Token = json['Token'];
        RequestUID = json['RequestUID'];
        AnswersJson = json['AnswersJson'];
        Lang = json['Lang'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Token': Token,
        'RequestUID': RequestUID,
        'AnswersJson': AnswersJson,
        'Lang': Lang
    };

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'FormFillStage': TypeInfo(TypeOf.Class, create:() => FormFillStage()),
    'FormFillStageSeen': TypeInfo(TypeOf.Class, create:() => FormFillStageSeen()),
    'FormFillReceiptLine': TypeInfo(TypeOf.Class, create:() => FormFillReceiptLine()),
    'FormFillStatusResponse': TypeInfo(TypeOf.Class, create:() => FormFillStatusResponse()),
    'List<FormFillStage>': TypeInfo(TypeOf.Class, create:() => <FormFillStage>[]),
    'List<FormFillStageSeen>': TypeInfo(TypeOf.Class, create:() => <FormFillStageSeen>[]),
    'List<FormFillReceiptLine>': TypeInfo(TypeOf.Class, create:() => <FormFillReceiptLine>[]),
    'FormFillFieldError': TypeInfo(TypeOf.Class, create:() => FormFillFieldError()),
    'FormFillReplyResponse': TypeInfo(TypeOf.Class, create:() => FormFillReplyResponse()),
    'List<FormFillFieldError>': TypeInfo(TypeOf.Class, create:() => <FormFillFieldError>[]),
    'FormFillReplyRequest': TypeInfo(TypeOf.Class, create:() => FormFillReplyRequest()),
});

Dart FormFillReplyRequest 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/formfill/status/{Token}/request/send HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormFillReplyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AnswersJson>String</AnswersJson>
  <Lang>String</Lang>
  <RequestUID>String</RequestUID>
  <Token>String</Token>
</FormFillReplyRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormFillReplyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Errors>
    <FormFillFieldError>
      <K>String</K>
      <Msg>String</Msg>
    </FormFillFieldError>
  </Errors>
  <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>
  <Sent>false</Sent>
  <Status>
    <CanWithdraw>false</CanWithdraw>
    <DecisionNote>String</DecisionNote>
    <DecisionReason>String</DecisionReason>
    <FormName>String</FormName>
    <HasRequest>false</HasRequest>
    <Lang>String</Lang>
    <Noun>String</Noun>
    <NounEs>String</NounEs>
    <Number>String</Number>
    <Outcome>String</Outcome>
    <Receipt>
      <FormFillReceiptLine>
        <Channel>String</Channel>
        <Outcome>String</Outcome>
        <To>String</To>
      </FormFillReceiptLine>
    </Receipt>
    <RequestNote>String</RequestNote>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <Seen>
      <FormFillStageSeen>
        <At>0001-01-01T00:00:00</At>
        <Id>String</Id>
      </FormFillStageSeen>
    </Seen>
    <Stage>String</Stage>
    <StageKind>String</StageKind>
    <Stages>
      <FormFillStage>
        <Id>String</Id>
        <Kind>String</Kind>
        <Label>String</Label>
        <Tone>String</Tone>
      </FormFillStage>
    </Stages>
    <SubmittedAt>0001-01-01T00:00:00</SubmittedAt>
    <TenantName>String</TenantName>
  </Status>
</FormFillReplyResponse>