Security | Yardi Store Developer eXchange

SWS UpdateGatePIN Method

May 29, 2011 cencanderson 1 comment

Changes the pin the customer uses to access the gates.

Parameters

Name	Data Type	Required
ContactID	Long	Required
Description	The rental contact’s ID number. This is returned when using the CreateNewAccount or AddNewContact methods or you can search for it using the SearchBy method.
RentalID	Long	Required
Description	The rental item’s ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBy method.
PIN	String	Required
Description	The new PIN to be assigned to the rentals contact.

Returned Parameters

Name	Data Type
Succeeded	Boolean
Description	Indicates that the gate PIN updated successfully (“True”) or if it failed to update (“False”).

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

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

Here is a sample code of the request object (including optional parameters):

// UpdateGatePIN Request
request.RentalID = 126456;
request.ContactID = 123456;
request.PIN = "1234";

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.UpdateGatePIN(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, Contacts, Gates Tags: Gates, Security

SWS UpdateEcommPassword Method

May 29, 2011 cencanderson Leave a comment

Updates the eStore password/eCommerce code for the specified contact or EcommID. If the customer does not have an password/eCommerce code this would be used to register them for eStore/eCommerce.

Parameters

Name	DataType	Is Required
AccountID	Long	Optional*
Description	The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method. *Either an EcommID or AccountID is required
EcommID	Long	Optional*
Description	The account’s eCommerce ID number. *Either an EcommID or AccountID is required
Email	String	Required
Description	The email address for the primary contact. This is also used as a username if the site supports eStore or eCommerce.
FirstName	String	Optional*
Description	The given name for a personal account. *This is required if only passing in an AccountID.
LastName	String	Optional*
Description	The family name for a personal account. *This is required if only passing in an AccountID.
NewPassword	String	Required
Description	The new password/eCommerce code. For security it’s best to require 1 uppercase letter, 1 lowercase letter, 1 number and have a length of at least 7 characters. Special characters are also suggested. The length of the password/eCommerce code can be customized by the organization, you will need to check with them to confirm the information.
OrgID	Long	Required
Description	The organization’s ID number.

Returned Parameters

Name	DataType
Successful	Boolean
Description	Indicates that the password/eCommerce code was updated successfully (“True”) or that the password/eCommerce code failed to update (“False”).

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

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

Here is a sample code of the request object (including optional parameters):

// UpdateEcommPassword Request
request.OrgID = 123456;
request.AccountID = 123456;
request.EcommID = 123456; //acccountID and ecommID are now the same ID
request.FirstName = "John";
request.LastName = "Doe";
request.Email = "j.doe@a.c";
request.NewPassword = "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.UpdateEcommPassword(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, e-commerce, Permissions Tags: Password, Security

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

Older Entries

Yardi Store Developer eXchange

Archive

SWS UpdateGatePIN Method

Parameters

Returned Parameters

Example

SWS UpdateEcommPassword Method

Parameters

Returned Parameters

Example

SWS RetrievePassword Method

Parameters

Returned Parameters

Example

SWS ResetServicesPassword Method

Helpful Links

Meta

Tags