[This is preliminary documentation and is subject to change.]

Returns the complete dataset for the requested service type. This call is valid for the following service types.
Entity(Id)Description
Tracker Binder(1)The OfficeClip Tracker Binder.
Tracker Issue(4)The OfficeClip Tracker Issue. A filter must be supplied in the form BinderId=1 (for example)
Task(8)The OfficeClip Task. Note that the subtype should be -1 for this call so this call returns all tasks.
Organization(13)The OfficeClip Organization. values of columnNumbers, filterName and sortClause must be passed as empty string and option must be passed as -1.
Event(14)The OfficeClip Calendar Events. Note that the subtype should be -1 for this call so this call returns all events.
Contact(18)The contact management metaentity. If the filter is specified, it should be in the format, Search:value or Filter:value. The first type does a search over all the records in the database and the second type searches by a filter that is created in OfficeClip.
Note(20)The OfficeClip Notes Entity. Note that the subtype should be -1 for this call so this call returns all notes.
Mail Merge Campaign(28)The mail merge campaign information. values of columnNumbers, filterName and sortClause must be passed as empty string and option must be passed as -1.
Template Parent Child(23)The parent child values of the template. The servicesubtyppe is the template type
System Information(30)Provides Session and System Information
Account(31)Account Information. If the option parameter is passed as 1, then only restricted accounts, i.e. the account that the current user can see in TE module, will be shown. If the option parameter is passed as -1, then all active accounts will be shown.
Project(32)The Project information. If the option parameter is passed as 1, then only restricted projects, i.e. the project that the current user can see in TE module, will be shown. If the option parameter is passed as -1, then all active projects will be shown. A non-administrator will always only see the restricted projects (regardless of the option value).
Service Item(33)Services Item information
Timesheet(34)Timesheet information
Expense(36)Timesheet information
Expense Type(38)Expense type information
Meta Information(39)Provides the meta information. The service subtype needs to be supplied, which is currently valid for Contact(18) and Tracker Binder(1) only. If the sub service type of Tracker Binder is used, a filter must be supplied in the form BinderId=1 (for example)
Payroll Category(40)Provides the payroll category

Namespace: �OfficeClip.Service.Web
Assembly: �OfficeClip.Service (in OfficeClip.Service)
Version: 8.1.1.0

Syntax

C#
public DataSet GetDataSet(
	int serviceType,
	int serviceSubType,
	string columnNames,
	string filterName,
	string sortClause,
	int option
)
Visual Basic (Declaration)
Public Function GetDataSet ( _
	serviceType As Integer, _
	serviceSubType As Integer, _
	columnNames As String, _
	filterName As String, _
	sortClause As String, _
	option As Integer _
) As DataSet
Visual C++
public:
DataSet^ GetDataSet(
	int serviceType, 
	int serviceSubType, 
	String^ columnNames, 
	String^ filterName, 
	String^ sortClause, 
	int option
)

Parameters

serviceType
Type: System..::.Int32
An integer that represents the service type for which the schema is desired.
serviceSubType
Type: System..::.Int32
The service subtype. A value of -1 is passed if there is no subtype
columnNames
Type: System..::.String
A comma separated list of column names to be sent to the output. Sends all the columns if empty.
filterName
Type: System..::.String
The name of the filter that is used to filter the data. Note that the filter name can be dependent on the implementation. Empty value returns all the data.
sortClause
Type: System..::.String
A sort clause in sql format (e.g. LastName DESC). Note that this may not be supported for all service ids. An empty string returns data sorted by a default order.
option
Type: System..::.Int32
A bit wise variable to pass various options. -1 must be passed in this field if the option is undefined.

Return Value

The dataset for the data requested. Normally the first table contains the requested data.

Examples

CopyGet the Organization data
public static DataSet GetOrganizationData(
 WebServiceClient.Generic.OfficeClipGeneric ofg
 )
{
 DataSet ds = null;
 try
 {
    // Service Type 13 is for organization data
    ds = ofg.GetDataSet(13, -1, string.Empty, string.Empty, string.Empty, -1);
 }
 catch (SoapException ex)
 {
    Console.WriteLine(ex.Message);
 }
 return ds;
}

See Also