Trendsic Platform Service

<back to all web services

FormSubmissionRecordRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/submissions/{SubmissionUID}
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 FormSubmissionRecordRequest:
    submission_u_i_d: Optional[str] = None

Python FormSubmissionRecordRequest DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/forms/submissions/{SubmissionUID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormSubmissionRecordResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Record>
    <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>
    <CanEdit>false</CanEdit>
    <CanSensitive>false</CanSensitive>
    <Computed>
      <FormRecordComputed>
        <L>String</L>
        <V>String</V>
      </FormRecordComputed>
    </Computed>
    <ContactName>String</ContactName>
    <CurrentVersionNo>0</CurrentVersionNo>
    <DocCount>String</DocCount>
    <Docs>
      <FormRecordDoc>
        <Name>String</Name>
        <Ok>false</Ok>
        <Tag>String</Tag>
        <Tone>String</Tone>
      </FormRecordDoc>
    </Docs>
    <Email>String</Email>
    <FormName>String</FormName>
    <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
    <Meta>String</Meta>
    <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>
    <People>
      <FormPerson>
        <AgentId>0</AgentId>
        <AgentName>String</AgentName>
      </FormPerson>
    </People>
    <Phone>String</Phone>
    <Sections>
      <FormRecordSection>
        <Rows>
          <FormRecordRow>
            <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>
            <NoFiles>false</NoFiles>
            <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>
    <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>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Tags>
    <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>
  </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>
</FormSubmissionRecordResponse>