Home > API General, Retail/Merchandise > SWS VerifyLogin Method

SWS VerifyLogin Method


Verifies an eStore customer’s login information. This method returns additional information over the VerifyEcommLogin method. If the information doesn’t match you will receive an error.

Parameters

Name DataType Is Required
EmailAddress String Required
Description The email address of the contact. This acts as the username for eStore/eCommerce. Max string length of 100.
OrgID Long Required
Description The organization’s ID number.
Password String Required
Description The password/eCommerce code of the contact. Max string length of 30.

Returned parameters

Name DataType
ACCT_ID Long
Description The account’s ID number.
ACTIVE String
Description Indicates if the eStore/eCommerce account is active (“Y”) or not (“N”).
CFLEX01 String
Description A custom field, set up by the organization, designed to hold additional contact information. This is not displayed in the Store application.
CFLEX02 String
Description A custom field, set up by the organization, designed to hold additional contact information. This is not displayed in the Store application.
CFLEX03 String
Description A custom field, set up by the organization, designed to hold additional contact information. This is not displayed in the Store application.
CFLEX04 String
Description A custom field, set up by the organization, designed to hold additional contact information. This is not displayed in the Store application.
CFLEX05 String
Description A custom field, set up by the organization, designed to hold additional contact information. This is not displayed in the Store application.
CONTACT_ID Long
Description The rental contact’s ID number.
CONTACT_TYPE Integer
Description The numeric value for the contact type for the account.
Available values:

  • 1 – ACCOUNT_MANAGER
  • 2 – ACCOUNT_USER
  • 3 – ACCOUNT_CONTACT_ONLY
  • 4 – BUSINESS_CONTACT_RECORD
ECOMM_CODE String
Description No longer returned.
EMAIL String
Description The email address for the account or primary contact. This is also used as a username for eStore/eCommerce.
FIRST_NAME String
Description The first name of the rental contact.
KNOWN_AS String
Description The alternate or nick name for the rental contact.
LAST_NAME String
Description The family name for the rental contact.
ORG_ID Long
Description The organization’s ID number.

Example

As with every method we need to pass in credentials. We do this with the LookupUser request object.

We will assume you have a web reference, let us name it SWS, in your Visual Studio project. At this point we need to define our objects.  We will need the standard service object, a Password request object, and a Password response object. We can define and create those like this:

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.Password_Request request = new SWS.Password_Request();
SWS.Password_Response response;

Here is a sample code of the request object:

// Password Request
request.OrgID = 123456;
request.EmailAddress = "j.doe@b.c";
request.Password = "TestPass";

Finally we can call the method and pass across the login object and the request object to retrieve our requested information. It’s a good idea to do this in a Try Catch block.

// Call the method that will load the response object
try
{
  response = service.VerifyLogin(user_request, request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You will want to capture the message in the exception so it can be debugged.

For a full list of methods see SWS Methods.

  1. No comments yet.
  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: