EliloginService

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




    • Related Articles

    • Control Ability to Change eContact Web Password

      Release Date: 2/21/2020 Version 8.5 Normally, the ability to access the maintenance screen for an eContact allows the user to change the web password for that eContact. This change allows you to disable that ability at the Company level. To disable ...

    • EliecontService

      ' EliecontService.asmx This web service provides methods related to eContacts. It can add/change/delete a contact, add/delete relationship, view contacts or relationships, and provide login/logout methods. To understand what a contact and ...

    • Received Return Status Code 3 When Using Elilogin Login Method

      Q - When trying to use the EliloginService Login Method when another user is in Password Setup in Elliott, I receive a return status of 3 (Passwords Turned Off). Why? A - This is happening because the Login Method is attempting to read the System ...

    • The Lessons We Learned from Upgrading Web Service 8.2 to 8.5 in eStore

      Elliott Web Service 8.5 changed ORDER_NO, INV_NO, and other keys from numeric to alphanumeric to accommodate a bigger range. This results in changes in the Web Service interface. This article documents our experience when we upgraded the Web Service ...

    • Elliott Web Service Requirements

      Release Date: 5/22/2017 Q - What are the requirements for running Elliott Web Service? A - Elliott Web Service is built on .NET and runs on Windows. It extends a vast amount of Elliott features to external applications. Some of these features may ...