Foundry API

UpdateProfileRequest

The following routes are available for this service:
PUT,PATCH	/profile/{Id}


export class PutPatchOperationUnTenanted<TResponse> implements IPatch, IPut
{

    public constructor(init?: Partial<PutPatchOperationUnTenanted<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 UpdateProfileResponse
{
    public responseStatus?: ResponseStatus;
    public profile?: Profile;

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

export class UpdateProfileRequest extends PutPatchOperationUnTenanted<UpdateProfileResponse>
{
    public id?: string;
    public firstName?: string;
    public lastName?: string;
    public displayName?: string;
    public phoneNumber?: string;
    public timezone?: string;

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

TypeScript UpdateProfileRequest 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.

PUT /profile/{Id} HTTP/1.1 
Host: staging-api.foundrylab.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	firstName: String,
	lastName: String,
	displayName: String,
	phoneNumber: String,
	timezone: String
}

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: 
	{
		defaultOrganisationId: String,
		name: 
		{
			firstName: String,
			lastName: String
		},
		displayName: String,
		emailAddress: String,
		phoneNumber: String,
		timezone: String,
		id: String
	}
}