Foundry API

ChangeEmailAddressRequest

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


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 ChangeEmailAddressRequest extends PutPatchOperationUnTenanted<UpdateProfileResponse>
{
    public id?: string;
    public emailAddress?: string;

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

TypeScript ChangeEmailAddressRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: foundrystage-api-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ChangeEmailAddressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Profile">
  <EmailAddress>String</EmailAddress>
  <Id>String</Id>
</ChangeEmailAddressRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Profile">
  <Profile xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:DisplayName>String</d2p1:DisplayName>
    <d2p1:EmailAddress>String</d2p1:EmailAddress>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:Name>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:LastName>String</d2p1:LastName>
    </d2p1:Name>
    <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
    <d2p1:Timezone>String</d2p1:Timezone>
    <d2p1:DefaultOrganisationId>String</d2p1:DefaultOrganisationId>
  </Profile>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</UpdateProfileResponse>