Foundry API

InviteOrganisationMemberRequest

The following routes are available for this service:
POST	/organisations/{Id}/members

import Foundation
import ServiceStack

public class InviteOrganisationMemberRequest : PostOperationUnTenanted<InviteOrganisationMemberResponse>
{
    public var id:String?
    public var userId:String?
    public var userEmailAddress:String?
    public var role:String?

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

    private enum CodingKeys : String, CodingKey {
        case id
        case userId
        case userEmailAddress
        case role
    }

    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)
        userId = try container.decodeIfPresent(String.self, forKey: .userId)
        userEmailAddress = try container.decodeIfPresent(String.self, forKey: .userEmailAddress)
        role = try container.decodeIfPresent(String.self, forKey: .role)
    }

    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 userId != nil { try container.encode(userId, forKey: .userId) }
        if userEmailAddress != nil { try container.encode(userEmailAddress, forKey: .userEmailAddress) }
        if role != nil { try container.encode(role, forKey: .role) }
    }
}

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?
    public var forceTwoFactor:Bool?

    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

HTTP + 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.foundrylab.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	userId: String,
	userEmailAddress: String,
	role: 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,
		forceTwoFactor: False
	}
}