| POST | /v1/forms/submissions/{SubmissionUID}/notes |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormStageInfo:
id: Optional[str] = None
label: Optional[str] = None
tone: Optional[str] = None
kind: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormPerson:
agent_id: int = 0
agent_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormRecordFile:
attachment_id: Optional[str] = None
name: Optional[str] = None
kind: Optional[str] = None
size: Optional[str] = None
sensitive: bool = False
locked: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormRecordSig:
pending: bool = False
mode: Optional[str] = None
signer_name: Optional[str] = None
role: Optional[str] = None
record_id: int = 0
image_hash: Optional[str] = None
document_digest: Optional[str] = None
ip: Optional[str] = None
browser: Optional[str] = None
consent_stored: bool = False
signed_text: Optional[str] = None
has_image: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormRecordRow:
k: Optional[str] = None
l: Optional[str] = None
t: Optional[str] = None
kind: Optional[str] = None
v: Optional[str] = None
sensitive: bool = False
can_reveal: bool = False
locked: bool = False
files: List[FormRecordFile] = field(default_factory=list)
no_files: bool = False
sig: Optional[FormRecordSig] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormRecordSection:
title: Optional[str] = None
rows: List[FormRecordRow] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormRecordDoc:
name: Optional[str] = None
ok: bool = False
tag: Optional[str] = None
tone: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormRecordComputed:
l: Optional[str] = None
v: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormRecordEvent:
who: Optional[str] = None
x: Optional[str] = None
t: Optional[str] = None
at: datetime.datetime = datetime.datetime(1, 1, 1)
dot: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormSubmissionRecord:
submission_u_i_d: Optional[str] = None
form_u_i_d: Optional[str] = None
form_name: Optional[str] = None
noun: Optional[str] = None
number: Optional[str] = None
applicant_name: Optional[str] = None
stage: Optional[FormStageInfo] = None
tags: List[str] = field(default_factory=list)
assignee_agent_id: Optional[int] = None
assignee_name: Optional[str] = None
branch_name: Optional[str] = None
submitted_at: Optional[datetime.datetime] = None
version_no: int = 0
current_version_no: int = 0
email: Optional[str] = None
phone: Optional[str] = None
contact_name: Optional[str] = None
meta: Optional[str] = None
stages: List[FormStageInfo] = field(default_factory=list)
moves: List[FormStageInfo] = field(default_factory=list)
people: List[FormPerson] = field(default_factory=list)
can_edit: bool = False
can_sensitive: bool = False
sections: List[FormRecordSection] = field(default_factory=list)
docs: List[FormRecordDoc] = field(default_factory=list)
doc_count: Optional[str] = None
computed: List[FormRecordComputed] = field(default_factory=list)
timeline: List[FormRecordEvent] = field(default_factory=list)
notes: List[FormRecordEvent] = field(default_factory=list)
audit: List[FormRecordEvent] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormSubmissionRecordResponse:
record: Optional[FormSubmissionRecord] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormSubmissionNoteRequest:
submission_u_i_d: Optional[str] = None
text: Optional[str] = None
Python FormSubmissionNoteRequest DTOs
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
}
}
}