Foundry API

GetOrganisationMembershipRequest

The following routes are available for this service:
GET	/organisations/{OrganisationId}/{UserId}

import Foundation
import ServiceStack

public class GetOrganisationMembershipRequest : GetOperationTenanted<GetOrganisationMembershipResponse>
{
    public var userId:String?

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

    private enum CodingKeys : String, CodingKey {
        case userId
    }

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

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

public class GetOperationTenanted<TResponse : Codable> : GetOperationUnTenanted<TResponse>, ITenantedRequest
{
    public var organisationId:String?

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

    private enum CodingKeys : String, CodingKey {
        case organisationId
    }

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

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

public class GetOperationUnTenanted<TResponse : Codable> : IHasGetOptions, IGet, Codable
{
    public var embed:String?

    required public init(){}
}

public class GetOrganisationMembershipResponse : Codable
{
    public var responseStatus:ResponseStatus?
    public var membership:OrganisationMembership?

    required public init(){}
}

public class OrganisationMembership : IIdentifiableResource, Codable
{
    public var userEmailAddress:String?
    public var userId:String?
    public var organisationId:String?
    public var accountType:AccountType?
    public var isOwner:Bool?
    public var isConfirmed:Bool?
    public var roles:[String] = []
    public var id:String?

    required public init(){}
}

public enum AccountType : String, Codable
{
    case Person
    case Machine
}

Swift GetOrganisationMembershipRequest 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.

GET /organisations/{OrganisationId}/{UserId} HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/jsv

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
		}
	},
	membership: 
	{
		userEmailAddress: String,
		userId: String,
		organisationId: String,
		accountType: Person,
		isOwner: False,
		isConfirmed: False,
		roles: 
		[
			String
		],
		id: String
	}
}