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 Foundation
import ServiceStack

public class FormFillReplyRequest : Codable
{
    public var token:String
    public var requestUID:String
    public var answersJson:String
    public var lang:String

    required public init(){}
}

public class FormFillReplyResponse : Codable
{
    public var sent:Bool
    public var status:FormFillStatusResponse
    public var errors:[FormFillFieldError] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class FormFillStatusResponse : Codable
{
    public var number:String
    public var formName:String
    public var noun:String
    public var tenantName:String
    public var stage:String
    public var stageKind:String
    public var stages:[FormFillStage] = []
    public var seen:[FormFillStageSeen] = []
    public var submittedAt:Date?
    public var receipt:[FormFillReceiptLine] = []
    public var canWithdraw:Bool
    public var lang:String
    public var nounEs:String
    public var hasRequest:Bool
    public var requestNote:String
    public var outcome:String
    public var decisionReason:String
    public var decisionNote:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class FormFillStage : Codable
{
    public var id:String
    public var label:String
    public var tone:String
    public var kind:String

    required public init(){}
}

public class FormFillStageSeen : Codable
{
    public var id:String
    public var at:Date

    required public init(){}
}

public class FormFillReceiptLine : Codable
{
    public var channel:String
    public var to:String
    public var outcome:String

    required public init(){}
}

public class FormFillFieldError : Codable
{
    public var k:String
    public var msg:String

    required public init(){}
}


Swift 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>