BulkData GetBulkSiteAttributes Method
Retrieves the site attributes for all sites 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_ATTRIBUTE_ID | Long |
Description | The ID of the record containing the site attributes. |
SITE_ID | Long |
Description | The site’s ID number. |
SITE_NAME | String |
Description | The name of the site as it appears in Store. |
GATE_TYPE_NUM | Long |
Description | The numerical value for the gate system the site uses. |
GATE_TYPE_VAL | String |
Description | The textual value for the gate system the site uses. |
MAP_INDEX | String |
Description | The URL used to show the site’s location on a map. |
PHOTO_INDEX | String |
Description | The URL to the image used as the background for the site’s Store application. |
DIR_NORTH | String |
Description | The directions, if coming from the north, to the site. |
DIR_SOUTH | String |
Description | The directions, if coming from the south, to the site. |
DIR_EAST | String |
Description | The directions, if coming from the east, to the site. |
DIR_WEST | String |
Description | The directions, if coming from the west, to the site. |
SITE_HOURS | String |
Description | The site’s times that it is open for business. |
GATE_HOURS | String |
Description | The site’s hours that the gates are accessible. |
GATE_TEXT_FILE_LOC | String |
Description | The filepath where the gate file is sent to be read by the gates and updated. |
GATE_EXE_LOC | String |
Description | The filepath where the gates can be started. |
GATE_TIMEZONE | Integer |
Description | The code, from within the gate software, set up for regular business hours. |
GATE_24HR_CODE | Integer |
Description | The code, from within the gate software, set up for 24 hour access. |
CREATED_DATE | DateTime |
Description | The date the site’s attribute record was created. |
CREATED_BY_ID | Long |
Description | The user’s ID that first created the site’s attribute record. |
CREATED_BY_NAME | String |
Description | The user’s first and last name that first created the site’s attribute record. |
UPDATED_DATE | DateTime |
Description | The date the site’s attribute record was last updated. |
UPDATED_BY_ID | Long |
Description | The user’s name that last updated the site’s attribute record. |
UPDATED_BY_NAME | String |
Description | The user’s first and last name that last updated the site’s attribute record. |
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.BulkSiteAttributes_Response response;
response = service.GetBulkSiteAttributes(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.