BctNotification

<back to all web services

SendFormsIncompleteEmail

Requires Authentication
import Foundation
import ServiceStack

public class SendFormsIncompleteEmail : IPost, Codable
{
    required public init(){}
}

public class SendFormsIncompleteEmailResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var result:String
    public var subject:String
    public var toAddresses:[EmailAddress] = []
    public var ccAddresses:[EmailAddress] = []
    public var bccAddresses:[EmailAddress] = []
    public var fromAddress:EmailAddress
    public var trialEmailCount:Int
    public var emailsSent:Int

    required public init(){}
}

public class EmailAddress : Codable
{
    public var displayName:String
    public var address:String

    required public init(){}
}


Swift SendFormsIncompleteEmail DTOs

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

HTTP + CSV

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

POST /csv/reply/SendFormsIncompleteEmail HTTP/1.1 
Host: notifications.breastcancertrials.org.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{}
HTTP/1.1 200 OK
Content-Type: text/csv
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}