Platform API

SwitchProfile

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

The following routes are available for this service:
All Verbs	/api/profiles/{UserProfileId}/switch/token
All Verbs	/api/profiles/{UserProfileId}/switch


export class SettingModel
{
    public SettingId: string;
    public SettingName: string;
    public SettingValue: string;

    public constructor(init?: Partial<SettingModel>) { (Object as any).assign(this, init); }
}

export class UpdateQuadrantResponse
{
    public PerspectiveSessionId: string;
    public Settings: SettingModel[];
    public Permissions: string[];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<UpdateQuadrantResponse>) { (Object as any).assign(this, init); }
}

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

    /** @description Has 'Remember Me' option been selected? */
    // @ApiMember(Description="Has 'Remember Me' option been selected?", Name="IsPersistent")
    public IsPersistent: boolean;

    public constructor(init?: Partial<SwitchProfile>) { (Object as any).assign(this, init); }
}

TypeScript SwitchProfile DTOs

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

HTTP + XML

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/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>