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
import Foundation
import ServiceStack

public class FormSubmissionRequestInfoRequest : Codable
{
    public var submissionUID:String
    public var keys:[String] = []
    public var note:String
    public var from:String

    required public init(){}
}

public class FormSubmissionRequestInfoResponse : FormSubmissionRecordResponse
{
    public var sent:[FormFillReceiptLine] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case sent
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        sent = try container.decodeIfPresent([FormFillReceiptLine].self, forKey: .sent) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if sent.count > 0 { try container.encode(sent, forKey: .sent) }
    }
}

public class FormSubmissionRecordResponse : Codable
{
    public var record:FormSubmissionRecord
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class FormSubmissionRecord : Codable
{
    public var submissionUID:String
    public var formUID:String
    public var formName:String
    public var noun:String
    public var number:String
    public var applicantName:String
    public var stage:FormStageInfo
    public var tags:[String] = []
    public var assigneeAgentId:Int?
    public var assigneeName:String
    public var branchName:String
    public var submittedAt:Date?
    public var versionNo:Int
    public var currentVersionNo:Int
    public var email:String
    public var phone:String
    public var contactName:String
    public var meta:String
    public var stages:[FormStageInfo] = []
    public var moves:[FormStageInfo] = []
    public var people:[FormPerson] = []
    public var canEdit:Bool
    public var canSensitive:Bool
    public var sections:[FormRecordSection] = []
    public var docs:[FormRecordDoc] = []
    public var docCount:String
    public var computed:[FormRecordComputed] = []
    public var timeline:[FormRecordEvent] = []
    public var notes:[FormRecordEvent] = []
    public var audit:[FormRecordEvent] = []
    public var isTest:Bool
    public var versionText:String
    public var tenantName:String
    public var submittedIso:String
    public var openRequest:FormRecordRequest
    public var canRequest:Bool
    public var requestTip:String
    public var decision:FormRecordDecision
    public var earlier:[FormRecordEarlierDecision] = []
    public var canDecide:Bool
    public var decideTip:String
    public var moveTip:String
    public var dueAt:Date?
    public var overdue:Bool
    public var ageText:String
    public var dueText:String
    public var signatures:[FormRecordSigEntry] = []
    public var replaced:[FormRecordReplaced] = []

    required public init(){}
}

public class FormStageInfo : Codable
{
    public var id:String
    public var label:String
    public var tone:String
    public var kind:String

    required public init(){}
}

public class FormPerson : Codable
{
    public var agentId:Int
    public var agentName:String

    required public init(){}
}

public class FormRecordSection : Codable
{
    public var title:String
    public var rows:[FormRecordRow] = []

    required public init(){}
}

public class FormRecordRow : Codable
{
    public var k:String
    public var l:String
    public var t:String
    public var kind:String
    public var v:String
    public var sensitive:Bool
    public var canReveal:Bool
    public var locked:Bool
    public var files:[FormRecordFile] = []
    public var noFiles:Bool
    public var sig:FormRecordSig
    public var asked:Bool
    public var changed:Bool
    public var prev:String

    required public init(){}
}

public class FormRecordFile : Codable
{
    public var attachmentId:String
    public var name:String
    public var kind:String
    public var size:String
    public var sensitive:Bool
    public var locked:Bool

    required public init(){}
}

public class FormRecordSig : Codable
{
    public var pending:Bool
    public var mode:String
    public var signerName:String
    public var role:String
    public var recordId:Int
    public var imageHash:String
    public var documentDigest:String
    public var ip:String
    public var browser:String
    public var consentStored:Bool
    public var signedText:String
    public var hasImage:Bool

    required public init(){}
}

public class FormRecordDoc : Codable
{
    public var name:String
    public var ok:Bool
    public var tag:String
    public var tone:String

    required public init(){}
}

public class FormRecordComputed : Codable
{
    public var l:String
    public var v:String

    required public init(){}
}

public class FormRecordEvent : Codable
{
    public var who:String
    public var x:String
    public var t:String
    public var at:Date
    public var dot:String

    required public init(){}
}

public class FormRecordRequest : Codable
{
    public var requestUID:String
    public var keys:[String] = []
    public var resign:[String] = []
    public var note:String
    public var by:String
    public var at:String

    required public init(){}
}

public class FormRecordDecision : Codable
{
    public var outcome:String
    public var tone:String
    public var reason:String
    public var note:String
    public var text:String
    public var hasCounter:Bool
    public var typed:Bool
    public var drawn:Bool
    public var sigName:String
    public var sigMeta:String

    required public init(){}
}

public class FormRecordEarlierDecision : Codable
{
    public var outcome:String
    public var tone:String
    public var reason:String
    public var note:String
    public var text:String
    public var counter:String
    public var reopened:String

    required public init(){}
}

public class FormRecordSigEntry : Codable
{
    public var recordId:Int
    public var key:String
    public var label:String
    public var role:String
    public var signerName:String
    public var mode:String
    public var hasImage:Bool
    public var consentStored:Bool
    public var replaced:Bool
    public var counter:Bool
    public var reopened:Bool
    public var meta:String

    required public init(){}
}

public class FormRecordReplaced : Codable
{
    public var requestUID:String
    public var askedBy:String
    public var askedAt:String
    public var answeredAt:String
    public var covering:String
    public var rows:[FormRecordReplacedRow] = []

    required public init(){}
}

public class FormRecordReplacedRow : Codable
{
    public var k:String
    public var l:String
    public var kind:String
    public var v:String
    public var sensitive:Bool
    public var canReveal:Bool
    public var locked:Bool
    public var files:[FormRecordFile] = []

    required public init(){}
}

public class FormFillReceiptLine : Codable
{
    public var channel:String
    public var to:String
    public var outcome:String

    required public init(){}
}


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