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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Subtle.Canvara.WebAPIModel.Models

Namespace Global

    Namespace Eros.Subtle.Canvara.WebAPIModel.Models

        Public Partial Class SettingModel
            Public Overridable Property SettingId As Guid
            Public Overridable Property SettingName As String
            Public Overridable Property SettingValue As String
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Switch to the specified profile - create a new session, retrieve settings and return new JWT Token
        '''</Summary>
        <Api(Description:="Switch to the specified profile - create a new session, retrieve settings and return new JWT Token")>
        Public Partial Class SwitchProfile
            '''<Summary>
            '''Id of the user profile to switch to.
            '''</Summary>
            <ApiMember(Description:="Id of the user profile to switch to.", Name:="UserProfileId")>
            Public Overridable Property UserProfileId As Guid

            '''<Summary>
            '''Has 'Remember Me' option been selected?
            '''</Summary>
            <ApiMember(Description:="Has 'Remember Me' option been selected?", Name:="IsPersistent")>
            Public Overridable Property IsPersistent As Boolean
        End Class

        Public Partial Class UpdateQuadrantResponse
            Public Overridable Property PerspectiveSessionId As Guid
            Public Overridable Property Settings As List(Of SettingModel)
            Public Overridable Property Permissions As List(Of Guid)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET SwitchProfile DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}