Account Management | Yardi Store Developer eXchange

BulkData GetBulkPhones Method

April 13, 2017 Becky Leave a comment

Retrieves the list of phone numbers, created at the organization, up to 96 hours in the past. Empty fields will not be returned.

Parameters

Name	Data Type	Is Required
OrgID	Long	Required
Description	The organization’s ID number.
BeginDate	DateTime	Required
Description	The beginning date of the date range for which to pull the list of new phone numbers. This date cannot be more then 96 hours in the past.
EndDate	DateTime	Optional
Description	The end date of the date range for which to pull the list of new phone numbers. This will default to SYSDATE if left undefined.

Returned Parameters

Name	Data Type
PHONE_ID	Long
Description	The phone numbers ID number.
CONTACT_ID	Long
Description	The contact’s ID number.
ACCOUNT_ID	Long
Description	The account’s ID number.
PHONE_TYPE_NUM	Integer
Description	The numeric value of the phone number type. Available values: 1 – Home 2 – Office 3 – Mobile 4 – Fax 5 – Other
PHONE_TYPE_VAL	String
Description	The textual value of the phone number type. Available values: Home – 1 Office – 2 Mobile – 3 Fax – 4 Other – 5
PHONE_NUMBER	String
Description	The contact’s phone number.
ACTIVE	Boolean
Description	Indicates if the phone number is active (“True”) or not (“False”).
CREATED_DATE	DateTime
Description	The date the phone number was initially created.
CREATED_BY_ID	Long
Description	The user’s ID that created the phone record.
CREATED_BY_NAME	String
Description	The first and last name of the user that created the phone record.
UPDATED_DATE	DateTime
Description	The date the phone record was last updated.
UPDATED_BY_ID	Long
Description	The user’s ID that last updated the phone record.
UPDATED_BY_NAME	String
Description	The first and last name of the user that last updated the phone record.
ORG_ID	Long
Description	The organization’s ID number.

Example

We’ll assume you’ve got a web reference, let’s name it BulkData, in your Visual Studio project. At this point we need to our objects. We’ll need the standard service object, a user request object and a data request object. We can define and create those like this:

// Create request and response objects
BulkData.LookupUser_Request user_request = new BulkData.LookupUser_Request();
BulkData.BulkDataSoapClient service = new BulkData.BulkDataSoapClient();
BulkData.BulkData_Request request = new BulkData.BulkData_Request();

Here’s my sample code of the Request and user objects.

// request
user_request.Username = "user";
user_request.Password = "pass";
user_request.Channel = 999;

request.OrgID = 123546;
request.BeginDate = DateTime.Today.AddDays(-1);
request.BeginDate = DateTime.Today;

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

