Foundry API

UpdateProfileRequest

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

**UpdateProfileRequest** Parameters:
Name	Parameter	Data Type	Required
Id	path	string	No
FirstName	body	string	No
LastName	body	string	No
DisplayName	body	string	No
PhoneNumber	body	string	No
Timezone	body	string	No

**UpdateProfileResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Profile	form	Profile	No

**Profile** Parameters:
Name	Parameter	Data Type	Required	Description
DefaultOrganisationId	form	string	No

**ProfileBasic** Parameters:
Name	Parameter	Data Type	Required
Name	form	PersonName	No
DisplayName	form	string	No
EmailAddress	form	string	No
PhoneNumber	form	string	No
Timezone	form	string	No
Id	form	string	No

**PersonName** Parameters:
Name	Parameter	Data Type	Required	Description
FirstName	form	string	No
LastName	form	string	No

**UpdateProfileResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Profile	form	Profile	No

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: foundrystage-api-app.azurewebsites.net 
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
	}
}