Foundry API

<back to all web services

GetOrganisationMembershipRequest

Requires Authentication
The following routes are available for this service:
GET/organisations/{OrganisationId}/{UserId}
namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type AccountType =
        | Person = 0
        | Machine = 1

    [<AllowNullLiteral>]
    type OrganisationMembership() = 
        member val UserEmailAddress:String = null with get,set
        member val UserId:String = null with get,set
        member val OrganisationId:String = null with get,set
        member val AccountType:AccountType = new AccountType() with get,set
        member val IsOwner:Boolean = new Boolean() with get,set
        member val IsConfirmed:Boolean = new Boolean() with get,set
        member val Roles:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type GetOrganisationMembershipResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Membership:OrganisationMembership = null with get,set

    [<AllowNullLiteral>]
    type GetOrganisationMembershipRequest() = 
        inherit GetOperationTenanted<GetOrganisationMembershipResponse>()
        member val UserId:String = null with get,set

    [<AllowNullLiteral>]
    type GetOperationTenanted<'TResponse>() = 
        inherit GetOperationUnTenanted<TResponse>()
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type GetOperationUnTenanted<'TResponse>() = 
        interface IGet
        member val Embed:String = null with get,set

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