BulkData GetBulkPhones Method
Retrieves the list of phone numbers, created at the organization, up to 96 hours in the past. 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 phone numbers. 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 phone numbers. This will default to SYSDATE if left undefined. | |
Returned Parameters
| Name | Data Type |
|---|---|
| PHONE_ID | Long |
| Description | The phone numbers ID number. |
| CONTACT_ID | Long |
| Description | The contact’s ID number. |
| ACCOUNT_ID | Long |
| Description | The account’s ID number. |
| PHONE_TYPE_NUM | Integer |
| Description | The numeric value of the phone number type. Available values:
|
| PHONE_TYPE_VAL | String |
| Description | The textual value of the phone number type. Available values:
|
| PHONE_NUMBER | String |
| Description | The contact’s phone number. |
| ACTIVE | Boolean |
| Description | Indicates if the phone number is active (“True”) or not (“False”). |
| CREATED_DATE | DateTime |
| Description | The date the phone number was initially created. |
| CREATED_BY_ID | Long |
| Description | The user’s ID that created the phone record. |
| CREATED_BY_NAME | String |
| Description | The first and last name of the user that created the phone record. |
| UPDATED_DATE | DateTime |
| Description | The date the phone record was last updated. |
| UPDATED_BY_ID | Long |
| Description | The user’s ID that last updated the phone record. |
| UPDATED_BY_NAME | String |
| Description | The first and last name of the user that last updated the phone 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 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.BulkPhones_Response response;
response = service.GetBulkPhones(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.
Yardi Store Developer eXchange 