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
FormSubmissionDecidePreviewRequest Parameters:
NameParameterData TypeRequiredDescription
SubmissionUIDpathGuidNo
OutcomebodystringNo
ReasonbodystringNo
NotebodystringNo
FormSubmissionDecidePreviewResponse Parameters:
NameParameterData TypeRequiredDescription
PlanformFormDecisionPlanNo
ResponseStatusformResponseStatusNo
FormDecisionPlan Parameters:
NameParameterData TypeRequiredDescription
WhoformstringNo
StageformstringNo
ChoicesformList<FormDecisionChoice>No
OutcomeformstringNo
ReasonsformList<string>No
ReasonformstringNo
NeedSigformboolNo
SignerNameformstringNo
SignerRefusalformstringNo
EffectsformList<FormDecisionEffect>No
BlockformstringNo
GoLabelformstringNo
GoClsformstringNo
CanDecideformboolNo
RefusalformstringNo
FormDecisionChoice Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
LabelformstringNo
FormDecisionEffect Parameters:
NameParameterData TypeRequiredDescription
KindformstringNo
TextformstringNo
ToneformstringNo

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