EliloginService

EliloginService.asmx

This service provides methods for getting user login information, changing passwords, and logging out.

 

Login

This method will return user information and write a login record to activity file. If the input password not match user’s password, it will not return user’s information.

Usage:

LoginResult = A.Login(UserName, UserPassword, UserID, Password, LogType, Source, Client, Comment)

Parameters UserName and UserPassword are not used at this moment.

 

Input Parameter

Parameter

Length

Type

Upper

Detail

UserID

10

String

Y

Required.

Password

10

String

Y

This password must match UserID’s password, or you’ll get an error.

LogType

30

String

 

This will be written to activity log file (SYACTLOG).

Source

30

String

 

This will be written to activity log file (SYACTLOG).

Client

32

String

 

This will be written to activity log file (SYACTLOG).

Comment

60

String

 

This will be written to activity log file (SYACTLOG).

 

LoginResult Structure

Property

Type

Detail

ReturnCode

Integer

Contains return code. Zero means OK; for other return codes, please see “EliloginService Return Code” section.

ReturnMsg

String

This is description of return code. For example, if return code is zero, you can expect “OK” in this field.

LoginToken

String

 

UserName

String

 

UserPosition

String

 

UserDepartment

String

 

UserExtension

String

 

UserEmail

String

 

UserAccessEvent

String

 

SalesmanNo

String

 

PoolSalesmanID

String

 

UserGlobalSecurity

String

 

SystemSecurity()

String

 

ModuleSecurity()

String

 

GlobalSetup()

String

 

ModuleSetup()

String

 

 

Code Example

The following sample code will login as user “USR01” and password “aabbccdd.”

 

Dim Service As New webServicesLogin.EliloginService

Dim Result As webServicesLogin.LoginResult

Dim UserID As String = “USR01”

Dim Password As String = “aabbccdd”

Dim LogType As String = “WEB LOGIN”

Dim Source As String = “webstore.eliott.com”

Dim Client As String = “WebStore”

Dim Comment As String = “web login comment”

Result = Service.Login(“”, “”, UserID, Password, LogType, Source, Client, Comment)

If Result.ReturnCode = 0 Then

  lblResult.Text = “Login successfully. This user’s email: ” + _

                    Result.UserEmail

Else

  lblResult.Text = Result.ReturnMsg

   lblErrorCode.Text = Result.ReturnCode.ToString

End If

 

UpdatePassword

This method will update a password for a user.

Usage:

UpdatePasswordResult = A.UpdatePassword(UserName, UserPassword, UserID, Password, NewPassword)

Parameters UserName and UserPassword are not used at this moment.

 

Input Parameter

Parameter

Length

Type

Upper

Detail

UserID

10

String

Y

Required.

Password

10

String

Y

User’s current password. This password must match UserID’s password, or you’ll get an error.

NewPassword

10

String

Y

User’s new password.

 

Output Parameter

Parameter

Type

Detail

UpdatePasswordResult

Integer

Contains return code. Zero means OK; for other return codes, please see “EliloginService Return Code” section.

 

Code Example

The following sample code will change password for user “USR01.”

 

Dim Service As New webServicesLogin.EliloginService

Dim Result As Integer

Dim UserID As String = “USR01”

Dim Password As String = “aabbccdd”

Dim NewPassword As String = “ccddaabb”

Result = Service.UpdatePassword(“”, “”, UserID, Password, NewPassword)

If Result = 0 Then

  lblResult.Text = “Password updated.”

Else

  lblResult.Text = “Error.”

   lblErrorCode.Text = Result.ToString

End If

 

Logout

This method will logout record to activity file.

Usage:

LogoutResult = A.Logout(UserName, UserPassword, UserID, LogType, Source, Client, Comment)

Parameters UserName and UserPassword are not used at this moment.

 

Input Parameter

Parameter

Length

Type

Upper

Detail

UserID

10

String

Y

Required.

Password

10

String

Y

User’s current password. This password must match UserID’s password, or you’ll get an error.

