Home > API General, Notes > BulkData GetBulkNotes Method

BulkData GetBulkNotes Method


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
  1. No comments yet.
  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: