| POST | /v1/forms/submissions/{SubmissionUID}/request-info/preview |
|---|
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 FormRequestItem:
k: Optional[str] = None
l: Optional[str] = None
tag: Optional[str] = None
tone: Optional[str] = None
pre: bool = False
is_signature: bool = False
is_sensitive: bool = False
pi: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormRequestPlan:
items: List[FormRequestItem] = field(default_factory=list)
keys: List[str] = field(default_factory=list)
resign: List[str] = field(default_factory=list)
resign_keys: List[str] = field(default_factory=list)
channels: Optional[str] = None
stage_label: Optional[str] = None
consequence: Optional[str] = None
applicant: Optional[str] = None
stage: Optional[str] = None
can_send: bool = False
refusal: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormSubmissionRequestPreviewResponse:
plan: Optional[FormRequestPlan] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormSubmissionRequestPreviewRequest:
submission_u_i_d: Optional[str] = None
keys: List[str] = field(default_factory=list)
Python FormSubmissionRequestPreviewRequest 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}/request-info/preview HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FormSubmissionRequestPreviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Keys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Keys>
<SubmissionUID>00000000-0000-0000-0000-000000000000</SubmissionUID>
</FormSubmissionRequestPreviewRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FormSubmissionRequestPreviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Plan>
<Applicant>String</Applicant>
<CanSend>false</CanSend>
<Channels>String</Channels>
<Consequence>String</Consequence>
<Items>
<FormRequestItem>
<IsSensitive>false</IsSensitive>
<IsSignature>false</IsSignature>
<K>String</K>
<L>String</L>
<Pi>0</Pi>
<Pre>false</Pre>
<Tag>String</Tag>
<Tone>String</Tone>
</FormRequestItem>
</Items>
<Keys xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Keys>
<Refusal>String</Refusal>
<Resign xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Resign>
<ResignKeys xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</ResignKeys>
<Stage>String</Stage>
<StageLabel>String</StageLabel>
</Plan>
<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>
</FormSubmissionRequestPreviewResponse>