| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Result | form | string | No | |
| Subject | form | string | No | |
| ToAddresses | form | List<EmailAddress> | No | |
| CcAddresses | form | List<EmailAddress> | No | |
| BccAddresses | form | List<EmailAddress> | No | |
| FromAddress | form | EmailAddress | No | |
| TrialEmailCount | form | int | No | |
| EmailsSent | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DisplayName | form | string | No | |
| Address | form | string | No |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/SendFormsIncompleteEmail HTTP/1.1
Host: notifications.breastcancertrials.org.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"result":"String","subject":"String","toAddresses":[{"displayName":"String","address":"String"}],"ccAddresses":[{"displayName":"String","address":"String"}],"bccAddresses":[{"displayName":"String","address":"String"}],"fromAddress":{"displayName":"String","address":"String"},"trialEmailCount":0,"emailsSent":0}