Trendsic Platform Service

<back to all web services

FormSubmissionRequestInfoRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/{SubmissionUID}/request-info
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 FormFillReceiptLine
    {
        public virtual string Channel { get; set; }
        public virtual string To { get; set; }
        public virtual string Outcome { get; set; }
    }

    public partial class FormPerson
    {
        public virtual int AgentId { get; set; }
        public virtual string AgentName { get; set; }
    }

    public partial class FormRecordComputed
    {
        public virtual string L { get; set; }
        public virtual string V { get; set; }
    }

    public partial class FormRecordDecision
    {
        public virtual string Outcome { get; set; }
        public virtual string Tone { get; set; }
        public virtual string Reason { get; set; }
        public virtual string Note { get; set; }
        public virtual string Text { get; set; }
        public virtual bool HasCounter { get; set; }
        public virtual bool Typed { get; set; }
        public virtual bool Drawn { get; set; }
        public virtual string SigName { get; set; }
        public virtual string SigMeta { get; set; }
    }

    public partial class FormRecordDoc
    {
        public virtual string Name { get; set; }
        public virtual bool Ok { get; set; }
        public virtual string Tag { get; set; }
        public virtual string Tone { get; set; }
    }

    public partial class FormRecordEarlierDecision
    {
        public virtual string Outcome { get; set; }
        public virtual string Tone { get; set; }
        public virtual string Reason { get; set; }
        public virtual string Note { get; set; }
        public virtual string Text { get; set; }
        public virtual string Counter { get; set; }
        public virtual string Reopened { get; set; }
    }

    public partial class FormRecordEvent
    {
        public virtual string Who { get; set; }
        public virtual string X { get; set; }
        public virtual string T { get; set; }
        public virtual DateTime At { get; set; }
        public virtual string Dot { get; set; }
    }

    public partial class FormRecordFile
    {
        public virtual Guid AttachmentId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Kind { get; set; }
        public virtual string Size { get; set; }
        public virtual bool Sensitive { get; set; }
        public virtual bool Locked { get; set; }
    }

    public partial class FormRecordReplaced
    {
        public virtual Guid RequestUID { get; set; }
        public virtual string AskedBy { get; set; }
        public virtual string AskedAt { get; set; }
        public virtual string AnsweredAt { get; set; }
        public virtual string Covering { get; set; }
        public virtual List<FormRecordReplacedRow> Rows { get; set; } = [];
    }

    public partial class FormRecordReplacedRow
    {
        public virtual string K { get; set; }
        public virtual string L { get; set; }
        public virtual string Kind { get; set; }
        public virtual string V { get; set; }
        public virtual bool Sensitive { get; set; }
        public virtual bool CanReveal { get; set; }
        public virtual bool Locked { get; set; }
        public virtual List<FormRecordFile> Files { get; set; } = [];
    }

    public partial class FormRecordRequest
    {
        public virtual Guid RequestUID { get; set; }
        public virtual List<string> Keys { get; set; } = [];
        public virtual List<string> Resign { get; set; } = [];
        public virtual string Note { get; set; }
        public virtual string By { get; set; }
        public virtual string At { get; set; }
    }

    public partial class FormRecordRow
    {
        public virtual string K { get; set; }
        public virtual string L { get; set; }
        public virtual string T { get; set; }
        public virtual string Kind { get; set; }
        public virtual string V { get; set; }
        public virtual bool Sensitive { get; set; }
        public virtual bool CanReveal { get; set; }
        public virtual bool Locked { get; set; }
        public virtual List<FormRecordFile> Files { get; set; } = [];
        public virtual bool NoFiles { get; set; }
        public virtual FormRecordSig Sig { get; set; }
        public virtual bool Asked { get; set; }
        public virtual bool Changed { get; set; }
        public virtual string Prev { get; set; }
    }

    public partial class FormRecordSection
    {
        public virtual string Title { get; set; }
        public virtual List<FormRecordRow> Rows { get; set; } = [];
    }

    public partial class FormRecordSig
    {
        public virtual bool Pending { get; set; }
        public virtual string Mode { get; set; }
        public virtual string SignerName { get; set; }
        public virtual string Role { get; set; }
        public virtual int RecordId { get; set; }
        public virtual string ImageHash { get; set; }
        public virtual string DocumentDigest { get; set; }
        public virtual string Ip { get; set; }
        public virtual string Browser { get; set; }
        public virtual bool ConsentStored { get; set; }
        public virtual string SignedText { get; set; }
        public virtual bool HasImage { get; set; }
    }

    public partial class FormRecordSigEntry
    {
        public virtual int RecordId { get; set; }
        public virtual string Key { get; set; }
        public virtual string Label { get; set; }
        public virtual string Role { get; set; }
        public virtual string SignerName { get; set; }
        public virtual string Mode { get; set; }
        public virtual bool HasImage { get; set; }
        public virtual bool ConsentStored { get; set; }
        public virtual bool Replaced { get; set; }
        public virtual bool Counter { get; set; }
        public virtual bool Reopened { get; set; }
        public virtual string Meta { get; set; }
    }

    public partial class FormStageInfo
    {
        public virtual string Id { get; set; }
        public virtual string Label { get; set; }
        public virtual string Tone { get; set; }
        public virtual string Kind { get; set; }
    }

    public partial class FormSubmissionRecord
    {
        public virtual Guid SubmissionUID { get; set; }
        public virtual Guid FormUID { get; set; }
        public virtual string FormName { get; set; }
        public virtual string Noun { get; set; }
        public virtual string Number { get; set; }
        public virtual string ApplicantName { get; set; }
        public virtual FormStageInfo Stage { get; set; }
        public virtual List<string> Tags { get; set; } = [];
        public virtual int? AssigneeAgentId { get; set; }
        public virtual string AssigneeName { get; set; }
        public virtual string BranchName { get; set; }
        public virtual DateTime? SubmittedAt { get; set; }
        public virtual int VersionNo { get; set; }
        public virtual int CurrentVersionNo { get; set; }
        public virtual string Email { get; set; }
        public virtual string Phone { get; set; }
        public virtual string ContactName { get; set; }
        public virtual string Meta { get; set; }
        public virtual List<FormStageInfo> Stages { get; set; } = [];
        public virtual List<FormStageInfo> Moves { get; set; } = [];
        public virtual List<FormPerson> People { get; set; } = [];
        public virtual bool CanEdit { get; set; }
        public virtual bool CanSensitive { get; set; }
        public virtual List<FormRecordSection> Sections { get; set; } = [];
        public virtual List<FormRecordDoc> Docs { get; set; } = [];
        public virtual string DocCount { get; set; }
        public virtual List<FormRecordComputed> Computed { get; set; } = [];
        public virtual List<FormRecordEvent> Timeline { get; set; } = [];
        public virtual List<FormRecordEvent> Notes { get; set; } = [];
        public virtual List<FormRecordEvent> Audit { get; set; } = [];
        public virtual bool IsTest { get; set; }
        public virtual string VersionText { get; set; }
        public virtual string TenantName { get; set; }
        public virtual string SubmittedIso { get; set; }
        public virtual FormRecordRequest OpenRequest { get; set; }
        public virtual bool CanRequest { get; set; }
        public virtual string RequestTip { get; set; }
        public virtual FormRecordDecision Decision { get; set; }
        public virtual List<FormRecordEarlierDecision> Earlier { get; set; } = [];
        public virtual bool CanDecide { get; set; }
        public virtual string DecideTip { get; set; }
        public virtual string MoveTip { get; set; }
        public virtual DateTime? DueAt { get; set; }
        public virtual bool Overdue { get; set; }
        public virtual string AgeText { get; set; }
        public virtual string DueText { get; set; }
        public virtual List<FormRecordSigEntry> Signatures { get; set; } = [];
        public virtual List<FormRecordReplaced> Replaced { get; set; } = [];
    }

    public partial class FormSubmissionRecordResponse
    {
        public virtual FormSubmissionRecord Record { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class FormSubmissionRequestInfoRequest
    {
        public virtual Guid SubmissionUID { get; set; }
        public virtual List<string> Keys { get; set; } = [];
        public virtual string Note { get; set; }
        public virtual string From { get; set; }
    }

    public partial class FormSubmissionRequestInfoResponse
        : FormSubmissionRecordResponse
    {
        public virtual List<FormFillReceiptLine> Sent { get; set; } = [];
    }

}

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

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

{
	Sent: 
	[
		{
			Channel: String,
			To: String,
			Outcome: String
		}
	],
	Record: 
	{
		SubmissionUID: 00000000000000000000000000000000,
		FormUID: 00000000000000000000000000000000,
		FormName: String,
		Noun: String,
		Number: String,
		ApplicantName: String,
		Stage: 
		{
			Id: String,
			Label: String,
			Tone: String,
			Kind: String
		},
		Tags: 
		[
			String
		],
		AssigneeAgentId: 0,
		AssigneeName: String,
		BranchName: String,
		SubmittedAt: 0001-01-01,
		VersionNo: 0,
		CurrentVersionNo: 0,
		Email: String,
		Phone: String,
		ContactName: String,
		Meta: String,
		Stages: 
		[
			{
				Id: String,
				Label: String,
				Tone: String,
				Kind: String
			}
		],
		Moves: 
		[
			{
				Id: String,
				Label: String,
				Tone: String,
				Kind: String
			}
		],
		People: 
		[
			{
				AgentId: 0,
				AgentName: String
			}
		],
		CanEdit: False,
		CanSensitive: False,
		Sections: 
		[
			{
				Title: String,
				Rows: 
				[
					{
						K: String,
						L: String,
						T: String,
						Kind: String,
						V: String,
						Sensitive: False,
						CanReveal: False,
						Locked: False,
						Files: 
						[
							{
								AttachmentId: 00000000000000000000000000000000,
								Name: String,
								Kind: String,
								Size: String,
								Sensitive: False,
								Locked: False
							}
						],
						NoFiles: False,
						Sig: 
						{
							Pending: False,
							Mode: String,
							SignerName: String,
							Role: String,
							RecordId: 0,
							ImageHash: String,
							DocumentDigest: String,
							Ip: String,
							Browser: String,
							ConsentStored: False,
							SignedText: String,
							HasImage: False
						},
						Asked: False,
						Changed: False,
						Prev: String
					}
				]
			}
		],
		Docs: 
		[
			{
				Name: String,
				Ok: False,
				Tag: String,
				Tone: String
			}
		],
		DocCount: String,
		Computed: 
		[
			{
				L: String,
				V: String
			}
		],
		Timeline: 
		[
			{
				Who: String,
				X: String,
				T: String,
				At: 0001-01-01,
				Dot: String
			}
		],
		Notes: 
		[
			{
				Who: String,
				X: String,
				T: String,
				At: 0001-01-01,
				Dot: String
			}
		],
		Audit: 
		[
			{
				Who: String,
				X: String,
				T: String,
				At: 0001-01-01,
				Dot: String
			}
		],
		IsTest: False,
		VersionText: String,
		TenantName: String,
		SubmittedIso: String,
		OpenRequest: 
		{
			RequestUID: 00000000000000000000000000000000,
			Keys: 
			[
				String
			],
			Resign: 
			[
				String
			],
			Note: String,
			By: String,
			At: String
		},
		CanRequest: False,
		RequestTip: String,
		Decision: 
		{
			Outcome: String,
			Tone: String,
			Reason: String,
			Note: String,
			Text: String,
			HasCounter: False,
			Typed: False,
			Drawn: False,
			SigName: String,
			SigMeta: String
		},
		Earlier: 
		[
			{
				Outcome: String,
				Tone: String,
				Reason: String,
				Note: String,
				Text: String,
				Counter: String,
				Reopened: String
			}
		],
		CanDecide: False,
		DecideTip: String,
		MoveTip: String,
		DueAt: 0001-01-01,
		Overdue: False,
		AgeText: String,
		DueText: String,
		Signatures: 
		[
			{
				RecordId: 0,
				Key: String,
				Label: String,
				Role: String,
				SignerName: String,
				Mode: String,
				HasImage: False,
				ConsentStored: False,
				Replaced: False,
				Counter: False,
				Reopened: False,
				Meta: String
			}
		],
		Replaced: 
		[
			{
				RequestUID: 00000000000000000000000000000000,
				AskedBy: String,
				AskedAt: String,
				AnsweredAt: String,
				Covering: String,
				Rows: 
				[
					{
						K: String,
						L: String,
						Kind: String,
						V: String,
						Sensitive: False,
						CanReveal: False,
						Locked: False,
						Files: 
						[
							{
								AttachmentId: 00000000000000000000000000000000,
								Name: String,
								Kind: String,
								Size: String,
								Sensitive: False,
								Locked: False
							}
						]
					}
				]
			}
		]
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}