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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"SubmissionUID":"00000000000000000000000000000000","Keys":["String"]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Plan":{"Items":[{"K":"String","L":"String","Tag":"String","Tone":"String","Pre":false,"IsSignature":false,"IsSensitive":false,"Pi":0}],"Keys":["String"],"Resign":["String"],"ResignKeys":["String"],"Channels":"String","StageLabel":"String","Consequence":"String","Applicant":"String","Stage":"String","CanSend":false,"Refusal":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}