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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class FormSubmissionDecidePreviewRequest
    {
        public UUID SubmissionUID = null;
        public String Outcome = null;
        public String Reason = null;
        public String Note = null;
        
        public UUID getSubmissionUID() { return SubmissionUID; }
        public FormSubmissionDecidePreviewRequest setSubmissionUID(UUID value) { this.SubmissionUID = value; return this; }
        public String getOutcome() { return Outcome; }
        public FormSubmissionDecidePreviewRequest setOutcome(String value) { this.Outcome = value; return this; }
        public String getReason() { return Reason; }
        public FormSubmissionDecidePreviewRequest setReason(String value) { this.Reason = value; return this; }
        public String getNote() { return Note; }
        public FormSubmissionDecidePreviewRequest setNote(String value) { this.Note = value; return this; }
    }

    public static class FormSubmissionDecidePreviewResponse
    {
        public FormDecisionPlan Plan = null;
        public ResponseStatus ResponseStatus = null;
        
        public FormDecisionPlan getPlan() { return Plan; }
        public FormSubmissionDecidePreviewResponse setPlan(FormDecisionPlan value) { this.Plan = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public FormSubmissionDecidePreviewResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class FormDecisionPlan
    {
        public String Who = null;
        public String Stage = null;
        public ArrayList<FormDecisionChoice> Choices = new ArrayList<FormDecisionChoice>();
        public String Outcome = null;
        public ArrayList<String> Reasons = new ArrayList<String>();
        public String Reason = null;
        public Boolean NeedSig = null;
        public String SignerName = null;
        public String SignerRefusal = null;
        public ArrayList<FormDecisionEffect> Effects = new ArrayList<FormDecisionEffect>();
        public String Block = null;
        public String GoLabel = null;
        public String GoCls = null;
        public Boolean CanDecide = null;
        public String Refusal = null;
        
        public String getWho() { return Who; }
        public FormDecisionPlan setWho(String value) { this.Who = value; return this; }
        public String getStage() { return Stage; }
        public FormDecisionPlan setStage(String value) { this.Stage = value; return this; }
        public ArrayList<FormDecisionChoice> getChoices() { return Choices; }
        public FormDecisionPlan setChoices(ArrayList<FormDecisionChoice> value) { this.Choices = value; return this; }
        public String getOutcome() { return Outcome; }
        public FormDecisionPlan setOutcome(String value) { this.Outcome = value; return this; }
        public ArrayList<String> getReasons() { return Reasons; }
        public FormDecisionPlan setReasons(ArrayList<String> value) { this.Reasons = value; return this; }
        public String getReason() { return Reason; }
        public FormDecisionPlan setReason(String value) { this.Reason = value; return this; }
        public Boolean isNeedSig() { return NeedSig; }
        public FormDecisionPlan setNeedSig(Boolean value) { this.NeedSig = value; return this; }
        public String getSignerName() { return SignerName; }
        public FormDecisionPlan setSignerName(String value) { this.SignerName = value; return this; }
        public String getSignerRefusal() { return SignerRefusal; }
        public FormDecisionPlan setSignerRefusal(String value) { this.SignerRefusal = value; return this; }
        public ArrayList<FormDecisionEffect> getEffects() { return Effects; }
        public FormDecisionPlan setEffects(ArrayList<FormDecisionEffect> value) { this.Effects = value; return this; }
        public String getBlock() { return Block; }
        public FormDecisionPlan setBlock(String value) { this.Block = value; return this; }
        public String getGoLabel() { return GoLabel; }
        public FormDecisionPlan setGoLabel(String value) { this.GoLabel = value; return this; }
        public String getGoCls() { return GoCls; }
        public FormDecisionPlan setGoCls(String value) { this.GoCls = value; return this; }
        public Boolean isCanDecide() { return CanDecide; }
        public FormDecisionPlan setCanDecide(Boolean value) { this.CanDecide = value; return this; }
        public String getRefusal() { return Refusal; }
        public FormDecisionPlan setRefusal(String value) { this.Refusal = value; return this; }
    }

    public static class FormDecisionChoice
    {
        public String Id = null;
        public String Label = null;
        
        public String getId() { return Id; }
        public FormDecisionChoice setId(String value) { this.Id = value; return this; }
        public String getLabel() { return Label; }
        public FormDecisionChoice setLabel(String value) { this.Label = value; return this; }
    }

    public static class FormDecisionEffect
    {
        public String Kind = null;
        public String Text = null;
        public String Tone = null;
        
        public String getKind() { return Kind; }
        public FormDecisionEffect setKind(String value) { this.Kind = value; return this; }
        public String getText() { return Text; }
        public FormDecisionEffect setText(String value) { this.Text = value; return this; }
        public String getTone() { return Tone; }
        public FormDecisionEffect setTone(String value) { this.Tone = value; return this; }
    }

}

Java FormSubmissionDecidePreviewRequest DTOs

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

HTTP + OTHER

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

{"SubmissionUID":"00000000000000000000000000000000","Outcome":"String","Reason":"String","Note":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}