Home > API General, Data Carve > BulkData GetCarveTableList Method

BulkData GetCarveTableList Method


Retrieves a list of available carve data tables that can be retrieved using the GetCarveData method. To use this method the organization must have access to the carve and the API user must have permissions to the carve data.

Parameters

Name Data Type Is Required
OrgID Long Required
Description The organization’s ID number.

Returned Parameters

Name Data Type
Table Elements Collection
Description The list of columns in the table containing the available views.
CarveTableList Collection
Description The list of tables that are available to be retrieved as well as some information about the tables.

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.GetCarveTableList_Request request = new BulkData.GetCarveTableList_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;

Finally we can call the method and pass across the login object and the request object to retrieve the data. It’s a good idea to do this in a Try Catch block.

// Call the method that will load the response object
try
{
  System.Data.DataTable response;
  response = service.GetCarveTableList(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.

Categories: API General, Data Carve
  1. Chirag Rajput
    July 6, 2018 at 6:55 am

    Always getting following error

    SoapFault: Server was unable to process request. —> Carve Web Service

  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: