| POST | /v1/forms/{FormUID}/notices/preview |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FormUID | path | Guid | No | |
| Id | body | string | No | |
| Lang | body | string | No | |
| Channel | body | string | No | |
| Subject | body | string | No | |
| Body | body | string | No | |
| Text | body | string | No | |
| Closing | body | string | No | |
| SubmissionUID | body | Guid? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Subject | form | string | No | |
| Body | form | string | No | |
| Meta | form | string | No | |
| SubmissionUID | form | string | No | |
| Sample | form | bool | No | |
| SampleNote | form | string | No | |
| TextLength | form | int | No | |
| Segments | form | int | No | |
| Wide | form | bool | No | |
| Problems | form | List<string> | No | |
| Samples | form | List<FormInboxCount> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| V | form | string | No | |
| L | form | string | No | |
| N | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
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/jsv
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
}
}
}