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