Archive
SWS GetNotes Method
Retrieves account note data for a specified note or a collection of note data for a specified account. It will retrieve rental notes for a specified rental ID.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| AccountID | Long | Optional |
| Description | The accounts ID. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method. | |
| NoteID | Long | Optional |
| Description | The account note’s ID number. | |
| RentalID | Long | Optional |
| Description | The rental item’s ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBy method. | |
Returned Parameters
| Name | DataType |
|---|---|
| ACCT_ID | Long |
| Description | The account’s ID number. |
| ACCT_NAME | String |
| Description | The name on the account. This may differ from the primary contact’s name in some instances, such as a business account or a guardianship account. |
| CREATED | DateTime |
| Description | The creation date and time of the note. |
| CREATED_BY | String |
| Description | The Store user’s name that created the field. |
| CREATED_ID | Long |
| Description | The Store user’s ID number that created the document. |
| EXPIRES | DateTime |
| Description | The date by which the note can no longer be viewed. |
| NOTE | String |
| Description | The text content of the note. |
| NOTE_ID | Long |
| Description | The note’s ID number. |
| NOTE_TYPE | String |
| Description | The textual value of the TYPE_VAL. Available values:
|
| PRIORITY | String |
| Description | The textual value of the note’s priority. Available values:
|
| PRIORITY_VAL | Integer |
| Description | The numeric value of the note’s priority. Available values:
|
| RENTAL_ID | Long |
| Description | The rental item’s ID number. |
| RENTAL_STATUS | Integer |
| Description | The status of the rental item. |
| SUBJECT | String |
| Description | The subject text content of the created note. |
| TYPE_VAL | Integer |
| Description | The note type numeric identifier. Available values:
|
| UNIT_ID | String |
| Description | The unit’s ID number. This is maintained through rentals. |
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 GetNotes request object and a GetNotes response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetNotes_Request request = new SWS.GetNotes_Request();
SWS.GetNotes_Response response;
Here’s my sample code of the Request object using the Rental ID option.
// GetNotes Request
request.RentalID = 123456;
Finally we can call the method and pass across the login object and the request object to get our notes. 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.GetNotes(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.
SWS eUnitClass Method
Returns the site’s available rental revenue classes for a given site along with each unit type in that class.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| ACCT_CATEGORY | String |
| Description | The site’s revenue class category. |
| APPL_RENTAL_ OBJECTS_DETAIL_NonOccupiable |
APPL_RENTAL_OBJECTS_DETAIL |
| Description | The object details of a non-occupiable rental unit. (I.E., mailboxes.) |
| APPL_RENTAL_ OBJECTS_DETAIL_Occupiable |
APPL_RENTAL_OBJECTS_DETAIL |
| Description | The object details of an occupiable rental unit. |
| CLASS_DESC | String |
| Description | The textual description of the site’s revenue class. |
| CLASS_TYPE | Integer |
| Description | The numeric value for the site’s revenue class type. |
| ICON | String |
| Description | The URL for the site revenue class icon that displays in the Store application. |
| SITE_CLASS_ID | Long |
| Description | The site’s revenue class ID number that describes the general rules for the site. |
| SITE_ID | Long |
| Description | The site’s ID number. |
Example
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 and a eUnitClass response object. We can define and create those like this:Example
// Create request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.SITE_CLASSES[] response;
Finally we can call the method and pass in the site ID 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.eUnitClass(123456);
}
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.
SWS UpdateAccount Method
Updates an account and returns a copy of the updated record.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| AcctClass | AccountClass | Optional |
| Description | The class of the account. Available values:
|
|
| 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. | |
| AcctName | String | Optional |
| Description | The name on the account. This may differ from the primary contact’s name in some instances, such as a business account or a guardianship account. | |
| AcctType | AccountType | Optional |
| Description | The account type. Available values:
|
|
| Cflex01 | String | Optional |
| 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. | |
| Cflex02 | String | Optional |
| 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. | |
| Cflex03 | String | Optional |
| 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. | |
| Cflex04 | String | Optional |
| 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. | |
| Cflex05 | String | Optional |
| 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. | |
Returned Parameters
| Name | DataType |
|---|---|
| ACCT_CLASS | Integer |
| Description | The class of the account. Available values:
|
| ACCT_DEMOG | Integer |
| Description | The numeric value for the account demographic info. The account demographics can be customized by the organization. This parameter does not take advantage of the customization. |
| ACCT_ID | Long |
| Description | The account’s ID number. |
| ACCT_NAME | String |
| Description | The name on the account. This may differ from the primary contact’s name in some instances, such as a business account or a guardianship account. |
| ACCT_TYPE | Integer |
| Description | The account type. Available values:
|
| ACT_BUSINESS_CONTACT | ACT_CONTACTS_DEC |
| Description | A collection of contact data for all associated business contacts for the account. |
| ACT_CONTACTS_DEC | ACT_CONTACTS_DEC |
| Description | A collection of contact data for all associated contacts for the account. |
| ACT_NON_BUSINESS_CONTACTS | ACT_CONTACTS_DEC |
| Description | A collection of contact data for all associated non-business contacts for the account. |
| ADDR_ID | Long |
| Description | The address ID number for the contact’s address. |
| APPL_ACCT_CFLEX_DATA | APPL_ACCT_CFLEX_DATA |
| Description | A custom field, set up by the organization, designed to hold additional account level information. These are additional flex fields available beyond the normal account flex fields. These are viewed in the Store application, on the account information tab, by clicking the green circle with the white arrow. |
| APPL_ORG_FLEX_FIELDS | APPL_ORG_FLEX_FIELDS |
| 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. |
| 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 | s:string |
| Description | A custom field, set up by the organization, designed to hold additional contact information. This is not displayed in the Store application. |
| CREATED | DateTime |
| Description | The date the account record was created. |
| CREATED_BY | Long |
| Description | The user’s ID that created the account record. |
| ORG_ID | Long |
| Description | The organization’s ID to which the account belongs. |
| SITE_ID | Long |
| Description | The site’s ID to which the account belongs. |
| UPDATED | DateTime |
| Description | The date the account record was last updated. |
| UPDATED_BY | Long |
| Description | The user’s ID that last updated the account 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, an UpdateAccount request object, and an UpdateAccount response object. We can define and create those like this:
// request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.UpdateAccount_Request request = new SWS.UpdateAccount_Request();
SWS.UpdateAccount_Response response;
Here is a sample code of the request object:
// request for address and cflex01 updates
request.AcctId = 123456;
request.AccountAddressID = 123456;
request.Cflex01 = "Some new data here.";
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.UpdateAccount(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.
SWS CreateNotes Method
Creates a note for an account and can refer to a specific rental item. Returns the note’s ID number.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| AccountID | 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. | |
| Expires | DateTime | Optional |
| Description | The date the note will expire and no longer be available to view in the application. Default is “Null”. If “Null” and the note is flagged as “Priority”, the default is 2 days from the date of creation. If the note is NOT “Priority” and no expiration date is provided, the note never expires. | |
| HighPriority | Boolean | Optional |
| Description | Flags the note as a priority (“True”) or not (“False”). Default is “False”. | |
| Note | String | Required |
| Description | The text of the notes to be added. Max string length of 2500. | |
| RentalID | Long | Optional |
| Description | The rental item’s ID number. If the note needs to apply to a specific rental on the account, the rental ID of that rental is required. This is returned when using the MakeReservation method or can be searched for using the SearchBy method. | |
| Subject | String | Required |
| Description | The account notes subject line. Max string length is 30. | |
Returned Parameters
| Name | DataType |
|---|---|
| NoteID | Long |
| Description | The account note’s system ID number. |
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 CreateNotes request object and a CreateNotes response object. We can define and create those like this:
// Create request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.CreateNotes_Request request = new SWS.CreateNotes_Request();
SWS.CreateNotes_Response response;
Here’s my sample code of the Request object.
// note request
request.Subject = "Test Note";
request.Note = "Thies is a test note. Please ignore.";
request.HighPriority = false;
request.AccountID = 123456;
Finally we can call the method and pass across the login object and the request object to create our notes. 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.CreateNotes(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.
Yardi Store Developer eXchange 