Foundry API

<back to all web services

GetOrganisationMembershipRequest

Requires Authentication
The following routes are available for this service:
GET/organisations/{OrganisationId}/{UserId}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Organisations;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces.Resources;

namespace Application.Interfaces.Resources
{
    public enum AccountType
    {
        Person,
        Machine,
    }

    public partial class OrganisationMembership
        : IIdentifiableResource
    {
        public OrganisationMembership()
        {
            Roles = new List<string>{};
        }

        public virtual string UserEmailAddress { get; set; }
        public virtual string UserId { get; set; }
        public virtual string OrganisationId { get; set; }
        public virtual AccountType AccountType { get; set; }
        public virtual bool IsOwner { get; set; }
        public virtual bool IsConfirmed { get; set; }
        public virtual List<string> Roles { get; set; }
        public virtual string Id { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class GetOperationTenanted<TResponse>
        : GetOperationUnTenanted<TResponse>, ITenantedRequest
    {
        public virtual string OrganisationId { get; set; }
    }

    public partial class GetOperationUnTenanted<TResponse>
        : IHasGetOptions, IGet
    {
        public virtual string Embed { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Organisations
{
    public partial class GetOrganisationMembershipRequest
        : GetOperationTenanted<GetOrganisationMembershipResponse>
    {
        public virtual string UserId { get; set; }
    }

    public partial class GetOrganisationMembershipResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual OrganisationMembership Membership { get; set; }
    }

}

C# 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
	}
}