Yardi Store Developer eXchange

This call may be used to GET or SET the SMS enabled status for RentalID/PhoneID record combinations for specified SiteID. This will update only one contact on the specified RentalID. A RentalID, PhoneID or both must be supplied in the parameters. Only records having RENTAL_STATUS of “CURRENT_OCCUPIED”, “DELINQUENT”, “IN_PROCESS”, “RESERVED” or “SOFT_RESERVED” will be reported or affected.

Parameters

Returned Parameters

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. At this point we need to create our objects. We’ll need the standard service object, a SiteID request object, an GetUpdatePhoneID request object, and a GetUpdateSMS response object. We can define and create those objects like this:

// Create the request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.SiteID_Request siteID_rqst = new SWS.SiteID_Request();
SWS.GetUpdatePhoneID_Request SMSphone_rqst = new
SWS.GetUpdatePhoneID_Request();
SWS.GetUpdateSMS_Response response = new SWS.GetUpdateSMS_Response ();

Now we set up the parameters for our request.

// SiteID Request- this is a required parameter
siteID_rqst.SiteID = 123456;
// Get_Set Request
// this is an optional parameter, “GET” is the default valueSMSphone.Get_Set = “GET”
// PhoneID Request 
// these are required parameters, you must set one or both in each 
elementSMSphone_rqst.PhoneIDs(0).RentalID = 234567;
SMSphone_rqst.PhoneIDs(0).PhoneID = 345678;

Finally we can call the method and pass across the login object and the request objects to get our resultant dataset. 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.PhoneSMSEnabledStatus(user_rqst, siteID_rqst, SMSphone_rqst);}
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.

This method returns SMS message data for a specified SiteID, with available filters based on AccountID, RentalID and/or date range.

Parameters

Returned Parameters

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. At this point we need to create our objects. We’ll need the standard service object, a SiteID request object, an AccountRental request object and a GetSMSMessageData response object. We can define and create those objects like this:

// Create the request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.SiteID_Request siteID_rqst = newSWS.SiteID_Request();
SWS.AccountRental_Request acctrental_rqst = new SWS.AccountRental_Request();
SWS.GetSMSMessageData_Response response = new SWS.GetSMSMessageData_Response();

Now we set up the parameters for our request.

// SiteID Request
siteID_rqst.SiteID = 123456;
// Account/Rental Request 
// these are optional parameters, you may set one, both or neither
acctrental_rqst.AccountID = 234567;
acctrental_rqst.RentalID = 345678;

Finally we can call the method and pass across the login object and the request objects to get our resultant dataset. 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.GetSMSMessageData(user_rqst, siteID_rqst,
acctrental_rqst);}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.

This method returns contact, address and phone information for site rentals with optional filtering based upon AccountID and/or RentalID. Candidate records must meet the following criteria:

• Primary contact is “TRUE”.
• Phone type is “MOBILE”.
• Rental status is “CURRENT_OCCUPIED”, “DELINQUENT”, “IN_PROCESS”, “RESERVED” or “SOFT_RESERVED”.

Parameters

Returned Parameters

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. At this point we need to create our objects. We’ll need the standard service object, a SiteID request object, an AccountRental request object and a GetSMSCandPhoneData response object. We can define and create those objects like this:

// Create the request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.SiteID_Request siteID_rqst = new SWS.SiteID_Request();
SWS.AccountRental_Request acctrental_rqst = new SWS.AccountRental_Request();
SWS.GetSMSCandPhoneData_Response response = new SWS.GetSMSCandPhoneData_Response();

Now we set up the parameters for our request.

// SiteID Request
siteID_rqst.SiteID = 123456;
// Account/Rental Request
// these are optional parameters, you may set one, both or neither
acctrental_rqst.AccountID = 234567;
acctrental_rqst.RentalID = 345678;

Finally we can call the method and pass across the login object and the request objects to get our resultant dataset. It’s a good idea to do this in a Try Catch block.

// Call the method that will load the response objecttry
{
response = service.GetSMSCandPhoneData(user_rqst, siteID_rqst, acctrental_rqst);
}
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.