Foundry API

<back to all web services

GetCurrentProfileRequest

The following routes are available for this service:
GET/profile/current
import 'package:servicestack/servicestack.dart';

abstract class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
    String? embed;

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

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

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

    getTypeName() => "GetOperationUnTenanted<$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 CurrentProfile extends Profile implements IConvertible
{
    bool? isAuthenticated;
    List<String>? roles;

    CurrentProfile({this.isAuthenticated,this.roles});
    CurrentProfile.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        isAuthenticated = json['isAuthenticated'];
        roles = JsonConverters.fromJson(json['roles'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'isAuthenticated': isAuthenticated,
        'roles': JsonConverters.toJson(roles,'List<String>',context!)
    });

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

class GetCurrentProfileResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    CurrentProfile? profile;

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

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

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

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

class GetCurrentProfileRequest extends GetOperationUnTenanted<GetCurrentProfileResponse> implements IConvertible
{
    GetCurrentProfileRequest();
    GetCurrentProfileRequest.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "GetCurrentProfileRequest";
    TypeContext? context = _ctx;
}

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

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

GET /profile/current HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/jsv
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: 
	{
		isAuthenticated: False,
		roles: 
		[
			String
		],
		defaultOrganisationId: String,
		name: 
		{
			firstName: String,
			lastName: String
		},
		displayName: String,
		emailAddress: String,
		phoneNumber: String,
		timezone: String,
		id: String
	}
}