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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Token: String,
	RequestUID: String,
	AnswersJson: String,
	Lang: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Sent: False,
	Status: 
	{
		Number: String,
		FormName: String,
		Noun: String,
		TenantName: String,
		Stage: String,
		StageKind: String,
		Stages: 
		[
			{
				Id: String,
				Label: String,
				Tone: String,
				Kind: String
			}
		],
		Seen: 
		[
			{
				Id: String,
				At: 0001-01-01
			}
		],
		SubmittedAt: 0001-01-01,
		Receipt: 
		[
			{
				Channel: String,
				To: String,
				Outcome: String
			}
		],
		CanWithdraw: False,
		Lang: String,
		NounEs: String,
		HasRequest: False,
		RequestNote: String,
		Outcome: String,
		DecisionReason: String,
		DecisionNote: String,
		ResponseStatus: 
		{
			ErrorCode: String,
			Message: String,
			StackTrace: String,
			Errors: 
			[
				{
					ErrorCode: String,
					FieldName: String,
					Message: String,
					Meta: 
					{
						String: String
					}
				}
			],
			Meta: 
			{
				String: String
			}
		}
	},
	Errors: 
	[
		{
			K: String,
			Msg: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}