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: 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
		}
	}
}