| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateQuadrant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<Session xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.Models">
<d2p1:ApplianceId>00000000-0000-0000-0000-000000000000</d2p1:ApplianceId>
<d2p1:AuthProvider>String</d2p1:AuthProvider>
<d2p1:IsPersistent>false</d2p1:IsPersistent>
<d2p1:LicenseeConnectionId>00000000-0000-0000-0000-000000000000</d2p1:LicenseeConnectionId>
<d2p1:LicenseeContactId>00000000-0000-0000-0000-000000000000</d2p1:LicenseeContactId>
<d2p1:RoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleId>
<d2p1:UserContactRoleConnectionId>00000000-0000-0000-0000-000000000000</d2p1:UserContactRoleConnectionId>
<d2p1:UserName>String</d2p1:UserName>
<d2p1:UserProfileId>00000000-0000-0000-0000-000000000000</d2p1:UserProfileId>
</Session>
</UpdateQuadrant>
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>