Trendsic Platform Service

<back to all web services

FormSubmissionDecidePreviewRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/{SubmissionUID}/decide/preview
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class FormSubmissionDecidePreviewRequest
{
    open var SubmissionUID:UUID? = null
    open var Outcome:String? = null
    open var Reason:String? = null
    open var Note:String? = null
}

open class FormSubmissionDecidePreviewResponse
{
    open var Plan:FormDecisionPlan? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class FormDecisionPlan
{
    open var Who:String? = null
    open var Stage:String? = null
    open var Choices:ArrayList<FormDecisionChoice> = ArrayList<FormDecisionChoice>()
    open var Outcome:String? = null
    open var Reasons:ArrayList<String> = ArrayList<String>()
    open var Reason:String? = null
    open var NeedSig:Boolean? = null
    open var SignerName:String? = null
    open var SignerRefusal:String? = null
    open var Effects:ArrayList<FormDecisionEffect> = ArrayList<FormDecisionEffect>()
    open var Block:String? = null
    open var GoLabel:String? = null
    open var GoCls:String? = null
    open var CanDecide:Boolean? = null
    open var Refusal:String? = null
}

open class FormDecisionChoice
{
    open var Id:String? = null
    open var Label:String? = null
}

open class FormDecisionEffect
{
    open var Kind:String? = null
    open var Text:String? = null
    open var Tone:String? = null
}

Kotlin FormSubmissionDecidePreviewRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/forms/submissions/{SubmissionUID}/decide/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SubmissionUID":"00000000000000000000000000000000","Outcome":"String","Reason":"String","Note":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Plan":{"Who":"String","Stage":"String","Choices":[{"Id":"String","Label":"String"}],"Outcome":"String","Reasons":["String"],"Reason":"String","NeedSig":false,"SignerName":"String","SignerRefusal":"String","Effects":[{"Kind":"String","Text":"String","Tone":"String"}],"Block":"String","GoLabel":"String","GoCls":"String","CanDecide":false,"Refusal":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}