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

namespace Eros.Subtle.Canvara.WebAPIModel.Models
{
    public partial class SettingModel
    {
        public virtual Guid SettingId { get; set; }
        public virtual string SettingName { get; set; }
        public virtual string SettingValue { get; set; }
    }

}

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 virtual Guid UserProfileId { get; set; }

        ///<summary>
        ///Has 'Remember Me' option been selected?
        ///</summary>
        [ApiMember(Description="Has 'Remember Me' option been selected?", Name="IsPersistent")]
        public virtual bool IsPersistent { get; set; }
    }

    public partial class UpdateQuadrantResponse
    {
        public virtual Guid PerspectiveSessionId { get; set; }
        public virtual List<SettingModel> Settings { get; set; }
        public virtual List<Guid> Permissions { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

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