Trendsic Platform Service

<back to all web services

FormSubmissionNoteRequest

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


open class FormSubmissionNoteRequest
{
    open var SubmissionUID:UUID? = null
    open var Text:String? = null
}

open class FormSubmissionRecordResponse
{
    open var Record:FormSubmissionRecord? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class FormSubmissionRecord
{
    open var SubmissionUID:UUID? = null
    open var FormUID:UUID? = null
    open var FormName:String? = null
    open var Noun:String? = null
    open var Number:String? = null
    open var ApplicantName:String? = null
    open var Stage:FormStageInfo? = null
    open var Tags:ArrayList<String> = ArrayList<String>()
    open var AssigneeAgentId:Int? = null
    open var AssigneeName:String? = null
    open var BranchName:String? = null
    open var SubmittedAt:Date? = null
    open var VersionNo:Int? = null
    open var CurrentVersionNo:Int? = null
    open var Email:String? = null
    open var Phone:String? = null
    open var ContactName:String? = null
    open var Meta:String? = null
    open var Stages:ArrayList<FormStageInfo> = ArrayList<FormStageInfo>()
    open var Moves:ArrayList<FormStageInfo> = ArrayList<FormStageInfo>()
    open var People:ArrayList<FormPerson> = ArrayList<FormPerson>()
    open var CanEdit:Boolean? = null
    open var CanSensitive:Boolean? = null
    open var Sections:ArrayList<FormRecordSection> = ArrayList<FormRecordSection>()
    open var Docs:ArrayList<FormRecordDoc> = ArrayList<FormRecordDoc>()
    open var DocCount:String? = null
    open var Computed:ArrayList<FormRecordComputed> = ArrayList<FormRecordComputed>()
    open var Timeline:ArrayList<FormRecordEvent> = ArrayList<FormRecordEvent>()
    open var Notes:ArrayList<FormRecordEvent> = ArrayList<FormRecordEvent>()
    open var Audit:ArrayList<FormRecordEvent> = ArrayList<FormRecordEvent>()
}

open class FormStageInfo
{
    open var Id:String? = null
    open var Label:String? = null
    open var Tone:String? = null
    open var Kind:String? = null
}

open class FormPerson
{
    open var AgentId:Int? = null
    open var AgentName:String? = null
}

open class FormRecordSection
{
    open var Title:String? = null
    open var Rows:ArrayList<FormRecordRow> = ArrayList<FormRecordRow>()
}

open class FormRecordRow
{
    open var K:String? = null
    open var L:String? = null
    open var T:String? = null
    open var Kind:String? = null
    open var V:String? = null
    open var Sensitive:Boolean? = null
    open var CanReveal:Boolean? = null
    open var Locked:Boolean? = null
    open var Files:ArrayList<FormRecordFile> = ArrayList<FormRecordFile>()
    open var NoFiles:Boolean? = null
    open var Sig:FormRecordSig? = null
}

open class FormRecordFile
{
    open var AttachmentId:UUID? = null
    open var Name:String? = null
    open var Kind:String? = null
    open var Size:String? = null
    open var Sensitive:Boolean? = null
    open var Locked:Boolean? = null
}

open class FormRecordSig
{
    open var Pending:Boolean? = null
    open var Mode:String? = null
    open var SignerName:String? = null
    open var Role:String? = null
    open var RecordId:Int? = null
    open var ImageHash:String? = null
    open var DocumentDigest:String? = null
    open var Ip:String? = null
    open var Browser:String? = null
    open var ConsentStored:Boolean? = null
    open var SignedText:String? = null
    open var HasImage:Boolean? = null
}

open class FormRecordDoc
{
    open var Name:String? = null
    open var Ok:Boolean? = null
    open var Tag:String? = null
    open var Tone:String? = null
}

open class FormRecordComputed
{
    open var L:String? = null
    open var V:String? = null
}

open class FormRecordEvent
{
    open var Who:String? = null
    open var X:String? = null
    open var T:String? = null
    open var At:Date? = null
    open var Dot:String? = null
}

Kotlin FormSubmissionNoteRequest 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}/notes HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	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
						}
					}
				]
			}
		],
		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
			}
		]
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}