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

export class FormRequestItem
{
    public K: string;
    public L: string;
    public Tag: string;
    public Tone: string;
    public Pre: boolean;
    public IsSignature: boolean;
    public IsSensitive: boolean;
    public Pi: number;

    public constructor(init?: Partial<FormRequestItem>) { (Object as any).assign(this, init); }
}

export class FormRequestPlan
{
    public Items: FormRequestItem[] = [];
    public Keys: string[] = [];
    public Resign: string[] = [];
    public ResignKeys: string[] = [];
    public Channels: string;
    public StageLabel: string;
    public Consequence: string;
    public Applicant: string;
    public Stage: string;
    public CanSend: boolean;
    public Refusal: string;

    public constructor(init?: Partial<FormRequestPlan>) { (Object as any).assign(this, init); }
}

export class FormSubmissionRequestPreviewResponse
{
    public Plan: FormRequestPlan;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<FormSubmissionRequestPreviewResponse>) { (Object as any).assign(this, init); }
}

export class FormSubmissionRequestPreviewRequest
{
    public SubmissionUID: string;
    public Keys: string[] = [];

    public constructor(init?: Partial<FormSubmissionRequestPreviewRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	}
}