Platform API

<back to all web services

SwitchProfile

Switch to the specified profile - create a new session, retrieve settings and return new JWT Token

import 'package:servicestack/servicestack.dart';

class SettingModel implements IConvertible
{
    String? SettingId;
    String? SettingName;
    String? SettingValue;

    SettingModel({this.SettingId,this.SettingName,this.SettingValue});
    SettingModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'SettingId': SettingId,
        'SettingName': SettingName,
        'SettingValue': SettingValue
    };

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

class UpdateQuadrantResponse implements IConvertible
{
    String? PerspectiveSessionId;
    List<SettingModel>? Settings;
    List<String>? Permissions;
    ResponseStatus? ResponseStatus;

    UpdateQuadrantResponse({this.PerspectiveSessionId,this.Settings,this.Permissions,this.ResponseStatus});
    UpdateQuadrantResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        PerspectiveSessionId = json['PerspectiveSessionId'];
        Settings = JsonConverters.fromJson(json['Settings'],'List<SettingModel>',context!);
        Permissions = JsonConverters.fromJson(json['Permissions'],'List<String>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'PerspectiveSessionId': PerspectiveSessionId,
        'Settings': JsonConverters.toJson(Settings,'List<SettingModel>',context!),
        'Permissions': JsonConverters.toJson(Permissions,'List<String>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

/**
* Switch to the specified profile - create a new session, retrieve settings and return new JWT Token
*/
// @Api(Description="Switch to the specified profile - create a new session, retrieve settings and return new JWT Token")
class SwitchProfile implements IConvertible
{
    /**
    * Id of the user profile to switch to.
    */
    // @ApiMember(Description="Id of the user profile to switch to.", Name="UserProfileId")
    String? UserProfileId;

    /**
    * Has 'Remember Me' option been selected?
    */
    // @ApiMember(Description="Has 'Remember Me' option been selected?", Name="IsPersistent")
    bool? IsPersistent;

    SwitchProfile({this.UserProfileId,this.IsPersistent});
    SwitchProfile.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'SettingModel': TypeInfo(TypeOf.Class, create:() => SettingModel()),
    'UpdateQuadrantResponse': TypeInfo(TypeOf.Class, create:() => UpdateQuadrantResponse()),
    'List<SettingModel>': TypeInfo(TypeOf.Class, create:() => <SettingModel>[]),
    'SwitchProfile': TypeInfo(TypeOf.Class, create:() => SwitchProfile()),
});

Dart SwitchProfile DTOs

POST /api/profiles/{UserProfileId}/switch/token HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	IsPersistent: False
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Settings: 
	[
		{
			SettingName: String,
			SettingValue: String
		}
	],
	Permissions: 
	[
		00000000-0000-0000-0000-000000000000
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}