Requires the role: | manager |
POST | /organisations/{Id}/members |
---|
import Foundation
import ServiceStack
public class InviteOrganisationMemberRequest : PostOperationUnTenanted<InviteOrganisationMemberResponse>
{
public var id:String?
public var emailAddress:String?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case id
case emailAddress
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
id = try container.decodeIfPresent(String.self, forKey: .id)
emailAddress = try container.decodeIfPresent(String.self, forKey: .emailAddress)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if id != nil { try container.encode(id, forKey: .id) }
if emailAddress != nil { try container.encode(emailAddress, forKey: .emailAddress) }
}
}
public class PostOperationUnTenanted<TResponse : Codable> : IPost, Codable
{
required public init(){}
}
public class InviteOrganisationMemberResponse : Codable
{
public var responseStatus:ResponseStatus?
public var organisation:Organisation?
required public init(){}
}
public class Organisation : IIdentifiableResource, Codable
{
public var displayName:String?
public var owners:[String] = []
public var isDefault:Bool?
public var id:String?
required public init(){}
}
Swift InviteOrganisationMemberRequest DTOs
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 /organisations/{Id}/members HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
emailAddress: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, organisation: { displayName: String, owners: [ String ], isDefault: False, id: String } }