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
FormSubmissionRequestPreviewRequest Parameters:
NameParameterData TypeRequiredDescription
SubmissionUIDpathGuidNo
KeysbodyList<string>No
FormSubmissionRequestPreviewResponse Parameters:
NameParameterData TypeRequiredDescription
PlanformFormRequestPlanNo
ResponseStatusformResponseStatusNo
FormRequestPlan Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<FormRequestItem>No
KeysformList<string>No
ResignformList<string>No
ResignKeysformList<string>No
ChannelsformstringNo
StageLabelformstringNo
ConsequenceformstringNo
ApplicantformstringNo
StageformstringNo
CanSendformboolNo
RefusalformstringNo
FormRequestItem Parameters:
NameParameterData TypeRequiredDescription
KformstringNo
LformstringNo
TagformstringNo
ToneformstringNo
PreformboolNo
IsSignatureformboolNo
IsSensitiveformboolNo
PiformintNo

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}/request-info/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SubmissionUID":"00000000000000000000000000000000","Keys":["String"]}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}