Platform API

<back to all web services

SwitchProfile

Switch to the specified profile - create a new session, retrieve settings and return new JWT Token

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

POST /api/profiles/{UserProfileId}/switch/token HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SwitchProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <IsPersistent>false</IsPersistent>
  <UserProfileId>00000000-0000-0000-0000-000000000000</UserProfileId>
</SwitchProfile>

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

<UpdateQuadrantResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Permissions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </Permissions>
  <PerspectiveSessionId>00000000-0000-0000-0000-000000000000</PerspectiveSessionId>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Settings xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.Models">
    <d2p1:SettingModel>
      <d2p1:SettingId>00000000-0000-0000-0000-000000000000</d2p1:SettingId>
      <d2p1:SettingName>String</d2p1:SettingName>
      <d2p1:SettingValue>String</d2p1:SettingValue>
    </d2p1:SettingModel>
  </Settings>
</UpdateQuadrantResponse>