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

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SettingModel() = 
        member val SettingId:Guid = new Guid() with get,set
        member val SettingName:String = null with get,set
        member val SettingValue:String = null with get,set

    [<AllowNullLiteral>]
    type UpdateQuadrantResponse() = 
        member val PerspectiveSessionId:Guid = new Guid() with get,set
        member val Settings:ResizeArray<SettingModel> = null with get,set
        member val Permissions:ResizeArray<Guid> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type 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")>]
        member val UserName:String = null with get,set

        ///<summary>
        ///Local or External account
        ///</summary>
        [<ApiMember(Description="Local or External account", IsRequired=true, Name="AuthProvider")>]
        member val AuthProvider:String = null with get,set

        ///<summary>
        ///Current user profile context
        ///</summary>
        [<ApiMember(Description="Current user profile context", IsRequired=true, Name="UserProfileId")>]
        member val UserProfileId:Guid = new Guid() with get,set

        ///<summary>
        ///Current appliance context
        ///</summary>
        [<ApiMember(Description="Current appliance context", IsRequired=true, Name="Appliance")>]
        member val ApplianceId:Guid = new Guid() with get,set

        ///<summary>
        ///Current role context
        ///</summary>
        [<ApiMember(Description="Current role context", IsRequired=true, Name="RoleId")>]
        member val RoleId:Guid = new Guid() with get,set

        ///<summary>
        ///Current licensee context
        ///</summary>
        [<ApiMember(Description="Current licensee context", IsRequired=true, Name="LicenseeConnectionId")>]
        member val LicenseeConnectionId:Guid = new Guid() with get,set

        ///<summary>
        ///Has 'Remember Me' option been selected?
        ///</summary>
        [<ApiMember(Description="Has 'Remember Me' option been selected?", Name="IsPersistent")>]
        member val IsPersistent:Boolean = new Boolean() with get,set

        ///<summary>
        ///Licensee contact id of the current licensee context
        ///</summary>
        [<ApiMember(Description="Licensee contact id of the current licensee context", IsRequired=true, Name="LicenseeContactId")>]
        member val LicenseeContactId:Guid = new Guid() with get,set

        ///<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")>]
        member val UserContactRoleConnectionId:Guid = new Guid() with get,set

    ///<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")>]
    [<AllowNullLiteral>]
    type UpdateQuadrant() = 
        member val Session:SessionModel = null with get,set

F# UpdateQuadrant 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/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>