// Call the method that will load the response object
try
{
  BulkData.BulkPhones_Response response;
  response = service.GetBulkPhones(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 BulkData Methods.

Categories: Account Management, API General

BulkData GetBulkAddresses Method

April 13, 2017 Becky Leave a comment

Retrieves the list of addresses, created at the organization, up to 96 hours in the past. Empty fields will not be returned.

Parameters

Name	Data Type	Is Required
OrgID	Long	Required
Description	The organization’s ID number.
BeginDate	DateTime	Required
Description	The beginning date of the date range for which to retrieve the address list. This cannot be more than 96 hours in the past.
EndDate	DateTime	Optional
Description	The end date of the date range for which to retrieve the address list. This will default to SYSDATE if left undefined.

Returned Parameters

Name	Data Type
ADDRESS_ID	Long
Description	The address record’s ID number.
CONTACT_ID	Long
Description	The rental contact’s ID number.
ACCOUNT_ID	Long
Description	The account’s ID number.
ADDR_TYPE_NUM	Integer
Description	The numeric value of the address type.
ADDR_TYPE_VAL	String
Description	The textual value of the address type.
ADDR_LINE1	String
Description	The first line of the address.
ADDR_LINE2	String
Description	The second line of the address.
ADDR_LINE3	String
Description	The third line of the address.
ADDR_CITY	String
Description	The city for the address.
ADDR_STATE	String
Description	The state/province for the address.
ADDR_COUNTRY	String
Description	The country for the address.
ADDR_POSTAL_CODE	String
Description	The ZIP/postal code for the address.
ADDR_ACTIVE	Boolean
Description	Indicates if the address is active (“True”) or not (“False”).
CREATED_DATE	DateTime
Description	The date the address was created.
CREATED_BY_ID	Long
Description	The user’s ID that created the address.
CREATED_BY_NAME	String
Description	The first and last name of the user that created the address.
UPDATED_DATE	DateTime
Description	The date that the address was last updated.
UPDATED_BY_ID	Long
Description	The user’s ID that last updated the address.
UPDATED_BY_NAME	String
Description	The first and last name of the user who last updated the address.
ORG_ID	Long
Description	The organization’s ID number.

Example

// Create request and response objects
BulkData.LookupUser_Request user_request = new BulkData.LookupUser_Request();
BulkData.BulkDataSoapClient service = new BulkData.BulkDataSoapClient();
BulkData.BulkData_Request request = new BulkData.BulkData_Request();

Here’s my sample code of the Request and user objects.

// request
user_request.Username = "user";
user_request.Password = "pass";
user_request.Channel = 999;

request.OrgID = 123546;
request.BeginDate = DateTime.Today.AddDays(-1);
request.BeginDate = DateTime.Today;

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

// Call the method that will load the response object
try
{
  BulkData.BulkAddresses_Response response;
  response = service.GetBulkAddresses(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 BulkData Methods.

Categories: Account Management, API General

BulkData GetBulkAccounts Method

April 13, 2017 Becky Leave a comment

Retrieves the list of accounts, created at the organization, up to 96 hours in the past. Empty fields will not be returned.

Parameters

Name	Data Type	Is Required
OrgID	Long	Required
Description	The organization’s ID number.
BeginDate	DateTime	Required
Description	The beginning date of the date range for which to pull the list of new accounts. This date cannot be more then 96 hours in the past.
EndDate	DateTime	Optional
Description	The end date of the date range for which to pull the list of new accounts. This will default to SYSDATE if left undefined.

Returned Parameters

Name	Data Type
ACCOUNT_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.
ACCOUNT_NAME	String
Description	The name on the account. This may differ from the primary contact in some instances.
ACCOUNT_TYPE_NUM	Integer
Description	The numeric value for the account type of the account.
ACCOUNT_TYPE_VAL	String
Description	The textual value for the account type of the account.
ACCOUNT_CLASS_NUM	Integer
Description	The numeric value for the class of the account.
ACCOUNT_CLASS_VAL	String
Description	The textual value for the class of the account.
ACCOUNT_DEMOGRAPHIC_NUM	Integer
Description	The numeric value for the demographics of the account.
ACCOUNT_DEMOGRAPHIC_VAL	String
Description	The textual value for the demographics of the account
FLEX_01	String
Description	A custom field, set up by the organization, designed to hold additional account level information. This is displayed in the “Account Information” tab of the account in the Store application.
FLEX_02	String
Description	A custom field, set up by the organization, designed to hold additional account level information. This is displayed in the “Account Information” tab of the account in the Store application.
FLEX_03	String
Description	A custom field, set up by the organization, designed to hold additional account level information. This is displayed in the “Account Information” tab of the account in the Store application.
FLEX_04	String
Description	A custom field, set up by the organization, designed to hold additional account level information. This is displayed in the “Account Information” tab of the account in the Store application.
FLEX_05	String
Description	A custom field, set up by the organization, designed to hold additional account level information. This is displayed in the “Account Information” tab of the account in the Store application.
SITE_ID	Long
Description	The site to which the account belongs.
SITE_NAME	String
Description	The name of the site as it appears in the Store application.
ACCOUNT_ADDRESS_ID	Long
Description	If the account is set up for consolidated billing, this is the ID of the address record where the invoice is sent.
CREATED_DATE	DateTime
Description	The date the account was initially created.
CREATED_BY_ID	Long
Description	The user’s ID that created the account.
CREATED_BY_NAME	String
Description	The first and last name of the user that created the account.
UPDATED_DATE	DateTime
Description	The date that the account was last updated.
UPDATED_BY_ID	Long
Description	The user’s ID that most recently updated the account.
UPDATED_BY_NAME	String
Description	The first and last name of the user that most recently updated the account.
ORG_ID	Long
Description	The organization’s ID number.

Example

// Create request and response objects
BulkData.LookupUser_Request user_request = new BulkData.LookupUser_Request();
BulkData.BulkDataSoapClient service = new BulkData.BulkDataSoapClient();
BulkData.BulkData_Request request = new BulkData.BulkData_Request();

Here’s my sample code of the Request and user objects.

// request
user_request.Username = "user";
user_request.Password = "pass";
user_request.Channel = 999;

request.OrgID = 123546;
request.BeginDate = DateTime.Today.AddDays(-1);
request.BeginDate = DateTime.Today;

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

// Call the method that will load the response object
try
{
  BulkData.BulkAccounts_Response response;
  response = service.GetBulkAccounts(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 BulkData Methods.

Categories: Account Management, API General

SWS CancelReservationV3 Method

September 20, 2016 Becky Leave a comment

Cancels a reservation made for specified rental item(s) and/or quote(s). Returns data regarding possible refunds. Note: If the rental contact information is not supplied and the refund data indicates a refund should be processed, the contact information will default to the rental item(s)’ primary contact information. It also lets you retain the refund which was not possible in the original method. This method also allows you to use the organizations customized LostDemandReason, rather than using the applications presets.

Parameters

Name	Data Type	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.
RentalIDS	Long	Required
Description	The rental items id numbers. This can be an array if there are multiple rentals that need to be cancelled. This is returned when using the MakeReservation method or can be searched for using the SearchBy method.
QuoteIDs	Long	Required
Description	The quote’s ID number. This can be an array of quotes if there are multiple quotes that need to be cancelled. This is returned when processing the MakeReservation method or can be retrieved using the GetReservations method.
LostDemandReason	Integer	Required
Description	The lost demand reason as to why a potential customer failed to initiate a rental. You will need to contact the site for their customized list.
LostDemandNotes	String	Required
Description	The free text note as to why a potential customer failed to initiate a rental. Max string length of 500.
DenyDepositRefund	Boolean	Required
Description	Indicates if the refund should be retained. True retains the refund, false refunds with cash,credit or check. Defaults to false.
DenyRefundReason	String	Required
Description	The reason for denying a customer’s refund (i.e., Delinquent on other rentals). Max string length of 500.
ContactData	ContactInfo	Optional
Description	The object containing the contact information. If no information is entered here the primary contact info is used as default.

Returned Parameters

Name	Data Type
ObjectId	Long
Description	The rental item’s ID number.
TranID	String
Description	The transaction’s ID number. Transaction IDs are system generated for each payment transaction that occurs in the system. A null or “0” response indicates the transaction failed.
HasDeposit	Boolean
Description	Indicates if the reservation has a refundable deposit (“True”) or not (“False”).
AvailableRefundAmount	Decimal
Description	The processed refund amount, if warranted.
Succeeded	Boolean
Description	Indicates if the cancellation was succesful (“True”) or not (“False”).
ErrorMessage	String
Description	A message about any problem that occurred during the process, including details to locate errant code.
RefundMessage	String
Description	The message associated with the success or failure of processing the refund.

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 our objects. We’ll need the standard service object, a CancelReservationV3 request object and a CancelReservation response object. We can define and create those like this:

// Create a request and response objects and ContactInfo object.
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.CancelReservationV3_Request request = new SWS.CancelReservationV3_Request();
SWS.CancelReservation_Response response;

SWS.ContactInfo contact_info = new SWS.ContactInfo();

Here’s my sample code of the Request object.

// Contact Data
contact_info.AccountID = 123456;
contact_info.Address1 = "123 Main St.";
contact_info.City = "My Town";
contact_info.State = "UT";
contact_info.PostalCode = "00000";
contact_info.ContactName = "First Last";

// To cancel reservations(s)
request.AcctID = 123456;
request.RentalIDs = new long[] { 123456, 654321 };
request.LostDemandReason = 10001;
request.LostDemandNotes = "Unit size no longer available";
request.ContactData = contact_info;
request.DenyDepositRefund = true;
request.DenyRefundReason = "They were told the amount was non-refundable.";

Finally we can call the method and pass across the login object and the request object to cancel the reservation. 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.CancelReservationV3(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, API General, End Rental/Moveout

Older Entries

Yardi Store Developer eXchange

Archive

BulkData GetBulkPhones Method

Parameters

Returned Parameters

Example

BulkData GetBulkAddresses Method

Parameters

Returned Parameters

Example

BulkData GetBulkAccounts Method

Parameters

Returned Parameters

Example

SWS CancelReservationV3 Method

Parameters

Returned Parameters

Example

Helpful Links

Meta

Tags