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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type FormRequestItem() = 
        member val K:String = null with get,set
        member val L:String = null with get,set
        member val Tag:String = null with get,set
        member val Tone:String = null with get,set
        member val Pre:Boolean = new Boolean() with get,set
        member val IsSignature:Boolean = new Boolean() with get,set
        member val IsSensitive:Boolean = new Boolean() with get,set
        member val Pi:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type FormRequestPlan() = 
        member val Items:ResizeArray<FormRequestItem> = new ResizeArray<FormRequestItem>() with get,set
        member val Keys:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Resign:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val ResignKeys:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Channels:String = null with get,set
        member val StageLabel:String = null with get,set
        member val Consequence:String = null with get,set
        member val Applicant:String = null with get,set
        member val Stage:String = null with get,set
        member val CanSend:Boolean = new Boolean() with get,set
        member val Refusal:String = null with get,set

    [<AllowNullLiteral>]
    type FormSubmissionRequestPreviewResponse() = 
        member val Plan:FormRequestPlan = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type FormSubmissionRequestPreviewRequest() = 
        member val SubmissionUID:Guid = new Guid() with get,set
        member val Keys:ResizeArray<String> = new ResizeArray<String>() with get,set

F# 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"}}}