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
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class SettingModel implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $SettingId='',
        /** @var string|null */
        public ?string $SettingName=null,
        /** @var string|null */
        public ?string $SettingValue=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['SettingId'])) $this->SettingId = $o['SettingId'];
        if (isset($o['SettingName'])) $this->SettingName = $o['SettingName'];
        if (isset($o['SettingValue'])) $this->SettingValue = $o['SettingValue'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->SettingId)) $o['SettingId'] = $this->SettingId;
        if (isset($this->SettingName)) $o['SettingName'] = $this->SettingName;
        if (isset($this->SettingValue)) $o['SettingValue'] = $this->SettingValue;
        return empty($o) ? new class(){} : $o;
    }
}

class UpdateQuadrantResponse implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $PerspectiveSessionId='',
        /** @var array<SettingModel>|null */
        public ?array $Settings=null,
        /** @var array<string>|null */
        public ?array $Permissions=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['PerspectiveSessionId'])) $this->PerspectiveSessionId = $o['PerspectiveSessionId'];
        if (isset($o['Settings'])) $this->Settings = JsonConverters::fromArray('SettingModel', $o['Settings']);
        if (isset($o['Permissions'])) $this->Permissions = JsonConverters::fromArray('Guid', $o['Permissions']);
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->PerspectiveSessionId)) $o['PerspectiveSessionId'] = $this->PerspectiveSessionId;
        if (isset($this->Settings)) $o['Settings'] = JsonConverters::toArray('SettingModel', $this->Settings);
        if (isset($this->Permissions)) $o['Permissions'] = JsonConverters::toArray('Guid', $this->Permissions);
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

/** @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")
class SwitchProfile implements JsonSerializable
{
    public function __construct(
        /** @description Id of the user profile to switch to. */
        // @ApiMember(Description="Id of the user profile to switch to.", Name="UserProfileId")
        /** @var string */
        public string $UserProfileId='',

        /** @description Has 'Remember Me' option been selected? */
        // @ApiMember(Description="Has 'Remember Me' option been selected?", Name="IsPersistent")
        /** @var bool|null */
        public ?bool $IsPersistent=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['UserProfileId'])) $this->UserProfileId = $o['UserProfileId'];
        if (isset($o['IsPersistent'])) $this->IsPersistent = $o['IsPersistent'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->UserProfileId)) $o['UserProfileId'] = $this->UserProfileId;
        if (isset($this->IsPersistent)) $o['IsPersistent'] = $this->IsPersistent;
        return empty($o) ? new class(){} : $o;
    }
}

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