Trendsic Platform Service

<back to all web services

FormNoticePreviewRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/{FormUID}/notices/preview
FormNoticePreviewRequest Parameters:
NameParameterData TypeRequiredDescription
FormUIDpathGuidNo
IdbodystringNo
LangbodystringNo
ChannelbodystringNo
SubjectbodystringNo
BodybodystringNo
TextbodystringNo
ClosingbodystringNo
SubmissionUIDbodyGuid?No
FormNoticePreviewResponse Parameters:
NameParameterData TypeRequiredDescription
SubjectformstringNo
BodyformstringNo
MetaformstringNo
SubmissionUIDformstringNo
SampleformboolNo
SampleNoteformstringNo
TextLengthformintNo
SegmentsformintNo
WideformboolNo
ProblemsformList<string>No
SamplesformList<FormInboxCount>No
ResponseStatusformResponseStatusNo
FormInboxCount Parameters:
NameParameterData TypeRequiredDescription
VformstringNo
LformstringNo
NformintNo

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

HTTP + OTHER

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

POST /v1/forms/{FormUID}/notices/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"FormUID":"00000000000000000000000000000000","Id":"String","Lang":"String","Channel":"String","Subject":"String","Body":"String","Text":"String","Closing":"String","SubmissionUID":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Subject":"String","Body":"String","Meta":"String","SubmissionUID":"String","Sample":false,"SampleNote":"String","TextLength":0,"Segments":0,"Wide":false,"Problems":["String"],"Samples":[{"V":"String","L":"String","N":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}