Platform API

UpdateQuadrant

Update quadrant context - create a new session, retrieve settings and return new JWT Token

The following routes are available for this service:
All Verbs	/api/quadrantupdate/token
All Verbs	/api/quadrantupdate

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Subtle.Canvara.WebAPIModel.Models

Namespace Global

    Namespace Eros.Subtle.Canvara.WebAPIModel.Models

        Public Partial Class SessionModel
            '''<Summary>
            '''Create user session for the specified user name
            '''</Summary>
            <ApiMember(Description:="Create user session for the specified user name", IsRequired:=true, Name:="UserName")>
            Public Overridable Property UserName As String

            '''<Summary>
            '''Local or External account
            '''</Summary>
            <ApiMember(Description:="Local or External account", IsRequired:=true, Name:="AuthProvider")>
            Public Overridable Property AuthProvider As String

            '''<Summary>
            '''Current user profile context
            '''</Summary>
            <ApiMember(Description:="Current user profile context", IsRequired:=true, Name:="UserProfileId")>
            Public Overridable Property UserProfileId As Guid

            '''<Summary>
            '''Current appliance context
            '''</Summary>
            <ApiMember(Description:="Current appliance context", IsRequired:=true, Name:="Appliance")>
            Public Overridable Property ApplianceId As Guid

            '''<Summary>
            '''Current role context
            '''</Summary>
            <ApiMember(Description:="Current role context", IsRequired:=true, Name:="RoleId")>
            Public Overridable Property RoleId As Guid

            '''<Summary>
            '''Current licensee context
            '''</Summary>
            <ApiMember(Description:="Current licensee context", IsRequired:=true, Name:="LicenseeConnectionId")>
            Public Overridable Property LicenseeConnectionId As Guid

            '''<Summary>
            '''Has 'Remember Me' option been selected?
            '''</Summary>
            <ApiMember(Description:="Has 'Remember Me' option been selected?", Name:="IsPersistent")>
            Public Overridable Property IsPersistent As Boolean

            '''<Summary>
            '''Licensee contact id of the current licensee context
            '''</Summary>
            <ApiMember(Description:="Licensee contact id of the current licensee context", IsRequired:=true, Name:="LicenseeContactId")>
            Public Overridable Property LicenseeContactId As Guid

            '''<Summary>
            '''Connection Id linking the current user profile to the current licensee context
            '''</Summary>
            <ApiMember(Description:="Connection Id linking the current user profile to the current licensee context", IsRequired:=true, Name:="UserContactRoleConnectionId")>
            Public Overridable Property UserContactRoleConnectionId As Guid
        End Class

        Public Partial Class SettingModel
            Public Overridable Property SettingId As Guid
            Public Overridable Property SettingName As String
            Public Overridable Property SettingValue As String
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Update quadrant context - create a new session, retrieve settings and return new JWT Token
        '''</Summary>
        <Api(Description:="Update quadrant context - create a new session, retrieve settings and return new JWT Token")>
        Public Partial Class UpdateQuadrant
            Public Overridable Property Session As SessionModel
        End Class

        Public Partial Class UpdateQuadrantResponse
            Public Overridable Property PerspectiveSessionId As Guid
            Public Overridable Property Settings As List(Of SettingModel)
            Public Overridable Property Permissions As List(Of Guid)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET UpdateQuadrant DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Session":{"UserName":"String","AuthProvider":"String","UserProfileId":"00000000-0000-0000-0000-000000000000","ApplianceId":"00000000-0000-0000-0000-000000000000","RoleId":"00000000-0000-0000-0000-000000000000","LicenseeConnectionId":"00000000-0000-0000-0000-000000000000","IsPersistent":false,"LicenseeContactId":"00000000-0000-0000-0000-000000000000","UserContactRoleConnectionId":"00000000-0000-0000-0000-000000000000"}}

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}