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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


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

    /**
    * Has 'Remember Me' option been selected?
    */
    @ApiMember(Description="Has 'Remember Me' option been selected?", Name="IsPersistent")
    open var IsPersistent:Boolean? = null
}

open class UpdateQuadrantResponse
{
    open var PerspectiveSessionId:UUID? = null
    open var Settings:ArrayList<SettingModel>? = null
    open var Permissions:ArrayList<UUID>? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class SettingModel
{
    open var SettingId:UUID? = null
    open var SettingName:String? = null
    open var SettingValue:String? = null
}

Kotlin SwitchProfile DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"UserProfileId":"00000000-0000-0000-0000-000000000000","IsPersistent":false}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"PerspectiveSessionId":"00000000-0000-0000-0000-000000000000","Settings":[{"SettingId":"00000000-0000-0000-0000-000000000000","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"}}}