Billiecart API

<back to all web services

InviteGuestRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/users/invite
import Foundation
import ServiceStack

public class InviteGuestRequest : PostOperationUnTenanted<InviteGuestResponse>
{
    public var email:String?

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

    private enum CodingKeys : String, CodingKey {
        case email
    }

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

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

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

public class InviteGuestResponse : Codable
{
    public var responseStatus:ResponseStatus?
    public var invitation:Invitation?

    required public init(){}
}

public class Invitation : Codable
{
    public var firstName:String?
    public var lastName:String?
    public var email:String?
    public var id:String?

    required public init(){}
}


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

{"email":"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"}},"invitation":{"firstName":"String","lastName":"String","email":"String","id":"String"}}