Foundry API

<back to all web services

GetOrganisationMembershipRequest

Requires Authentication
The following routes are available for this service:
GET/organisations/{OrganisationId}/{UserId}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetOrganisationMembershipRequest extends GetOperationTenanted<GetOrganisationMembershipResponse>
    {
        public String userId = null;
        
        public String getUserId() { return userId; }
        public GetOrganisationMembershipRequest setUserId(String value) { this.userId = value; return this; }
    }

    public static class GetOperationTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements ITenantedRequest
    {
        public String organisationId = null;
        
        public String getOrganisationId() { return organisationId; }
        public GetOperationTenanted<TResponse> setOrganisationId(String value) { this.organisationId = value; return this; }
    }

    public static class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
    {
        public String embed = null;
        
        public String getEmbed() { return embed; }
        public GetOperationUnTenanted<TResponse> setEmbed(String value) { this.embed = value; return this; }
    }

    public static class GetOrganisationMembershipResponse
    {
        public ResponseStatus responseStatus = null;
        public OrganisationMembership membership = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetOrganisationMembershipResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public OrganisationMembership getMembership() { return membership; }
        public GetOrganisationMembershipResponse setMembership(OrganisationMembership value) { this.membership = value; return this; }
    }

    public static class OrganisationMembership implements IIdentifiableResource
    {
        public String userEmailAddress = null;
        public String userId = null;
        public String organisationId = null;
        public AccountType accountType = null;
        public Boolean isOwner = null;
        public Boolean isConfirmed = null;
        public ArrayList<String> roles = null;
        public String id = null;
        
        public String getUserEmailAddress() { return userEmailAddress; }
        public OrganisationMembership setUserEmailAddress(String value) { this.userEmailAddress = value; return this; }
        public String getUserId() { return userId; }
        public OrganisationMembership setUserId(String value) { this.userId = value; return this; }
        public String getOrganisationId() { return organisationId; }
        public OrganisationMembership setOrganisationId(String value) { this.organisationId = value; return this; }
        public AccountType getAccountType() { return accountType; }
        public OrganisationMembership setAccountType(AccountType value) { this.accountType = value; return this; }
        public Boolean getIsOwner() { return isOwner; }
        public OrganisationMembership setIsOwner(Boolean value) { this.isOwner = value; return this; }
        public Boolean getIsConfirmed() { return isConfirmed; }
        public OrganisationMembership setIsConfirmed(Boolean value) { this.isConfirmed = value; return this; }
        public ArrayList<String> getRoles() { return roles; }
        public OrganisationMembership setRoles(ArrayList<String> value) { this.roles = value; return this; }
        public String getId() { return id; }
        public OrganisationMembership setId(String value) { this.id = value; return this; }
    }

    public static enum AccountType
    {
        Person,
        Machine;
    }

}

Java 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
	}
}