Trendsic Platform Service

<back to all web services

FormSubmissionDecidePreviewRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/{SubmissionUID}/decide/preview
import 'package:servicestack/servicestack.dart';

class FormDecisionChoice implements IConvertible
{
    String? Id;
    String? Label;

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

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

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

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

class FormDecisionEffect implements IConvertible
{
    String? Kind;
    String? Text;
    String? Tone;

    FormDecisionEffect({this.Kind,this.Text,this.Tone});
    FormDecisionEffect.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class FormDecisionPlan implements IConvertible
{
    String? Who;
    String? Stage;
    List<FormDecisionChoice>? Choices = [];
    String? Outcome;
    List<String>? Reasons = [];
    String? Reason;
    bool? NeedSig;
    String? SignerName;
    String? SignerRefusal;
    List<FormDecisionEffect>? Effects = [];
    String? Block;
    String? GoLabel;
    String? GoCls;
    bool? CanDecide;
    String? Refusal;

    FormDecisionPlan({this.Who,this.Stage,this.Choices,this.Outcome,this.Reasons,this.Reason,this.NeedSig,this.SignerName,this.SignerRefusal,this.Effects,this.Block,this.GoLabel,this.GoCls,this.CanDecide,this.Refusal});
    FormDecisionPlan.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Who = json['Who'];
        Stage = json['Stage'];
        Choices = JsonConverters.fromJson(json['Choices'],'List<FormDecisionChoice>',context!);
        Outcome = json['Outcome'];
        Reasons = JsonConverters.fromJson(json['Reasons'],'List<String>',context!);
        Reason = json['Reason'];
        NeedSig = json['NeedSig'];
        SignerName = json['SignerName'];
        SignerRefusal = json['SignerRefusal'];
        Effects = JsonConverters.fromJson(json['Effects'],'List<FormDecisionEffect>',context!);
        Block = json['Block'];
        GoLabel = json['GoLabel'];
        GoCls = json['GoCls'];
        CanDecide = json['CanDecide'];
        Refusal = json['Refusal'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Who': Who,
        'Stage': Stage,
        'Choices': JsonConverters.toJson(Choices,'List<FormDecisionChoice>',context!),
        'Outcome': Outcome,
        'Reasons': JsonConverters.toJson(Reasons,'List<String>',context!),
        'Reason': Reason,
        'NeedSig': NeedSig,
        'SignerName': SignerName,
        'SignerRefusal': SignerRefusal,
        'Effects': JsonConverters.toJson(Effects,'List<FormDecisionEffect>',context!),
        'Block': Block,
        'GoLabel': GoLabel,
        'GoCls': GoCls,
        'CanDecide': CanDecide,
        'Refusal': Refusal
    };

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

class FormSubmissionDecidePreviewResponse implements IConvertible
{
    FormDecisionPlan? Plan;
    ResponseStatus? ResponseStatus;

    FormSubmissionDecidePreviewResponse({this.Plan,this.ResponseStatus});
    FormSubmissionDecidePreviewResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'Plan': JsonConverters.toJson(Plan,'FormDecisionPlan',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

class FormSubmissionDecidePreviewRequest implements IConvertible
{
    String? SubmissionUID;
    String? Outcome;
    String? Reason;
    String? Note;

    FormSubmissionDecidePreviewRequest({this.SubmissionUID,this.Outcome,this.Reason,this.Note});
    FormSubmissionDecidePreviewRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'SubmissionUID': SubmissionUID,
        'Outcome': Outcome,
        'Reason': Reason,
        'Note': Note
    };

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'FormDecisionChoice': TypeInfo(TypeOf.Class, create:() => FormDecisionChoice()),
    'FormDecisionEffect': TypeInfo(TypeOf.Class, create:() => FormDecisionEffect()),
    'FormDecisionPlan': TypeInfo(TypeOf.Class, create:() => FormDecisionPlan()),
    'List<FormDecisionChoice>': TypeInfo(TypeOf.Class, create:() => <FormDecisionChoice>[]),
    'List<FormDecisionEffect>': TypeInfo(TypeOf.Class, create:() => <FormDecisionEffect>[]),
    'FormSubmissionDecidePreviewResponse': TypeInfo(TypeOf.Class, create:() => FormSubmissionDecidePreviewResponse()),
    'FormSubmissionDecidePreviewRequest': TypeInfo(TypeOf.Class, create:() => FormSubmissionDecidePreviewRequest()),
});

Dart FormSubmissionDecidePreviewRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/forms/submissions/{SubmissionUID}/decide/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SubmissionUID":"00000000000000000000000000000000","Outcome":"String","Reason":"String","Note":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Plan":{"Who":"String","Stage":"String","Choices":[{"Id":"String","Label":"String"}],"Outcome":"String","Reasons":["String"],"Reason":"String","NeedSig":false,"SignerName":"String","SignerRefusal":"String","Effects":[{"Kind":"String","Text":"String","Tone":"String"}],"Block":"String","GoLabel":"String","GoCls":"String","CanDecide":false,"Refusal":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}