| All Verbs | /api/quadrantupdate/token | ||
|---|---|---|---|
| All Verbs | /api/quadrantupdate |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SettingModel:
setting_id: Optional[str] = None
setting_name: Optional[str] = None
setting_value: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateQuadrantResponse:
perspective_session_id: Optional[str] = None
settings: Optional[List[SettingModel]] = None
permissions: Optional[List[str]] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SessionModel:
# @ApiMember(Description="Create user session for the specified user name", IsRequired=true, Name="UserName")
user_name: Optional[str] = None
"""
Create user session for the specified user name
"""
# @ApiMember(Description="Local or External account", IsRequired=true, Name="AuthProvider")
auth_provider: Optional[str] = None
"""
Local or External account
"""
# @ApiMember(Description="Current user profile context", IsRequired=true, Name="UserProfileId")
user_profile_id: Optional[str] = None
"""
Current user profile context
"""
# @ApiMember(Description="Current appliance context", IsRequired=true, Name="Appliance")
appliance_id: Optional[str] = None
"""
Current appliance context
"""
# @ApiMember(Description="Current role context", IsRequired=true, Name="RoleId")
role_id: Optional[str] = None
"""
Current role context
"""
# @ApiMember(Description="Current licensee context", IsRequired=true, Name="LicenseeConnectionId")
licensee_connection_id: Optional[str] = None
"""
Current licensee context
"""
# @ApiMember(Description="Has 'Remember Me' option been selected?", Name="IsPersistent")
is_persistent: bool = False
"""
Has 'Remember Me' option been selected?
"""
# @ApiMember(Description="Licensee contact id of the current licensee context", IsRequired=true, Name="LicenseeContactId")
licensee_contact_id: Optional[str] = None
"""
Licensee contact id of the current licensee context
"""
# @ApiMember(Description="Connection Id linking the current user profile to the current licensee context", IsRequired=true, Name="UserContactRoleConnectionId")
user_contact_role_connection_id: Optional[str] = None
"""
Connection Id linking the current user profile to the current licensee context
"""
# @Api(Description="Update quadrant context - create a new session, retrieve settings and return new JWT Token")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateQuadrant:
"""
Update quadrant context - create a new session, retrieve settings and return new JWT Token
"""
session: Optional[SessionModel] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/quadrantupdate/token HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Session:
{
UserName: String,
AuthProvider: String,
IsPersistent: False
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Settings:
[
{
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
}
}
}