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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class FormDecisionChoice
    {
        public virtual string Id { get; set; }
        public virtual string Label { get; set; }
    }

    public partial class FormDecisionEffect
    {
        public virtual string Kind { get; set; }
        public virtual string Text { get; set; }
        public virtual string Tone { get; set; }
    }

    public partial class FormDecisionPlan
    {
        public virtual string Who { get; set; }
        public virtual string Stage { get; set; }
        public virtual List<FormDecisionChoice> Choices { get; set; } = [];
        public virtual string Outcome { get; set; }
        public virtual List<string> Reasons { get; set; } = [];
        public virtual string Reason { get; set; }
        public virtual bool NeedSig { get; set; }
        public virtual string SignerName { get; set; }
        public virtual string SignerRefusal { get; set; }
        public virtual List<FormDecisionEffect> Effects { get; set; } = [];
        public virtual string Block { get; set; }
        public virtual string GoLabel { get; set; }
        public virtual string GoCls { get; set; }
        public virtual bool CanDecide { get; set; }
        public virtual string Refusal { get; set; }
    }

    public partial class FormSubmissionDecidePreviewRequest
    {
        public virtual Guid SubmissionUID { get; set; }
        public virtual string Outcome { get; set; }
        public virtual string Reason { get; set; }
        public virtual string Note { get; set; }
    }

    public partial class FormSubmissionDecidePreviewResponse
    {
        public virtual FormDecisionPlan Plan { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# FormSubmissionDecidePreviewRequest 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}/decide/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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