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
FormSubmissionNoteRequest Parameters:
NameParameterData TypeRequiredDescription
SubmissionUIDpathGuidNo
TextbodystringNo
FormSubmissionRecordResponse Parameters:
NameParameterData TypeRequiredDescription
RecordformFormSubmissionRecordNo
ResponseStatusformResponseStatusNo
FormSubmissionRecord Parameters:
NameParameterData TypeRequiredDescription
SubmissionUIDformGuidNo
FormUIDformGuidNo
FormNameformstringNo
NounformstringNo
NumberformstringNo
ApplicantNameformstringNo
StageformFormStageInfoNo
TagsformList<string>No
AssigneeAgentIdformint?No
AssigneeNameformstringNo
BranchNameformstringNo
SubmittedAtformDateTime?No
VersionNoformintNo
CurrentVersionNoformintNo
EmailformstringNo
PhoneformstringNo
ContactNameformstringNo
MetaformstringNo
StagesformList<FormStageInfo>No
MovesformList<FormStageInfo>No
PeopleformList<FormPerson>No
CanEditformboolNo
CanSensitiveformboolNo
SectionsformList<FormRecordSection>No
DocsformList<FormRecordDoc>No
DocCountformstringNo
ComputedformList<FormRecordComputed>No
TimelineformList<FormRecordEvent>No
NotesformList<FormRecordEvent>No
AuditformList<FormRecordEvent>No
FormStageInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
LabelformstringNo
ToneformstringNo
KindformstringNo
FormPerson Parameters:
NameParameterData TypeRequiredDescription
AgentIdformintNo
AgentNameformstringNo
FormRecordSection Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
RowsformList<FormRecordRow>No
FormRecordRow Parameters:
NameParameterData TypeRequiredDescription
KformstringNo
LformstringNo
TformstringNo
KindformstringNo
VformstringNo
SensitiveformboolNo
CanRevealformboolNo
LockedformboolNo
FilesformList<FormRecordFile>No
NoFilesformboolNo
SigformFormRecordSigNo
FormRecordFile Parameters:
NameParameterData TypeRequiredDescription
AttachmentIdformGuidNo
NameformstringNo
KindformstringNo
SizeformstringNo
SensitiveformboolNo
LockedformboolNo
FormRecordSig Parameters:
NameParameterData TypeRequiredDescription
PendingformboolNo
ModeformstringNo
SignerNameformstringNo
RoleformstringNo
RecordIdformintNo
ImageHashformstringNo
DocumentDigestformstringNo
IpformstringNo
BrowserformstringNo
ConsentStoredformboolNo
SignedTextformstringNo
HasImageformboolNo
FormRecordDoc Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
OkformboolNo
TagformstringNo
ToneformstringNo
FormRecordComputed Parameters:
NameParameterData TypeRequiredDescription
LformstringNo
VformstringNo
FormRecordEvent Parameters:
NameParameterData TypeRequiredDescription
WhoformstringNo
XformstringNo
TformstringNo
AtformDateTimeNo
DotformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"SubmissionUID":"00000000000000000000000000000000","Text":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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-01T00:00:00.0000000","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-01T00:00:00.0000000","Dot":"String"}],"Notes":[{"Who":"String","X":"String","T":"String","At":"0001-01-01T00:00:00.0000000","Dot":"String"}],"Audit":[{"Who":"String","X":"String","T":"String","At":"0001-01-01T00:00:00.0000000","Dot":"String"}]},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}