Platform API

<back to all web services

SwitchProfile

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

Requires Authentication
The following routes are available for this service:
All Verbs/api/profiles/{UserProfileId}/switch/token
All Verbs/api/profiles/{UserProfileId}/switch
import Foundation
import ServiceStack

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

    /**
    * Has 'Remember Me' option been selected?
    */
    // @ApiMember(Description="Has 'Remember Me' option been selected?", Name="IsPersistent")
    public var isPersistent:Bool

    required public init(){}
}

public class UpdateQuadrantResponse : Codable
{
    public var perspectiveSessionId:String
    public var settings:[SettingModel]
    public var permissions:[String]
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class SettingModel : Codable
{
    public var settingId:String
    public var settingName:String
    public var settingValue:String

    required public init(){}
}


Swift SwitchProfile 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.

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