LogType

30

String

 

This will be written to activity log file (SYACTLOG).

Source

30

String

 

This will be written to activity log file (SYACTLOG).

Client

32

String

 

This will be written to activity log file (SYACTLOG).

Comment

60

String

 

This will be written to activity log file (SYACTLOG).

 

Output Parameter

Parameter

Type

Detail

LogoutResult

Integer

Contains return code. Zero means OK; for other return codes, please see “EliloginService Return Code” section.

 

Code Example

The following sample code will logout user “USR01.”

 

Dim Service As New webServicesLogin.EliloginService

Dim Result As Integer

Dim UserID As String = “USR01”

Dim LogType As String = “WEB LOGOUT”

Dim Source As String = “webstore.eliott.com”

Dim Client As String = “CUST1”

Dim Comment As String = “web logout comment”

Result = Service.Logout(“”, “”, UserID, LogType, Source, Client, Comment)

If Result = 0 Then

  lblResult.Text = “Logout successfully.”

Else

  lblResult.Text = “Error.”

   lblErrorCode.Text = Result.ToString

End If

 

EliloginService Return Code

0 = OK

1 = File Error

2 = Invalid User or (Old) Password

3 = Password Turn Off

CLS

Developer Documentations

  1. Received Code 9999 with Web Services Call
  2. Received Return Status Code 3 When Using Elilogin Login Method
  3. Elliott Web Service Requirements
  4. Elliott eStore Checklist
  5. LN API
  6. FN API
  7. RN API
  8. IN and DF API Change (V9.0)
  9. FA API Changes (V9.0)
  10. VA API Changes (V9.0)
  11. CartService
  12. EliarachService
  13. ElicshtxService
  14. EliattrbService
  15. ElisyscdService
  16. EliNoteService
  17. El2rstimService
  18. EliOrderService
  19. ItemInquiry
  20. EliitmiqService
  21. EliShiptoService
  22. El2getfrService
  23. Steps Required to Test ReportWriter in V8.2
  24. Installation of ElliottService, NETcellent’s Web Services for Elliott
  25. ResellerFinder
  26. EliaptrxService
  27. VendorInquiry
  28. EliloginService
  29. ElislsmnService
  30. EliserhsService
  31. EliatpobService
  32. ElievprcService
  33. ElihdtrxService
  34. ElicuswlService
  35. QueryTurnaround
  36. InvoiceInquiry
  37. ElicustmService
  38. EligetcdService
  39. OrderInquiry
  40. EliordiqService
  41. EliecontService
  42. EliautdpService
  43. El2CrCrdService
  44. Log-Timer / ElliottTimer.Ini Support
  45. Alpha Document Number Support (V8.5/V9.0)
  46. ElliottService System.TypeInitializationException
  47. Feature - Printing API to Dynamically Set Number of Copies
  48. The Values and Meanings of Distribution Types - ARDISFIL, APDISFIL, IMDISFIL, BMDISFIL
  49. DD API Changes (V9.0)
  50. PA API (8.5)
  51. Validate License API
  52. AP API
  53. TP API: Temporary Path
  54. Data Structures for Report Desk Defaults and Enforcements
  55. COBOL to VB Interface Programs
  56. IN API: Option to Support Files and Folders Validation
  57. FF API: File Functions
  58. ID API
  59. LK: Links API
  60. FFLNearYou
  61. Report Desk Developing and Debugging
  62. Developing a New Elliott V8.6 Report Desk User Defined Report (UDR)
  63. CustomerInquiry
  64. Elliott API (JSON Web Service)
  65. Animating COBOL Code in Elliott V8.5
  66. Preliminary Programming Changes for Elliott 8.6
  67. CV API
  68. System Lock File Requirements
  69. How to Write Test Codes for C# ESS Projects
  70. Solving the Inability to Debug Elliott on a New Server
  71. Report Desk: Developing Custom Reports
  72. Report Desk Tables
  73. Report Desk Database Delivery Strategy

Feedback and Knowledge Base