Trendsic Platform Service

<back to all web services

FormSubmissionRequestPreviewRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/{SubmissionUID}/request-info/preview
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class FormSubmissionRequestPreviewRequest
    {
        public UUID SubmissionUID = null;
        public ArrayList<String> Keys = new ArrayList<String>();
        
        public UUID getSubmissionUID() { return SubmissionUID; }
        public FormSubmissionRequestPreviewRequest setSubmissionUID(UUID value) { this.SubmissionUID = value; return this; }
        public ArrayList<String> getKeys() { return Keys; }
        public FormSubmissionRequestPreviewRequest setKeys(ArrayList<String> value) { this.Keys = value; return this; }
    }

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

    public static class FormRequestPlan
    {
        public ArrayList<FormRequestItem> Items = new ArrayList<FormRequestItem>();
        public ArrayList<String> Keys = new ArrayList<String>();
        public ArrayList<String> Resign = new ArrayList<String>();
        public ArrayList<String> ResignKeys = new ArrayList<String>();
        public String Channels = null;
        public String StageLabel = null;
        public String Consequence = null;
        public String Applicant = null;
        public String Stage = null;
        public Boolean CanSend = null;
        public String Refusal = null;
        
        public ArrayList<FormRequestItem> getItems() { return Items; }
        public FormRequestPlan setItems(ArrayList<FormRequestItem> value) { this.Items = value; return this; }
        public ArrayList<String> getKeys() { return Keys; }
        public FormRequestPlan setKeys(ArrayList<String> value) { this.Keys = value; return this; }
        public ArrayList<String> getResign() { return Resign; }
        public FormRequestPlan setResign(ArrayList<String> value) { this.Resign = value; return this; }
        public ArrayList<String> getResignKeys() { return ResignKeys; }
        public FormRequestPlan setResignKeys(ArrayList<String> value) { this.ResignKeys = value; return this; }
        public String getChannels() { return Channels; }
        public FormRequestPlan setChannels(String value) { this.Channels = value; return this; }
        public String getStageLabel() { return StageLabel; }
        public FormRequestPlan setStageLabel(String value) { this.StageLabel = value; return this; }
        public String getConsequence() { return Consequence; }
        public FormRequestPlan setConsequence(String value) { this.Consequence = value; return this; }
        public String getApplicant() { return Applicant; }
        public FormRequestPlan setApplicant(String value) { this.Applicant = value; return this; }
        public String getStage() { return Stage; }
        public FormRequestPlan setStage(String value) { this.Stage = value; return this; }
        public Boolean isCanSend() { return CanSend; }
        public FormRequestPlan setCanSend(Boolean value) { this.CanSend = value; return this; }
        public String getRefusal() { return Refusal; }
        public FormRequestPlan setRefusal(String value) { this.Refusal = value; return this; }
    }

    public static class FormRequestItem
    {
        public String K = null;
        public String L = null;
        public String Tag = null;
        public String Tone = null;
        public Boolean Pre = null;
        public Boolean IsSignature = null;
        public Boolean IsSensitive = null;
        public Integer Pi = null;
        
        public String getK() { return K; }
        public FormRequestItem setK(String value) { this.K = value; return this; }
        public String getL() { return L; }
        public FormRequestItem setL(String value) { this.L = value; return this; }
        public String getTag() { return Tag; }
        public FormRequestItem setTag(String value) { this.Tag = value; return this; }
        public String getTone() { return Tone; }
        public FormRequestItem setTone(String value) { this.Tone = value; return this; }
        public Boolean isPre() { return Pre; }
        public FormRequestItem setPre(Boolean value) { this.Pre = value; return this; }
        public Boolean getIsSignature() { return IsSignature; }
        public FormRequestItem setIsSignature(Boolean value) { this.IsSignature = value; return this; }
        public Boolean getIsSensitive() { return IsSensitive; }
        public FormRequestItem setIsSensitive(Boolean value) { this.IsSensitive = value; return this; }
        public Integer getPi() { return Pi; }
        public FormRequestItem setPi(Integer value) { this.Pi = value; return this; }
    }

}

Java FormSubmissionRequestPreviewRequest 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/forms/submissions/{SubmissionUID}/request-info/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	SubmissionUID: 00000000000000000000000000000000,
	Keys: 
	[
		String
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Plan: 
	{
		Items: 
		[
			{
				K: String,
				L: String,
				Tag: String,
				Tone: String,
				Pre: False,
				IsSignature: False,
				IsSensitive: False,
				Pi: 0
			}
		],
		Keys: 
		[
			String
		],
		Resign: 
		[
			String
		],
		ResignKeys: 
		[
			String
		],
		Channels: String,
		StageLabel: String,
		Consequence: String,
		Applicant: String,
		Stage: String,
		CanSend: False,
		Refusal: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}