BulkData GetBulkContacts Method
Retrieves the list of contacts, created at the organization, up to 96 hours in the past. This will retrieve all contacts on an account. 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 contacts. 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 contacts. This will default to SYSDATE if left undefined. |
Returned Parameters
Name | Data Type |
---|---|
CONTACT_ID | Long |
Description | The contact’s ID number. |
ACCOUNT_ID | Long |
Description | The account’s ID number. |
ACCOUNT_NAME | String |
Description | The name on the account. This may differ from the primary contact in some instances. |
FIRST_NAME | String |
Description | The contact’s first name. |
LAST_NAME | String |
Description | The contact’s last name. |
KNOWN_AS | String |
Description | The name by which the customer prefers to be called. |
CONTACT_TYPE_NUM | Integer |
Description | The numeric value of the contact type. Available values:
|
CONTACT_TYPE_VAL | String |
Description | The textual value of the contact type. Available values:
|
EMPLOYER | String |
Description | The customer’s current employer. |
ACTIVE | Boolean |
Description | Indicates if the contact is active (“True”) or not (“False”). |
String | |
Description | The contact’s email address. This is the customer’s username if eStore/eCommerce are supported. |
ECOMM_CODE | String |
Description | No longer returned. |
FLEX_01 | String |
Description | A custom field, set up by the organization, designed to hold additional contact 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 contact 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 contact information. This is not displayed in the Store application. |
FLEX_04 | String |
Description | A custom field, set up by the organization, designed to hold additional contact information. This is not displayed in the Store application. |
FLEX_05 | String |
Description | A custom field, set up by the organization, designed to hold additional contact information. This is not displayed in the Store application. |
CREATED_DATE | DateTime |
Description | The date the contact was created. |
CREATED_BY_ID | Long |
Description | The user’s ID that created the contact. |
CREATED_BY_NAME | String |
Description | The first and last name of the user that created the contact. |
UPDATED_DATE | DateTime |
Description | The date the contact was last updated. |
UPDATED_BY_ID | Long |
Description | The user’s ID that last updated the contact. |
UPDATED_BY_NAME | String |
Description | The user’s first and last name that last updated the contact. |
ORG_ID | Long |
Description | The organizations 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.BulkContacts_Response response;
response = service.GetBulkContacts(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.