Home > API General, Site Administration > BulkData GetBulkSiteAddresses Method

BulkData GetBulkSiteAddresses Method


Retrieves a list of sites and their addresses that were created 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 start date of the date range for which you wish to retrieve the addresses.
EndDate DateTime Optional
Description The end date of the date range for which you wish to retrieve the addresses. This will default to today if left undefined.

Returned Parameters

Name Data Type
ADDRESS_ID Long
Description The address record’s ID number.
SITE_ID Long
Description The site’s ID number.
SITE_NAME String
Description The name of the site as it appears in Store.
ADDRESS_LABEL String
Description Not used.
LINE1 String
Description The first line for the site’s address.
LINE2 String
Description The second line for the site’s address.
LINE3 String
Description Not used.
CITY String
Description The city for the site’s address.
STATE String
Description The state/province for the site’s address.
POSTAL_CODE String
Description The ZIP/postal code for the site’s address.
COUNTRY String
Description The country for the site’s address.
CREATED_DATE DateTime
Description The date that the site was created.
CREATED_BY_ID Long
Description The user’s ID that created the site.
CREATED_BY_NAME  String
Description The first and last name of the user that created the site.
UPDATED_DATE DateTime
Description The date that the site was last updated.
UPDATED_BY_ID Long
Description The user’s ID that last updated the site information.
UPDATED_BY_NAME String
Description The first and last name of the user that last updated the site information.
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 retrieve our data. It’s a good idea to do this in a Try Catch block.

// Call the method that will load the response object
try
{
  BulkData.BulkSiteAddresses_Response response;
  response = service.GetBulkSiteAddresses(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: