Foundry API

ChangeEmailAddressRequest

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PutPatchOperationUnTenanted(Generic[TResponse], IReturn[TResponse], IPatch, IPut):
    @staticmethod
    def response_type(): return TResponse


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PersonName:
    first_name: Optional[str] = None
    last_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProfileBasic(IIdentifiableResource):
    name: Optional[PersonName] = None
    display_name: Optional[str] = None
    email_address: Optional[str] = None
    phone_number: Optional[str] = None
    timezone: Optional[str] = None
    id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Profile(ProfileBasic):
    default_organisation_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateProfileResponse:
    response_status: Optional[ResponseStatus] = None
    profile: Optional[Profile] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ChangeEmailAddressRequest(PutPatchOperationUnTenanted[UpdateProfileResponse]):
    id: Optional[str] = None
    email_address: Optional[str] = None

Python ChangeEmailAddressRequest 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}/email HTTP/1.1 
Host: staging-api.foundrylab.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	emailAddress: 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
	}
}