Billiecart API

<back to all web services

DeliverEmailRequest

Requires Authentication
Required role:service
The following routes are available for this service:
POST/emails/deliver
import Foundation
import ServiceStack

public class DeliverEmailRequest : PostOperationUnTenanted<DeliverEmailResponse>
{
    public var message:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case message
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        message = try container.decodeIfPresent(String.self, forKey: .message)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if message != nil { try container.encode(message, forKey: .message) }
    }
}

public class PostOperationUnTenanted<TResponse : Codable> : IPost, Codable
{
    required public init(){}
}

public class DeliverEmailResponse : Codable
{
    public var responseStatus:ResponseStatus?
    public var isDelivered:Bool?

    required public init(){}
}


Swift DeliverEmailRequest DTOs

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 /emails/deliver HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"message":"String"}
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"}},"isDelivered":false}