Trendsic Platform Service

<back to all web services

FormFillReplyRequest

The following routes are available for this service:
POST/v1/formfill/status/{Token}/request/send
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 FormFillStage:
    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 FormFillStageSeen:
    id: Optional[str] = None
    at: datetime.datetime = datetime.datetime(1, 1, 1)


@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 FormFillStatusResponse:
    number: Optional[str] = None
    form_name: Optional[str] = None
    noun: Optional[str] = None
    tenant_name: Optional[str] = None
    stage: Optional[str] = None
    stage_kind: Optional[str] = None
    stages: List[FormFillStage] = field(default_factory=list)
    seen: List[FormFillStageSeen] = field(default_factory=list)
    submitted_at: Optional[datetime.datetime] = None
    receipt: List[FormFillReceiptLine] = field(default_factory=list)
    can_withdraw: bool = False
    lang: Optional[str] = None
    noun_es: Optional[str] = None
    has_request: bool = False
    request_note: Optional[str] = None
    outcome: Optional[str] = None
    decision_reason: Optional[str] = None
    decision_note: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormFillFieldError:
    k: Optional[str] = None
    msg: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormFillReplyResponse:
    sent: bool = False
    status: Optional[FormFillStatusResponse] = None
    errors: List[FormFillFieldError] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormFillReplyRequest:
    token: Optional[str] = None
    request_u_i_d: Optional[str] = None
    answers_json: Optional[str] = None
    lang: Optional[str] = None

Python FormFillReplyRequest 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.

POST /v1/formfill/status/{Token}/request/send HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormFillReplyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AnswersJson>String</AnswersJson>
  <Lang>String</Lang>
  <RequestUID>String</RequestUID>
  <Token>String</Token>
</FormFillReplyRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormFillReplyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Errors>
    <FormFillFieldError>
      <K>String</K>
      <Msg>String</Msg>
    </FormFillFieldError>
  </Errors>
  <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>false</Sent>
  <Status>
    <CanWithdraw>false</CanWithdraw>
    <DecisionNote>String</DecisionNote>
    <DecisionReason>String</DecisionReason>
    <FormName>String</FormName>
    <HasRequest>false</HasRequest>
    <Lang>String</Lang>
    <Noun>String</Noun>
    <NounEs>String</NounEs>
    <Number>String</Number>
    <Outcome>String</Outcome>
    <Receipt>
      <FormFillReceiptLine>
        <Channel>String</Channel>
        <Outcome>String</Outcome>
        <To>String</To>
      </FormFillReceiptLine>
    </Receipt>
    <RequestNote>String</RequestNote>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <Seen>
      <FormFillStageSeen>
        <At>0001-01-01T00:00:00</At>
        <Id>String</Id>
      </FormFillStageSeen>
    </Seen>
    <Stage>String</Stage>
    <StageKind>String</StageKind>
    <Stages>
      <FormFillStage>
        <Id>String</Id>
        <Kind>String</Kind>
        <Label>String</Label>
        <Tone>String</Tone>
      </FormFillStage>
    </Stages>
    <SubmittedAt>0001-01-01T00:00:00</SubmittedAt>
    <TenantName>String</TenantName>
  </Status>
</FormFillReplyResponse>