Foundry API

GetCurrentProfileRequest

The following routes are available for this service:
GET	/profile/current


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

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

export class PersonName
{
    public firstName?: string;
    public lastName?: string;

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

export class ProfileBasic implements IIdentifiableResource
{
    public name?: PersonName;
    public displayName?: string;
    public emailAddress?: string;
    public phoneNumber?: string;
    public timezone?: string;
    public id?: string;

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

export class Profile extends ProfileBasic
{
    public defaultOrganisationId?: string;

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

export class CurrentProfile extends Profile
{
    public isAuthenticated: boolean;
    public roles?: string[];

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

export class GetCurrentProfileResponse
{
    public responseStatus?: ResponseStatus;
    public profile?: CurrentProfile;

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

export class GetCurrentProfileRequest extends GetOperationUnTenanted<GetCurrentProfileResponse>
{

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

TypeScript GetCurrentProfileRequest 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 /profile/current 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
		}
	},
	profile: 
	{
		isAuthenticated: False,
		roles: 
		[
			String
		],
		defaultOrganisationId: String,
		name: 
		{
			firstName: String,
			lastName: String
		},
		displayName: String,
		emailAddress: String,
		phoneNumber: String,
		timezone: String,
		id: String
	}
}