Home > API General, Site Administration > BulkData GetBulkSites Method

BulkData GetBulkSites Method


Retrieves a list of sites who’s information has been updated within 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
PROPERTY_TYPE_NUM Integer
Description The numeric value of the property type.
PROPERTY_TYPE_VAL String
Description The textual value of the property type.
ORG_NUMBER_XREF String
Description The site’s number this is assigned by the admin when the site is created and is not the site ID.
TIMEZONE_OFFSET Integer
Description The number of hours from Mountain time that the site is located.
TIMEZONE_DISP_OFFSET Integer
Description The number of hours from Mountain time that the site is located. This may differ if the site is located in a different location from the accounting software used for the site.
FLEX_01 String
Description A custom field, set up by the organization, designed to hold additional site information. This is not displayed in the Store application.
FLEX_02 String
Description A custom field, set up by the organization, designed to hold additional site information. This is not displayed in the Store application.
FLEX_03 String
Description A custom field, set up by the organization, designed to hold additional site information. This is not displayed in the Store application.
CREATED_DATE DateTime
Description The date 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 information 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.
FRANCHISE_NAME String
Description The name of the franchise to which the site belongs.
ABBREVIATED_NAME String
Description The shortened name of the site.
LEASE_NAME String
Description The name of the site as it should appear on leases.
SITE_ID Long
Description The site’s ID number.
AFFILIATE_ID Long
Description The ID of the organization to which the site is affiliated with but not owned by.
PARENT_SITE_ID Long
Description The site ID of the main site if this is a satellite location.
SITE_NAME String
Description The name of the site as it appears in the Store application.
DISPLAY_NAME String
Description The name that the site would like to be known by.

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.BulkSites_Response response;
  response = service.GetBulkSites(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: