Yardi Store Developer eXchange

Try
‘ Call the method that will load the response object
objRes = objService.UpdateRental(objLogin, objReq)

‘ Bind your result data to object
Me.DataGridView1.DataSource = objRes.Details
Me.DataGridView1.Refresh()

Catch ex As Exception
MessageBox.Show(ex.Message)

End Try

C# Example (SOAP):

//Create the main Web Services object
SWS.WS ws = new SWS.WSClient();

//Create and set the authentication credentials
SWS.LookupUser_Request lookupUser = new SWS.LookupUser_Request();
lookupUser.Username = “Username”;
lookupUser.Password = “Password”;
lookupUser.Channel = 1;

//Create the method’s request object
SWS.GetPrimaryRentalInfo_Request request = new SWS.GetPrimaryRentalInfo_Request();

//Set required parameters
request.AccountID = 123;
request.SiteID = 1234;

//Create the method’s response object
SWS.GetPrimaryRentalInfo_Response response;

try
{
//Call the method and set its value to the response object
response = ws.GetPrimaryRentalInfo(lookupUser, request);

foreach (SWS.SOA_GET_PRIMARY_RENTAL_INFO thisres in response.Details)
{
MessageBox.Show(thisres.ACCT_NAME);
}
}
catch
{
//Error handling here.
}

The first step is to create a new WS object. This will correspond to the name that you specified when creating your web method.

//Create the main Web Services object
SWS.WS ws = new SWS.WSClient();

The basic concept is an object orientated approach of creating a request object, setting the parameters of this request, calling the method and loading the results into a response object. The response will usually be a collection of data that can be bound to display objects.

Each method call requires authentication and takes as parameter a login object which contains a username and password. You can create this object once and pass this into all methods you call.

//Create and set the authentication credentials
SWS.LookupUser_Request lookupUser = new SWS.LookupUser_Request();
lookupUser.Username = “Username”;
lookupUser.Password = “Password”;
lookupUser.Channel = 1;

You then create a request object and set any required parameters. The required parameters are specified for each method in this document. The method will also give you an error message if all required parameters are not set.

//Create the method’s request object
SWS.GetPrimaryRentalInfo_Request request = new SWS.GetPrimaryRentalInfo_Request();

//Set required parameters
request.AccountID = 123;
request.SiteID = 1234;

Now create the response object and call the desired method passing in this login object and the request object.

try
{
//Call the method and set its value to the response object
response = ws.GetPrimaryRentalInfo(lookupUser, request);

foreach (SWS.SOA_GET_PRIMARY_RENTAL_INFO thisres in response.Details)
{
MessageBox.Show(thisres.ACCT_NAME);
}
}
catch
{
//Error handling here.
}

Always use error handling to catch any problems with your method call. Each SWS method will throw specific error messages to help verify the correct data is passed in. For help with “unknown errors” please contact a SWS representative.

This is the basic methodology of all SWS methods. This Sample code is provided to show you how a SWS method should be called. Each method has the possibility of variations.