Yardi Store Developer eXchange

Retrieves the password/eCommerce code along with contact details for an email within the specified organization. This will retrieve contact information for all accounts with the specified email address if no password/eCommerce code is included. If a password/eCommerce code is included, it will filter for only accounts that are registered with eStore/eCommerce with that password.

Parameters

Description

Returned Parameters

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 (including optional parameter):

// RetrievePassword Request
request.OrgID = 123456;
request.EmailAddress = "test@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.RetrievePassword(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.