Session APIs
Login By Access Code (GET)
Login By Access Code.
Route
|
URI |
/api/v1/Session/AccessCode |
|
Method |
GET |
|
Result |
JSON – ActionResult |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
redirect |
Required]string |
No |
|
|
timezone |
string |
No |
|
|
culture |
string |
No |
|
|
applicationId |
string |
No |
|
Example
GET http://localhost/api/v1/Session/AccessCode
Login (POST)
Login.
Route
|
URI |
/api/v1/Session/Login |
|
Method |
POST |
|
Result |
JSON – libExternalInterface.model.LoginResult |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
arguments |
LoginArguments |
No |
|
Example
POST http://localhost/api/v1/Session/Login
Login (GET)
Returns the result of logging in with the given credentials.
Route
|
URI |
/api/v1/Session/Login |
|
Method |
GET |
|
Result |
JSON – A JSON string encoding a <see cref="LoginResult"/>. |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
username |
string |
No |
The user's logon name. |
|
password |
string |
No |
The user's password. |
|
domain |
string |
No |
The user's (full qualified or NetBIOS) domain name. |
|
timezone |
string |
No |
The client's time zone in Olson format, e.g. "Europe/Amsterdam" or "Etc/GMT+2". |
|
culture |
string |
No |
The client's culture for localization purposes, e.g. "en-US" or "de-DE". |
|
applicationId |
string |
No |
The id of the application, that wants to use the WebAPI's. |
Example
GET http://localhost/api/v1/Session/Login
Login With Token (GET)
Returns the result of login in with the given <paramref name="token"/>.
Route
|
URI |
/api/v1/Session/LoginWithToken |
|
Method |
GET |
|
Result |
JSON – A JSON string encoding a <see cref="LoginResult"/>. |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
token |
string |
No |
The user's identification string, one time token. |
|
timezone |
string |
No |
The client's time zone in Olson format, e.g. "Europe/Amsterdam" or "Etc/GMT+2". |
|
culture |
string |
No |
The client's culture for localization purposes, e.g. "en-US" or "de-DE". |
|
applicationId |
string |
No |
The id of the application, that wants to use the WebAPI's. |
Example
GET http://localhost/api/v1/Session/LoginWithToken
Login With Token (POST)
Returns the result of login in with the given <paramref name="token"/>.
Route
|
URI |
/api/v1/Session/LoginWithToken |
|
Method |
POST |
|
Result |
JSON – A JSON string encoding a <see cref="LoginResult"/>. |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
arguments |
LoginWithTokenArguments |
No |
login argument structure |
Example
POST http://localhost/api/v1/Session/LoginWithToken
Logout (GET)
Initiates a logout for the actual SessionId.
Route
|
URI |
/api/v1/Session/logout |
|
Method |
GET |
|
Result |
JSON – A JSON string encoding a boolean indicating if the session specified in the cookie existed. |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
myHub |
IHubContext<EventHub> |
No |
|
Example
GET http://localhost/api/v1/Session/logout
Logout (POST)
Initiates a logout for the actual SessionId.
Route
|
URI |
/api/v1/Session/logout |
|
Method |
POST |
|
Result |
JSON – A JSON string encoding a boolean indicating if the session specified in the cookie existed. |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
myHub |
IHubContext<EventHub> |
No |
|
Example
POST http://localhost/api/v1/Session/logout
Update (POST)
Update the session's date with current timezone. Returns the Capabilities and SessionId of the logged in user.
Route
|
URI |
/api/v1/Session/update |
|
Method |
POST |
|
Result |
JSON – libExternalInterface.model.LoginResult |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
ssoUpdateRequestData |
SsoUpdateRequestData |
No |
|
Example
POST http://localhost/api/v1/Session/update