Home > API General, Site Administration > BulkData GetBulkSitePhones Method

BulkData GetBulkSitePhones Method


Retrieves a list of site phone records that have been updated in the last 96 hours.

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
SITE_ID Long
Description The site’s ID number
SITE_NAME String
Description The site’s name as it appears in the Store application.
PHONE String
Description The site’s primary phone number.
FAX String
Description The site’s fax number.
ALT_PHONE String
Description The site’s secondary or alternate phone number.
EMAIL_ADDRESS String
Description The site’s email address.
CREATED_DATE DateTime
Description The date the site’s phone record was created.
CREATED_BY_ID Long
Description The user’s ID that created the phone record.
CREATED_BY_NAME String
Description The user’s first and last name that created the phone record.
UPDATED_DATE DateTime
Description The date the site’s phone record was last updated.
UPDATED_BY_ID Long
Description The user’s ID that last updated the phone record for the site.
UPDATED_BY_NAME String
Description The first and last name of the user that last updated the phone record for the site.
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 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.BulkSitePhones_Response response;
  response = service.GetBulkSitePhones(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.

  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: