Platform API

<back to all web services

UpdateQuadrant

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

import Foundation
import ServiceStack

/**
* Update quadrant context - create a new session, retrieve settings and return new JWT Token
*/
// @Api(Description="Update quadrant context - create a new session, retrieve settings and return new JWT Token")
public class UpdateQuadrant : Codable
{
    public var session:SessionModel

    required public init(){}
}

public class SessionModel : Codable
{
    /**
    * Create user session for the specified user name
    */
    // @ApiMember(Description="Create user session for the specified user name", IsRequired=true, Name="UserName")
    public var userName:String

    /**
    * Local or External account
    */
    // @ApiMember(Description="Local or External account", IsRequired=true, Name="AuthProvider")
    public var authProvider:String

    /**
    * Current user profile context
    */
    // @ApiMember(Description="Current user profile context", IsRequired=true, Name="UserProfileId")
    public var userProfileId:String

    /**
    * Current appliance context
    */
    // @ApiMember(Description="Current appliance context", IsRequired=true, Name="Appliance")
    public var applianceId:String

    /**
    * Current role context
    */
    // @ApiMember(Description="Current role context", IsRequired=true, Name="RoleId")
    public var roleId:String

    /**
    * Current licensee context
    */
    // @ApiMember(Description="Current licensee context", IsRequired=true, Name="LicenseeConnectionId")
    public var licenseeConnectionId:String

    /**
    * Has 'Remember Me' option been selected?
    */
    // @ApiMember(Description="Has 'Remember Me' option been selected?", Name="IsPersistent")
    public var isPersistent:Bool

    /**
    * Licensee contact id of the current licensee context
    */
    // @ApiMember(Description="Licensee contact id of the current licensee context", IsRequired=true, Name="LicenseeContactId")
    public var licenseeContactId:String

    /**
    * Connection Id linking the current user profile to the current licensee context
    */
    // @ApiMember(Description="Connection Id linking the current user profile to the current licensee context", IsRequired=true, Name="UserContactRoleConnectionId")
    public var userContactRoleConnectionId:String

    required public init(){}
}

public class UpdateQuadrantResponse : Codable
{
    public var perspectiveSessionId:String
    public var settings:[SettingModel]
    public var permissions:[String]
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class SettingModel : Codable
{
    public var settingId:String
    public var settingName:String
    public var settingValue:String

    required public init(){}
}

Swift UpdateQuadrant DTOs

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>