Syntax
Login (username As String, password As String)
Description
The Login operation should be called before any other operation. Since any requesting operation have to be authenticated
before.
Request Parameters
| Name |
Description |
Required |
|
Username
|
- The username given by the company.
- Type: String.
- Default: None.
|
Yes |
| Password |
- The password given by the company.
- Type: String.
- Default: None.
|
Yes |
Response Elements
| Name |
Description |
| Result |
This operation returns a Composite JSON object of the type ClientLoginInfo. In case of success.
The following are the ClientLoginInfo’s Data members:
1- UserId
2- DemoClient
3- FName
4- SName
5- TName
6- LName
7- isReadOnly
8- SchSms
9- AlertSms
10- GMTOffset
11- SvrGMT
12- ClientType
13- EnableNews
14- PublicSlideNews
15- PrivateSlideNews
16- TermsAccepted
17- CommCalcType
18- RequireChangePassword
19- sessionid
20- VersionInfo As VersionInfo
21- GlobalVariabels As GlobalVariabels
- MultiSessions
- PriceChangedTimer
- ValidLotsLocation
- CustumizeTradeMsg
- ClientConnCheckTimer
- ClientTimeoutTimer
- ServerGMT
22- SystemLockInfo As SystemLockInfo
- MinutesRemaining
- HoursRemaining
- DaysRemaining
- Maintanance
- WillBeLocked
23- FirstWhiteLabel
24- WLID As String
25- CheckWhiteLabel
26- Username
27- LastTickTime
28- IP
29- Mobile
30- SessionDateStart
31- CompanyName
32- UserType As UserTypeEnum
33- LastLoginTime
34- Email
In case of login failure, please refer to the error code.Type: JSON Object as ClientLoginInfo. |
See Also
VertexFX WCF Service Index