Admin | Yardi Store Developer eXchange

SWS RetrievePassword Method

May 29, 2011 cencanderson 2 comments

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

Name	DataType	Is Required
EmailAddress	String	Required
Description	The email address for which you wish to retrieve the password/eCommerce code.
OrgID	Long	Required
Description	The organization’s ID number.
Password	String	Optional
Description	The password/eCommerce code of the contact.

Returned Parameters

Name	DataType
ACCT_ID	Long
Description	The account’s ID number.
ACTIVE	String
Description	Indicates if the 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. 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 primary contact.
FIRST_NAME	String
Description	The given name for the account/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 (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.

Categories: Account Management, API General, Permissions Tags: Admin, Password, Security

SWS ResetServicesPassword Method

May 29, 2011 cencanderson Leave a comment

This method is not recommended for use at this time.

Categories: Account Management, API General, Permissions Tags: Admin, Password, Security

SWS SearchBy Method

May 25, 2011 cencanderson 2 comments

Allows you to search for a customer name, unit number, phone number, or rental ID. The search can be performed for the entire organization or for just a specific site. This will return a record for each contact and each rental on an account.

Parameters

Name	DataType	Is Required
OrgID	Long	Optional*
Description	The organization’s ID number. *Either an OrgID or SiteID is required.
SearchTerm	String	Required
Description	The parameter to search for.
SearchType	SearchTypes	Required
Description	Tells the system what fields to look at in the search. Available values: QuickSearch SearchByPhone SearchByUnit SearchByName SearchByRental
SiteID	Long	Optional*
Description	The site’s ID number. This can be found using the GetSiteList method. *Either an OrgID or SiteID is required.

Returned Parameters

Name	DataType
ACCT_CONTACT_NAME_SEARCH	String
Description	The field in Store used when an “Account/Contact” search is performed.
ACCT_ID	Long
Description	The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method.
ACCT_NAME	String
Description	The name on the account. This may differ from the primary contact’s name in some instances, such as a business account or a guardianship account.
AFFILIATE_ID	Long
Description	The affiliated organization’s ID number.
BASIC_NAME_SEARCH	String
Description	The field in Store used when an “Account Name” search is performed.
CONTACT_FULL_NAME	String
Description	The full name of the contact in the format of “First Last”.
CONTACT_ID	Long
Description	The rental contact’s ID number.
DISPLAY_RENTAL_STR	String
Description	The display name of the rental as it appears in Store.
FIRST_NAME	String
Description	The first name of the contact.
LAST_NAME	String
Description	The family or last name of the contact.
NETWORK_NAME_SEARCH	String
Description	The organization’s search field which includes the account name, the organization name and the site name.
OBJECT_ID	Long
Description	The object’s ID number. This is maintained through rentals.
ORG_ID	Long
Description	The organization’s ID number.
PHONE	String
Description	The contact’s phone number.
PHONE_CONTACT_NAME_SEARCH	String
Description	One of the fields in Store used when a “Phone Number” search is performed.
PHONE_SEARCH	String
Description	One of the fields in Store used when a “Phone Number” search is performed.
PHONE_TYPE	String
Description	Describes the type of phone number returned for the contact. Available values: Home Office Mobile Fax Other
PTD	DateTime
Description	The PTD of the returned rental.
QUICK_SEARCH	String
Description	The field in Store used when an “Quick Search” search is performed.
RENTAL_ID	Decimal
Description	The rental record’s ID number.
RENTAL_STATUS	Integer
Description	The textual value for the rental status of the rental. Available values: Current – 0 Delinquent – 1 In-Process – 100 (Hard)Reserved – 101 Soft Reservation – 102 Vacated/Terminated – 201 Voided Rental – 202 In-Transfer – 203 Abandoned Rental – 205
RSTAT_RAW	Decimal
Description	The numeric value for the rental status of the rental. Available values: 0 – Current 1 – Delinquent 100 – In-Process 101 – (Hard)Reserved 102 – Soft Reservation 201 – Vacated/Terminated 202 – Voided Rental 203 – In-Transfer 205 – Abandoned Rental
SITE_ID	Long
Description	The site’s ID number where the unit is located.
SITE_NAME	String
Description	The site’s name where the unit is located.
UNIT_NUMBER	String
Description	The unit’s number as assigned by the organization. This is not the UnitID.
UNIT_SEARCH	String
Description	The field in Store used when a “Unit Number” search is performed.
UNIT_STATUS	String
Description	The rental status of the unit. Available values: 1 – Available 2 – Reserved 3 – Rented 4 – Company Use 5 – Unavailable – Damaged 6 – Unavailable – Permanent 8 – Other 9 – Unavailable – Pending 10 – Available – Hold

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 SearchBy request object, and a SearchBy response object. We can define and create those like this:

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

Here is a sample code of the request object for the QuickSearch option:

// SearchBy Request
request.OrgID = 123456;
request.SiteID = 123456;
request.SearchTerm = "Joe";
request.SearchType = SWS.SearchTypes.QuickSearch;

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.SearchBy(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.

Categories: Account Management, API General, Search, Site Administration Tags: Admin, Search

SWS GetOrgList Method

May 23, 2011 sutiki 1 comment

Retrieves the Org identification data, based on the organizations the user has access to.

Parameters

Name	Data Type	Is Required
LookupUser	LookupUser	Required
Description	This is the same LookupUser information used for other calls. This is all that is required for this method.

Returned Parameters

Name	DataType
AddressLine1	String
Description	The first line of the address.
AddressLine2	String
Description	The second line of the address.
AppDisplayName	String
Description	The name of the organization as it appears in Store.
City	String
Description	The city of the organization’s address.
Country	String
Description	The country of the organization’s address.
Email	String
Description	The organization’s email address.
Fax	String
Description	The fax number for the organization.
OrgID	Long
Description	The organization’s ID number.
OrgName	String
Description	The organization’s name.
Phone	String
Description	The organization’s phone number.
PostalCode	String
Description	The postal/ZIP code for the organization’s address.
Primary	Boolean
Description	Indicates if the organization is the user’s primary organization (“True”) or not (“False”).
State	String
Description	The state/province of the organization’s address.

Example

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

We’ll assume you’ve got a web reference, let’s name it SWS, in your Visual Studio project. We’ll need the standard service object and a GetOrgList response object.

// Create a response object
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetOrgList_Response response;

We can call the method and pass across the login object to get our org list. 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.GetOrgList(user_request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.

For a full list of methods see SWS Methods.

Categories: API General, Reports, Site Administration Tags: Admin, Org Admin

Older Entries

Yardi Store Developer eXchange

Archive

SWS RetrievePassword Method

Parameters

Returned Parameters

Example

SWS ResetServicesPassword Method

SWS SearchBy Method

Parameters

Returned Parameters

Example

SWS GetOrgList Method

Parameters

Returned Parameters

Example

Helpful Links

Meta

Tags