| 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
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}