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.*;

public class dtos
{

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

        /**
        * Has 'Remember Me' option been selected?
        */
        @ApiMember(Description="Has 'Remember Me' option been selected?", Name="IsPersistent")
        public Boolean IsPersistent = null;
        
        public UUID getUserProfileId() { return UserProfileId; }
        public SwitchProfile setUserProfileId(UUID value) { this.UserProfileId = value; return this; }
        public Boolean getIsPersistent() { return IsPersistent; }
        public SwitchProfile setIsPersistent(Boolean value) { this.IsPersistent = value; return this; }
    }

    public static class UpdateQuadrantResponse
    {
        public UUID PerspectiveSessionId = null;
        public ArrayList<SettingModel> Settings = null;
        public ArrayList<UUID> Permissions = null;
        public ResponseStatus ResponseStatus = null;
        
        public UUID getPerspectiveSessionId() { return PerspectiveSessionId; }
        public UpdateQuadrantResponse setPerspectiveSessionId(UUID value) { this.PerspectiveSessionId = value; return this; }
        public ArrayList<SettingModel> getSettings() { return Settings; }
        public UpdateQuadrantResponse setSettings(ArrayList<SettingModel> value) { this.Settings = value; return this; }
        public ArrayList<UUID> getPermissions() { return Permissions; }
        public UpdateQuadrantResponse setPermissions(ArrayList<UUID> value) { this.Permissions = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public UpdateQuadrantResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class SettingModel
    {
        public UUID SettingId = null;
        public String SettingName = null;
        public String SettingValue = null;
        
        public UUID getSettingId() { return SettingId; }
        public SettingModel setSettingId(UUID value) { this.SettingId = value; return this; }
        public String getSettingName() { return SettingName; }
        public SettingModel setSettingName(String value) { this.SettingName = value; return this; }
        public String getSettingValue() { return SettingValue; }
        public SettingModel setSettingValue(String value) { this.SettingValue = value; return this; }
    }

}

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