Foundry API

<back to all web services

ChangeEmailAddressRequest

Requires Authentication
The following routes are available for this service:
PUT,PATCH/profile/{Id}/email
import 'package:servicestack/servicestack.dart';

abstract class PutPatchOperationUnTenanted<TResponse> implements IPatch, IPut
{
    PutPatchOperationUnTenanted();
    PutPatchOperationUnTenanted.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "PutPatchOperationUnTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

class PersonName implements IConvertible
{
    String? firstName;
    String? lastName;

    PersonName({this.firstName,this.lastName});
    PersonName.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        firstName = json['firstName'];
        lastName = json['lastName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'firstName': firstName,
        'lastName': lastName
    };

    getTypeName() => "PersonName";
    TypeContext? context = _ctx;
}

class ProfileBasic implements IIdentifiableResource, IConvertible
{
    PersonName? name;
    String? displayName;
    String? emailAddress;
    String? phoneNumber;
    String? timezone;
    String? id;

    ProfileBasic({this.name,this.displayName,this.emailAddress,this.phoneNumber,this.timezone,this.id});
    ProfileBasic.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        name = JsonConverters.fromJson(json['name'],'PersonName',context!);
        displayName = json['displayName'];
        emailAddress = json['emailAddress'];
        phoneNumber = json['phoneNumber'];
        timezone = json['timezone'];
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'name': JsonConverters.toJson(name,'PersonName',context!),
        'displayName': displayName,
        'emailAddress': emailAddress,
        'phoneNumber': phoneNumber,
        'timezone': timezone,
        'id': id
    };

    getTypeName() => "ProfileBasic";
    TypeContext? context = _ctx;
}

class Profile extends ProfileBasic implements IConvertible
{
    String? defaultOrganisationId;

    Profile({this.defaultOrganisationId});
    Profile.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        defaultOrganisationId = json['defaultOrganisationId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'defaultOrganisationId': defaultOrganisationId
    });

    getTypeName() => "Profile";
    TypeContext? context = _ctx;
}

class UpdateProfileResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    Profile? profile;

    UpdateProfileResponse({this.responseStatus,this.profile});
    UpdateProfileResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        profile = JsonConverters.fromJson(json['profile'],'Profile',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'profile': JsonConverters.toJson(profile,'Profile',context!)
    };

    getTypeName() => "UpdateProfileResponse";
    TypeContext? context = _ctx;
}

class ChangeEmailAddressRequest extends PutPatchOperationUnTenanted<UpdateProfileResponse> implements IConvertible
{
    String? id;
    String? emailAddress;

    ChangeEmailAddressRequest({this.id,this.emailAddress});
    ChangeEmailAddressRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        id = json['id'];
        emailAddress = json['emailAddress'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'id': id,
        'emailAddress': emailAddress
    });

    getTypeName() => "ChangeEmailAddressRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'PutPatchOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'PersonName': TypeInfo(TypeOf.Class, create:() => PersonName()),
    'ProfileBasic': TypeInfo(TypeOf.Class, create:() => ProfileBasic()),
    'Profile': TypeInfo(TypeOf.Class, create:() => Profile()),
    'UpdateProfileResponse': TypeInfo(TypeOf.Class, create:() => UpdateProfileResponse()),
    'ChangeEmailAddressRequest': TypeInfo(TypeOf.Class, create:() => ChangeEmailAddressRequest()),
});

Dart 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>