Platform API

<back to all web services

UpdateQuadrant

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

Requires Authentication
The following routes are available for this service:
All Verbs/api/quadrantupdate/token
All Verbs/api/quadrantupdate
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Subtle.Canvara.WebAPIModel.Models;

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 virtual string UserName { get; set; }

        ///<summary>
        ///Local or External account
        ///</summary>
        [ApiMember(Description="Local or External account", IsRequired=true, Name="AuthProvider")]
        public virtual string AuthProvider { get; set; }

        ///<summary>
        ///Current user profile context
        ///</summary>
        [ApiMember(Description="Current user profile context", IsRequired=true, Name="UserProfileId")]
        public virtual Guid UserProfileId { get; set; }

        ///<summary>
        ///Current appliance context
        ///</summary>
        [ApiMember(Description="Current appliance context", IsRequired=true, Name="Appliance")]
        public virtual Guid ApplianceId { get; set; }

        ///<summary>
        ///Current role context
        ///</summary>
        [ApiMember(Description="Current role context", IsRequired=true, Name="RoleId")]
        public virtual Guid RoleId { get; set; }

        ///<summary>
        ///Current licensee context
        ///</summary>
        [ApiMember(Description="Current licensee context", IsRequired=true, Name="LicenseeConnectionId")]
        public virtual Guid LicenseeConnectionId { get; set; }

        ///<summary>
        ///Has 'Remember Me' option been selected?
        ///</summary>
        [ApiMember(Description="Has 'Remember Me' option been selected?", Name="IsPersistent")]
        public virtual bool IsPersistent { 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")]
        public virtual Guid LicenseeContactId { 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")]
        public virtual Guid UserContactRoleConnectionId { get; set; }
    }

    public partial class SettingModel
    {
        public virtual Guid SettingId { get; set; }
        public virtual string SettingName { get; set; }
        public virtual string SettingValue { get; set; }
    }

}

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 virtual SessionModel Session { get; set; }
    }

    public partial class UpdateQuadrantResponse
    {
        public virtual Guid PerspectiveSessionId { get; set; }
        public virtual List<SettingModel> Settings { get; set; }
        public virtual List<Guid> Permissions { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# UpdateQuadrant DTOs

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

HTTP + JSV

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