Account Management | Yardi Store Developer eXchange

SWS GetCertifiedLetterInfo Method

September 8, 2011 sutiki 1 comment

Retrieves certified letter tracking information for a specified letter. This includes the letter ID, date, name, binary .pdf data and USPS tracking number (BARCODE).

Parameters

Name	DataType	Is Required
AcctID	Long	Required
Description	The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method.
LetterID	Long	Required
Description	The certified letter’s ID number. This can be found using the GetLetterInfo method.

Returned Parameters

Name	DataType
BARCODE	String
Description	The barcode number affixed to the certified letter by the USPS for tracking purposes.
EFILE_PDF	Base64Binary
Description	The eFile .pdf in encrypted Base64Binary code. This is the .PDF information sent to our centralized mailing company.
EVENT_NAME	String
Description	The template name of the certified letter to be mailed.
EVENTDATE	String
Description	The schedule date by which the certified letter should be mailed.
LETTER_ID	Long
Description	The certified letter’s ID number.
SIGNPDF	Boolean
Description	Indicates if the certified mail will require a signature (“True”) or not (“False”).
ERROR_CODE	Integer
Description	The numerical value of the status of the letter.
ERROR_REASON	String
Description	The textual value of the status of the letter.

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

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

Here’s my sample code of the Request object.

// GetCertifiedLetterInfo Request
request.AccountID = 123456;
request.LetterID = 123456;

Finally we can call the method and pass across the login object and the request object to perform our method. 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.GetCertifiedLetterInfo(user_request,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: Account Management, Delinquency, Letters

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 UpdatePhone Method

May 29, 2011 cencanderson Leave a comment

Updates a rental contact’s phone number and returns a copy of the updated record.

Parameters

Name	DataType	Is Required
Active	Boolean	Optional
Description	Updates the phone number to be active on the contact (“True”) or inactive on the contact (“False”).
ContactId	Long	Optional
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.
Phone	String	Optional
Description	The rental contact’s phone number.
PhoneId	Long	Required
Description	The phone number’s ID number that you wish to update.
PhoneType	PhoneType	Optional
Description	Updates the phone number type. Available values: HOME OFFICE MOBILE FAX OTHER

Returned Parameters

Name	DataType
ACTIVE	Boolean
Description	Indicates if the phone number is active for the contact (“True”) or not (“False”).
CONTACT_ID	Long
Description	The rental contact’s ID number.
CREATED	DateTime
Description	The date and time the phone record was originally created.
CREATED_BY	Long
Description	The user’s ID that originally created the phone record.
PHONE	String
Description	The phone number of the record that was updated.
PHONE_ID	Long
Description	The phone number’s ID number that was updated.
PHONE_TYPE	Integer
Description	The numeric value for the type of phone number. Available values: 1 – HOME 2 – OFFICE 3 – MOBILE 4 – FAX 5 – OTHER
UPDATED	DateTime
Description	The date and time the phone record was last updated.
UPDATED_BY	Long
Description	The user’s ID that last updated the phone record.

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

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

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

// UpdatePhone Request
request.PhoneId = 123456;
request.Phone = "800-555-1212";

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.UpdatePhone(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 Tags: Address, Contacts, Phone

Newer Entries Older Entries

Yardi Store Developer eXchange

Archive

SWS GetCertifiedLetterInfo Method

Parameters

Returned Parameters

Example

SWS UpdateGatePIN Method

Parameters

Returned Parameters

Example

SWS UpdateEcommPassword Method

Parameters

Returned Parameters

Example

SWS UpdatePhone Method

Parameters

Returned Parameters

Example

Helpful Links

Meta

Tags