Trendsic Platform Service

<back to all web services

FormSubmissionDecideRequest

Requires Authentication
The following routes are available for this service:
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 .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}/decide HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	SubmissionUID: 00000000000000000000000000000000,
	Outcome: String,
	Reason: String,
	Note: String,
	Counter: 
	{
		Mode: String,
		Name: String,
		Png: String
	},
	From: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Sent: 
	[
		{
			Channel: String,
			To: String,
			Outcome: String
		}
	],
	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
						},
						Asked: False,
						Changed: False,
						Prev: String
					}
				]
			}
		],
		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
			}
		],
		IsTest: False,
		VersionText: String,
		TenantName: String,
		SubmittedIso: String,
		OpenRequest: 
		{
			RequestUID: 00000000000000000000000000000000,
			Keys: 
			[
				String
			],
			Resign: 
			[
				String
			],
			Note: String,
			By: String,
			At: String
		},
		CanRequest: False,
		RequestTip: String,
		Decision: 
		{
			Outcome: String,
			Tone: String,
			Reason: String,
			Note: String,
			Text: String,
			HasCounter: False,
			Typed: False,
			Drawn: False,
			SigName: String,
			SigMeta: String
		},
		Earlier: 
		[
			{
				Outcome: String,
				Tone: String,
				Reason: String,
				Note: String,
				Text: String,
				Counter: String,
				Reopened: String
			}
		],
		CanDecide: False,
		DecideTip: String,
		MoveTip: String,
		DueAt: 0001-01-01,
		Overdue: False,
		AgeText: String,
		DueText: String,
		Signatures: 
		[
			{
				RecordId: 0,
				Key: String,
				Label: String,
				Role: String,
				SignerName: String,
				Mode: String,
				HasImage: False,
				ConsentStored: False,
				Replaced: False,
				Counter: False,
				Reopened: False,
				Meta: String
			}
		],
		Replaced: 
		[
			{
				RequestUID: 00000000000000000000000000000000,
				AskedBy: String,
				AskedAt: String,
				AnsweredAt: String,
				Covering: String,
				Rows: 
				[
					{
						K: String,
						L: String,
						Kind: String,
						V: String,
						Sensitive: False,
						CanReveal: False,
						Locked: False,
						Files: 
						[
							{
								AttachmentId: 00000000000000000000000000000000,
								Name: String,
								Kind: String,
								Size: String,
								Sensitive: False,
								Locked: False
							}
						]
					}
				]
			}
		]
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}