| POST | /v1/forms/submissions/{SubmissionUID}/decide |
|---|
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
asked: bool = False
changed: bool = False
prev: Optional[str] = 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 FormRecordRequest:
request_u_i_d: Optional[str] = None
keys: List[str] = field(default_factory=list)
resign: List[str] = field(default_factory=list)
note: Optional[str] = None
by: Optional[str] = None
at: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormRecordDecision:
outcome: Optional[str] = None
tone: Optional[str] = None
reason: Optional[str] = None
note: Optional[str] = None
text: Optional[str] = None
has_counter: bool = False
typed: bool = False
drawn: bool = False
sig_name: Optional[str] = None
sig_meta: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormRecordEarlierDecision:
outcome: Optional[str] = None
tone: Optional[str] = None
reason: Optional[str] = None
note: Optional[str] = None
text: Optional[str] = None
counter: Optional[str] = None
reopened: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormRecordSigEntry:
record_id: int = 0
key: Optional[str] = None
label: Optional[str] = None
role: Optional[str] = None
signer_name: Optional[str] = None
mode: Optional[str] = None
has_image: bool = False
consent_stored: bool = False
replaced: bool = False
counter: bool = False
reopened: bool = False
meta: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormRecordReplacedRow:
k: Optional[str] = None
l: 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)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormRecordReplaced:
request_u_i_d: Optional[str] = None
asked_by: Optional[str] = None
asked_at: Optional[str] = None
answered_at: Optional[str] = None
covering: Optional[str] = None
rows: List[FormRecordReplacedRow] = field(default_factory=list)
@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)
is_test: bool = False
version_text: Optional[str] = None
tenant_name: Optional[str] = None
submitted_iso: Optional[str] = None
open_request: Optional[FormRecordRequest] = None
can_request: bool = False
request_tip: Optional[str] = None
decision: Optional[FormRecordDecision] = None
earlier: List[FormRecordEarlierDecision] = field(default_factory=list)
can_decide: bool = False
decide_tip: Optional[str] = None
move_tip: Optional[str] = None
due_at: Optional[datetime.datetime] = None
overdue: bool = False
age_text: Optional[str] = None
due_text: Optional[str] = None
signatures: List[FormRecordSigEntry] = field(default_factory=list)
replaced: List[FormRecordReplaced] = 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 FormFillReceiptLine:
channel: Optional[str] = None
to: Optional[str] = None
outcome: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormSubmissionRequestInfoResponse(FormSubmissionRecordResponse):
sent: List[FormFillReceiptLine] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormCounterSignature:
mode: Optional[str] = None
name: Optional[str] = None
png: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormSubmissionDecideRequest:
submission_u_i_d: Optional[str] = None
outcome: Optional[str] = None
reason: Optional[str] = None
note: Optional[str] = None
counter: Optional[FormCounterSignature] = None
from_: Optional[str] = field(metadata=config(field_name='from'), default=None)
Python FormSubmissionDecideRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/forms/submissions/{SubmissionUID}/decide HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FormSubmissionDecideRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Counter>
<Mode>String</Mode>
<Name>String</Name>
<Png>String</Png>
</Counter>
<From>String</From>
<Note>String</Note>
<Outcome>String</Outcome>
<Reason>String</Reason>
<SubmissionUID>00000000-0000-0000-0000-000000000000</SubmissionUID>
</FormSubmissionDecideRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FormSubmissionRequestInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Record>
<AgeText>String</AgeText>
<ApplicantName>String</ApplicantName>
<AssigneeAgentId>0</AssigneeAgentId>
<AssigneeName>String</AssigneeName>
<Audit>
<FormRecordEvent>
<At>0001-01-01T00:00:00</At>
<Dot>String</Dot>
<T>String</T>
<Who>String</Who>
<X>String</X>
</FormRecordEvent>
</Audit>
<BranchName>String</BranchName>
<CanDecide>false</CanDecide>
<CanEdit>false</CanEdit>
<CanRequest>false</CanRequest>
<CanSensitive>false</CanSensitive>
<Computed>
<FormRecordComputed>
<L>String</L>
<V>String</V>
</FormRecordComputed>
</Computed>
<ContactName>String</ContactName>
<CurrentVersionNo>0</CurrentVersionNo>
<DecideTip>String</DecideTip>
<Decision>
<Drawn>false</Drawn>
<HasCounter>false</HasCounter>
<Note>String</Note>
<Outcome>String</Outcome>
<Reason>String</Reason>
<SigMeta>String</SigMeta>
<SigName>String</SigName>
<Text>String</Text>
<Tone>String</Tone>
<Typed>false</Typed>
</Decision>
<DocCount>String</DocCount>
<Docs>
<FormRecordDoc>
<Name>String</Name>
<Ok>false</Ok>
<Tag>String</Tag>
<Tone>String</Tone>
</FormRecordDoc>
</Docs>
<DueAt>0001-01-01T00:00:00</DueAt>
<DueText>String</DueText>
<Earlier>
<FormRecordEarlierDecision>
<Counter>String</Counter>
<Note>String</Note>
<Outcome>String</Outcome>
<Reason>String</Reason>
<Reopened>String</Reopened>
<Text>String</Text>
<Tone>String</Tone>
</FormRecordEarlierDecision>
</Earlier>
<Email>String</Email>
<FormName>String</FormName>
<FormUID>00000000-0000-0000-0000-000000000000</FormUID>
<IsTest>false</IsTest>
<Meta>String</Meta>
<MoveTip>String</MoveTip>
<Moves>
<FormStageInfo>
<Id>String</Id>
<Kind>String</Kind>
<Label>String</Label>
<Tone>String</Tone>
</FormStageInfo>
</Moves>
<Notes>
<FormRecordEvent>
<At>0001-01-01T00:00:00</At>
<Dot>String</Dot>
<T>String</T>
<Who>String</Who>
<X>String</X>
</FormRecordEvent>
</Notes>
<Noun>String</Noun>
<Number>String</Number>
<OpenRequest>
<At>String</At>
<By>String</By>
<Keys xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</Keys>
<Note>String</Note>
<RequestUID>00000000-0000-0000-0000-000000000000</RequestUID>
<Resign xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</Resign>
</OpenRequest>
<Overdue>false</Overdue>
<People>
<FormPerson>
<AgentId>0</AgentId>
<AgentName>String</AgentName>
</FormPerson>
</People>
<Phone>String</Phone>
<Replaced>
<FormRecordReplaced>
<AnsweredAt>String</AnsweredAt>
<AskedAt>String</AskedAt>
<AskedBy>String</AskedBy>
<Covering>String</Covering>
<RequestUID>00000000-0000-0000-0000-000000000000</RequestUID>
<Rows>
<FormRecordReplacedRow>
<CanReveal>false</CanReveal>
<Files>
<FormRecordFile>
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<Kind>String</Kind>
<Locked>false</Locked>
<Name>String</Name>
<Sensitive>false</Sensitive>
<Size>String</Size>
</FormRecordFile>
</Files>
<K>String</K>
<Kind>String</Kind>
<L>String</L>
<Locked>false</Locked>
<Sensitive>false</Sensitive>
<V>String</V>
</FormRecordReplacedRow>
</Rows>
</FormRecordReplaced>
</Replaced>
<RequestTip>String</RequestTip>
<Sections>
<FormRecordSection>
<Rows>
<FormRecordRow>
<Asked>false</Asked>
<CanReveal>false</CanReveal>
<Changed>false</Changed>
<Files>
<FormRecordFile>
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<Kind>String</Kind>
<Locked>false</Locked>
<Name>String</Name>
<Sensitive>false</Sensitive>
<Size>String</Size>
</FormRecordFile>
</Files>
<K>String</K>
<Kind>String</Kind>
<L>String</L>
<Locked>false</Locked>
<NoFiles>false</NoFiles>
<Prev>String</Prev>
<Sensitive>false</Sensitive>
<Sig>
<Browser>String</Browser>
<ConsentStored>false</ConsentStored>
<DocumentDigest>String</DocumentDigest>
<HasImage>false</HasImage>
<ImageHash>String</ImageHash>
<Ip>String</Ip>
<Mode>String</Mode>
<Pending>false</Pending>
<RecordId>0</RecordId>
<Role>String</Role>
<SignedText>String</SignedText>
<SignerName>String</SignerName>
</Sig>
<T>String</T>
<V>String</V>
</FormRecordRow>
</Rows>
<Title>String</Title>
</FormRecordSection>
</Sections>
<Signatures>
<FormRecordSigEntry>
<ConsentStored>false</ConsentStored>
<Counter>false</Counter>
<HasImage>false</HasImage>
<Key>String</Key>
<Label>String</Label>
<Meta>String</Meta>
<Mode>String</Mode>
<RecordId>0</RecordId>
<Reopened>false</Reopened>
<Replaced>false</Replaced>
<Role>String</Role>
<SignerName>String</SignerName>
</FormRecordSigEntry>
</Signatures>
<Stage>
<Id>String</Id>
<Kind>String</Kind>
<Label>String</Label>
<Tone>String</Tone>
</Stage>
<Stages>
<FormStageInfo>
<Id>String</Id>
<Kind>String</Kind>
<Label>String</Label>
<Tone>String</Tone>
</FormStageInfo>
</Stages>
<SubmissionUID>00000000-0000-0000-0000-000000000000</SubmissionUID>
<SubmittedAt>0001-01-01T00:00:00</SubmittedAt>
<SubmittedIso>String</SubmittedIso>
<Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Tags>
<TenantName>String</TenantName>
<Timeline>
<FormRecordEvent>
<At>0001-01-01T00:00:00</At>
<Dot>String</Dot>
<T>String</T>
<Who>String</Who>
<X>String</X>
</FormRecordEvent>
</Timeline>
<VersionNo>0</VersionNo>
<VersionText>String</VersionText>
</Record>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Sent>
<FormFillReceiptLine>
<Channel>String</Channel>
<Outcome>String</Outcome>
<To>String</To>
</FormFillReceiptLine>
</Sent>
</FormSubmissionRequestInfoResponse>