Syntax
BackOfficeLogin (Username As String, Password As String)
Description
The Login operation should be called before any other operation since any requested operation has to be authenticated.
Request Parameters
| Name |
Description |
Required |
| Username |
- The username of the dealer.
- Type: String
- Default: None
|
Yes |
| Password |
- The Password of the dealer.
- Type: String
- Default: None
|
Yes |
Response Elements
| Name |
Description |
| Result |
This operation returns a Composite JSON object of the type DealerLoginInfo. In case of success.
The following are the Login Infos Data member:
- SessionId : Session ID
- VersionInfo: Array which contain :
1- Release : Release number
2- Version : Version number
3- Patch : Patch number
4- ForceUpdate
5- UpdateType
6- GlobalVariabels
- SystemLockInfo, Which contain :
1- MinutesRemaining
2- HoursRemaining
3- DaysRemaining
4- Maintanance
5- WillBeLocked
- FirstWhiteLabel: First White Label name
- WhiteLabelID: White Label ID
- Username: Client logged in username
- IP: IP address
- CompanyName: Company name
- UserType: User Type
If the value = 1 then the user type is DealerUser
If the value = 2 then the user type is ClientUser
If the value = 3 then the user type is DemoClientUser
If the value = 5 then the user type is WebServer
- UserId: If the value < 0 then, see error code to get Error description
- SchedualSms: Schedule Sms
- DealerGMTOffset: Dealer GMT Offset value.
- ServerGMTOffset: Server GMT Offset value.
- EnableNews: If its value = 1 then the news is Enabled
- PublicSlideNews: Public news value
- PrivateSlideNews: private news value
- DealerTreePriv: Dealer tree privilege.
- LastLoginTime: Last Login Time.
- BOPercent: BackOffice Percent.
- DeptID: Department ID.
In case of login failure, please refer to the error code.
Type: JSON Object as DealerLoginInfo |
See Also
VertexFX BackOffice WCF Service Index