| POST | /v1/forms/submissions/search |
|---|
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 FormInboxRow:
submission_u_i_d: Optional[str] = None
form_u_i_d: Optional[str] = None
form_name: Optional[str] = None
version_no: int = 0
number: Optional[str] = None
applicant_name: Optional[str] = None
stage: Optional[str] = None
stage_label: Optional[str] = None
stage_tone: Optional[str] = None
assignee_agent_id: Optional[int] = None
assignee_name: Optional[str] = None
branch_name: Optional[str] = None
submitted_at: Optional[datetime.datetime] = None
submitted_text: Optional[str] = None
tags: List[str] = field(default_factory=list)
docs_ok: int = 0
docs_need: int = 0
is_test: bool = False
version_text: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormInboxCount:
v: Optional[str] = None
l: Optional[str] = None
n: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormInboxCounts:
stages: List[FormInboxCount] = field(default_factory=list)
assignees: List[FormInboxCount] = field(default_factory=list)
branches: List[FormInboxCount] = field(default_factory=list)
tags: List[FormInboxCount] = field(default_factory=list)
forms: List[FormInboxCount] = field(default_factory=list)
flags: List[FormInboxCount] = field(default_factory=list)
@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 FormFilterOpt:
id: Optional[str] = None
l: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormFilterField:
k: Optional[str] = None
l: Optional[str] = None
t: Optional[str] = None
opts: List[FormFilterOpt] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormSubmissionSearchResponse:
rows: List[FormInboxRow] = field(default_factory=list)
matching: int = 0
scope_total: int = 0
stage_matching: List[FormInboxCount] = field(default_factory=list)
counts: Optional[FormInboxCounts] = None
stages: List[FormStageInfo] = field(default_factory=list)
capped: bool = False
filter_fields: List[FormFilterField] = field(default_factory=list)
tag_options: List[str] = field(default_factory=list)
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormAnswerCond:
f: Optional[str] = None
op: Optional[str] = None
v: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormSubmissionSearchRequest:
form_u_i_d: Optional[str] = None
mode: Optional[str] = None
forms: List[str] = field(default_factory=list)
stages: List[str] = field(default_factory=list)
assignees: List[int] = field(default_factory=list)
branches: List[str] = field(default_factory=list)
tags: List[str] = field(default_factory=list)
search: Optional[str] = None
sort_key: Optional[str] = None
sort_dir: int = 0
skip: int = 0
take: int = 0
conds: List[FormAnswerCond] = field(default_factory=list)
flags: List[str] = field(default_factory=list)
Python FormSubmissionSearchRequest 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/search HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FormSubmissionSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Assignees xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</Assignees>
<Branches xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Branches>
<Conds>
<FormAnswerCond>
<F>String</F>
<Op>String</Op>
<V>String</V>
</FormAnswerCond>
</Conds>
<Flags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Flags>
<FormUID>00000000-0000-0000-0000-000000000000</FormUID>
<Forms xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</Forms>
<Mode>String</Mode>
<Search>String</Search>
<Skip>0</Skip>
<SortDir>0</SortDir>
<SortKey>String</SortKey>
<Stages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Stages>
<Tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Tags>
<Take>0</Take>
</FormSubmissionSearchRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FormSubmissionSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Capped>false</Capped>
<Counts>
<Assignees>
<FormInboxCount>
<L>String</L>
<N>0</N>
<V>String</V>
</FormInboxCount>
</Assignees>
<Branches>
<FormInboxCount>
<L>String</L>
<N>0</N>
<V>String</V>
</FormInboxCount>
</Branches>
<Flags>
<FormInboxCount>
<L>String</L>
<N>0</N>
<V>String</V>
</FormInboxCount>
</Flags>
<Forms>
<FormInboxCount>
<L>String</L>
<N>0</N>
<V>String</V>
</FormInboxCount>
</Forms>
<Stages>
<FormInboxCount>
<L>String</L>
<N>0</N>
<V>String</V>
</FormInboxCount>
</Stages>
<Tags>
<FormInboxCount>
<L>String</L>
<N>0</N>
<V>String</V>
</FormInboxCount>
</Tags>
</Counts>
<FilterFields>
<FormFilterField>
<K>String</K>
<L>String</L>
<Opts>
<FormFilterOpt>
<Id>String</Id>
<L>String</L>
</FormFilterOpt>
</Opts>
<T>String</T>
</FormFilterField>
</FilterFields>
<Matching>0</Matching>
<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>
<Rows>
<FormInboxRow>
<ApplicantName>String</ApplicantName>
<AssigneeAgentId>0</AssigneeAgentId>
<AssigneeName>String</AssigneeName>
<BranchName>String</BranchName>
<DocsNeed>0</DocsNeed>
<DocsOk>0</DocsOk>
<FormName>String</FormName>
<FormUID>00000000-0000-0000-0000-000000000000</FormUID>
<IsTest>false</IsTest>
<Number>String</Number>
<Stage>String</Stage>
<StageLabel>String</StageLabel>
<StageTone>String</StageTone>
<SubmissionUID>00000000-0000-0000-0000-000000000000</SubmissionUID>
<SubmittedAt>0001-01-01T00:00:00</SubmittedAt>
<SubmittedText>String</SubmittedText>
<Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</Tags>
<VersionNo>0</VersionNo>
<VersionText>String</VersionText>
</FormInboxRow>
</Rows>
<ScopeTotal>0</ScopeTotal>
<StageMatching>
<FormInboxCount>
<L>String</L>
<N>0</N>
<V>String</V>
</FormInboxCount>
</StageMatching>
<Stages>
<FormStageInfo>
<Id>String</Id>
<Kind>String</Kind>
<Label>String</Label>
<Tone>String</Tone>
</FormStageInfo>
</Stages>
<TagOptions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TagOptions>
</FormSubmissionSearchResponse>