Foundry API

UpdateProfileRequest

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

import java.math.*
import java.util.*
import net.servicestack.client.*


open class UpdateProfileRequest : PutPatchOperationUnTenanted<UpdateProfileResponse>()
{
    var id:String? = null
    var firstName:String? = null
    var lastName:String? = null
    var displayName:String? = null
    var phoneNumber:String? = null
    var timezone:String? = null
}

open class PutPatchOperationUnTenanted<TResponse> : IPatch, IPut
{
}

open class UpdateProfileResponse
{
    var responseStatus:ResponseStatus? = null
    var profile:Profile? = null
}

open class Profile : ProfileBasic()
{
    var defaultOrganisationId:String? = null
}

open class ProfileBasic : IIdentifiableResource
{
    var name:PersonName? = null
    var displayName:String? = null
    var emailAddress:String? = null
    var phoneNumber:String? = null
    var timezone:String? = null
    var id:String? = null
}

open class PersonName
{
    var firstName:String? = null
    var lastName:String? = null
}

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