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
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SettingModel() = 
        member val SettingId:Guid = new Guid() with get,set
        member val SettingName:String = null with get,set
        member val SettingValue:String = null with get,set

    [<AllowNullLiteral>]
    type UpdateQuadrantResponse() = 
        member val PerspectiveSessionId:Guid = new Guid() with get,set
        member val Settings:ResizeArray<SettingModel> = null with get,set
        member val Permissions:ResizeArray<Guid> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<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")>]
    [<AllowNullLiteral>]
    type SwitchProfile() = 
        ///<summary>
        ///Id of the user profile to switch to.
        ///</summary>
        [<ApiMember(Description="Id of the user profile to switch to.", Name="UserProfileId")>]
        member val UserProfileId:Guid = new Guid() with get,set

        ///<summary>
        ///Has 'Remember Me' option been selected?
        ///</summary>
        [<ApiMember(Description="Has 'Remember Me' option been selected?", Name="IsPersistent")>]
        member val IsPersistent:Boolean = new Boolean() with get,set

F# 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"}}}