Trendsic Platform Service

<back to all web services

FormSubmissionRequestPreviewRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/{SubmissionUID}/request-info/preview
import Foundation
import ServiceStack

public class FormSubmissionRequestPreviewRequest : Codable
{
    public var submissionUID:String
    public var keys:[String] = []

    required public init(){}
}

public class FormSubmissionRequestPreviewResponse : Codable
{
    public var plan:FormRequestPlan
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class FormRequestPlan : Codable
{
    public var items:[FormRequestItem] = []
    public var keys:[String] = []
    public var resign:[String] = []
    public var resignKeys:[String] = []
    public var channels:String
    public var stageLabel:String
    public var consequence:String
    public var applicant:String
    public var stage:String
    public var canSend:Bool
    public var refusal:String

    required public init(){}
}

public class FormRequestItem : Codable
{
    public var k:String
    public var l:String
    public var tag:String
    public var tone:String
    public var pre:Bool
    public var isSignature:Bool
    public var isSensitive:Bool
    public var pi:Int

    required public init(){}
}


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