Foundry API

GetOrganisationMembershipRequest

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


export class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
    public embed?: string;

    public constructor(init?: Partial<GetOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}

export class GetOperationTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

    public constructor(init?: Partial<GetOperationTenanted<TResponse>>) { super(init); (Object as any).assign(this, init); }
}

export enum AccountType
{
    Person = 'Person',
    Machine = 'Machine',
}

export class OrganisationMembership implements IIdentifiableResource
{
    public userEmailAddress?: string;
    public userId?: string;
    public organisationId?: string;
    public accountType: AccountType;
    public isOwner: boolean;
    public isConfirmed: boolean;
    public roles?: string[];
    public id?: string;

    public constructor(init?: Partial<OrganisationMembership>) { (Object as any).assign(this, init); }
}

export class GetOrganisationMembershipResponse
{
    public responseStatus?: ResponseStatus;
    public membership?: OrganisationMembership;

    public constructor(init?: Partial<GetOrganisationMembershipResponse>) { (Object as any).assign(this, init); }
}

export class GetOrganisationMembershipRequest extends GetOperationTenanted<GetOrganisationMembershipResponse>
{
    public userId?: string;

    public constructor(init?: Partial<GetOrganisationMembershipRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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: staging-api.foundrylab.com 
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
	}
}