| POST | /v1/forms/submissions/{SubmissionUID}/notes |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SubmissionUID | path | Guid | No | |
| Text | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Record | form | FormSubmissionRecord | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SubmissionUID | form | Guid | No | |
| FormUID | form | Guid | No | |
| FormName | form | string | No | |
| Noun | form | string | No | |
| Number | form | string | No | |
| ApplicantName | form | string | No | |
| Stage | form | FormStageInfo | No | |
| Tags | form | List<string> | No | |
| AssigneeAgentId | form | int? | No | |
| AssigneeName | form | string | No | |
| BranchName | form | string | No | |
| SubmittedAt | form | DateTime? | No | |
| VersionNo | form | int | No | |
| CurrentVersionNo | form | int | No | |
| form | string | No | ||
| Phone | form | string | No | |
| ContactName | form | string | No | |
| Meta | form | string | No | |
| Stages | form | List<FormStageInfo> | No | |
| Moves | form | List<FormStageInfo> | No | |
| People | form | List<FormPerson> | No | |
| CanEdit | form | bool | No | |
| CanSensitive | form | bool | No | |
| Sections | form | List<FormRecordSection> | No | |
| Docs | form | List<FormRecordDoc> | No | |
| DocCount | form | string | No | |
| Computed | form | List<FormRecordComputed> | No | |
| Timeline | form | List<FormRecordEvent> | No | |
| Notes | form | List<FormRecordEvent> | No | |
| Audit | form | List<FormRecordEvent> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Label | form | string | No | |
| Tone | form | string | No | |
| Kind | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AgentId | form | int | No | |
| AgentName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Title | form | string | No | |
| Rows | form | List<FormRecordRow> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| K | form | string | No | |
| L | form | string | No | |
| T | form | string | No | |
| Kind | form | string | No | |
| V | form | string | No | |
| Sensitive | form | bool | No | |
| CanReveal | form | bool | No | |
| Locked | form | bool | No | |
| Files | form | List<FormRecordFile> | No | |
| NoFiles | form | bool | No | |
| Sig | form | FormRecordSig | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AttachmentId | form | Guid | No | |
| Name | form | string | No | |
| Kind | form | string | No | |
| Size | form | string | No | |
| Sensitive | form | bool | No | |
| Locked | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Pending | form | bool | No | |
| Mode | form | string | No | |
| SignerName | form | string | No | |
| Role | form | string | No | |
| RecordId | form | int | No | |
| ImageHash | form | string | No | |
| DocumentDigest | form | string | No | |
| Ip | form | string | No | |
| Browser | form | string | No | |
| ConsentStored | form | bool | No | |
| SignedText | form | string | No | |
| HasImage | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Ok | form | bool | No | |
| Tag | form | string | No | |
| Tone | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| L | form | string | No | |
| V | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Who | form | string | No | |
| X | form | string | No | |
| T | form | string | No | |
| At | form | DateTime | No | |
| Dot | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}