Platform API

<back to all web services

SwitchProfile

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

export class SettingModel
{
    public SettingId: string;
    public SettingName: string;
    public SettingValue: string;

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

export class UpdateQuadrantResponse
{
    public PerspectiveSessionId: string;
    public Settings: SettingModel[];
    public Permissions: string[];
    public ResponseStatus: ResponseStatus;

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

/** @description 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")
export class SwitchProfile
{
    /** @description Id of the user profile to switch to. */
    // @ApiMember(Description="Id of the user profile to switch to.", Name="UserProfileId")
    public UserProfileId: string;

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

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

TypeScript 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
		}
	}
}