| All Verbs | /api/quadrantupdate/token | ||
|---|---|---|---|
| All Verbs | /api/quadrantupdate |
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* 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")
open class UpdateQuadrant
{
open var Session:SessionModel? = null
}
open class SessionModel
{
/**
* Create user session for the specified user name
*/
@ApiMember(Description="Create user session for the specified user name", IsRequired=true, Name="UserName")
open var UserName:String? = null
/**
* Local or External account
*/
@ApiMember(Description="Local or External account", IsRequired=true, Name="AuthProvider")
open var AuthProvider:String? = null
/**
* Current user profile context
*/
@ApiMember(Description="Current user profile context", IsRequired=true, Name="UserProfileId")
open var UserProfileId:UUID? = null
/**
* Current appliance context
*/
@ApiMember(Description="Current appliance context", IsRequired=true, Name="Appliance")
open var ApplianceId:UUID? = null
/**
* Current role context
*/
@ApiMember(Description="Current role context", IsRequired=true, Name="RoleId")
open var RoleId:UUID? = null
/**
* Current licensee context
*/
@ApiMember(Description="Current licensee context", IsRequired=true, Name="LicenseeConnectionId")
open var LicenseeConnectionId:UUID? = null
/**
* Has 'Remember Me' option been selected?
*/
@ApiMember(Description="Has 'Remember Me' option been selected?", Name="IsPersistent")
open var IsPersistent:Boolean? = null
/**
* Licensee contact id of the current licensee context
*/
@ApiMember(Description="Licensee contact id of the current licensee context", IsRequired=true, Name="LicenseeContactId")
open var LicenseeContactId:UUID? = null
/**
* 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")
open var UserContactRoleConnectionId:UUID? = null
}
open class UpdateQuadrantResponse
{
open var PerspectiveSessionId:UUID? = null
open var Settings:ArrayList<SettingModel>? = null
open var Permissions:ArrayList<UUID>? = null
open var ResponseStatus:ResponseStatus? = null
}
open class SettingModel
{
open var SettingId:UUID? = null
open var SettingName:String? = null
open var SettingValue:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"Session":{"UserName":"String","AuthProvider":"String","UserProfileId":"00000000-0000-0000-0000-000000000000","ApplianceId":"00000000-0000-0000-0000-000000000000","RoleId":"00000000-0000-0000-0000-000000000000","LicenseeConnectionId":"00000000-0000-0000-0000-000000000000","IsPersistent":false,"LicenseeContactId":"00000000-0000-0000-0000-000000000000","UserContactRoleConnectionId":"00000000-0000-0000-0000-000000000000"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"PerspectiveSessionId":"00000000-0000-0000-0000-000000000000","Settings":[{"SettingId":"00000000-0000-0000-0000-000000000000","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"}}}