Archive

Archive for the ‘Notes’ Category

BulkData GetBulkNotes Method

April 13, 2017 Leave a comment

Retrieves the list of notes, 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 notes. 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 notes. This will default to SYSDATE if left undefined.

Returned Parameters

Name Data Type
NOTE_ID Long
Description The note’s ID number.
ACCOUNT_ID Long
Description The account’s ID number.
ACCOUNT_NAME String
Description The account’s name. This may differ from the primary contact’s name in some instances.
RENTAL_ID Long
Description The rental’s ID number.
NOTE_SUBJECT String
Description The subject of the note.
NOTE_TYPE_NUM Integer
Description The numeric value of the note type.
NOTE_TYPE_VAL String
Description The textual value of the note type.
NOTE_PRIORITY_NUM Integer
Description The numeric value of the priority level of the note.
NOTE_PRIORITY_VAL String
Description The textual valueo f the priority level of the note.
NOTE_TEXT String
Description The message entered as the note.
NOTE_EXPIRATION DateTime
Description The date that a note will no longer be visible in the system.
CREATED_DATE DateTime
Description The date the note was created.
CREATED_BY_ID Long
Description The user’s ID that created the note.
CREATED_BY_NAME String
Description The first and last name of the user that created the note.
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.BulkNotes_Response response;
  response = service.GetBulkNotes(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: API General, Notes

SWS CreateNotes Method

April 29, 2011 Leave a comment

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.

Categories: API General, Notes Tags: ,