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

Gets a data based on a key. This call is valid for the following service types. This call accepts a space separated list of sid and returns the data in the datatable. If a particular sid data cannot be extracted, it sets the tag column of the dataset to the error string (otherwise the tag column is set to an empty string).
Entity(Id)Description
Task(8)The OfficeClip Task. If a subtype is specified then the sids supplied should be of that subtype. Only tasks that corresponds to the subtype will be returned.
Organization(13)The OfficeClip Organization
Event(14)The OfficeClip Calendar Events. If a subtype is specified then the sids supplied should be of that subtype. Only events that corresponds to the subtype will be returned.
Contact(18)The contact management metaentity
Note(20)The OfficeClip Notes Entity. If a subtype is specified then the sids supplied should be of that subtype. Only notes that corresponds to the subtype will be returned.
Template Parent Child(23)The parent child values of the template. The servicesubtyppe is the template type
Template Key Value(27)The Template key value information (used to merge a template). The serviceSubType of 15 represents the template type of ContactManager
Mail Merge Campaign Recipients(29)The mail merge campaign recipient information, the serviceSubType should be sent as -1, the primaryKey is the campaignId
Timesheet(34)Timesheet information.
Timesheet Detail(35)Timesheet Detail information. The service subtype for this type is Timesheet (34)
Expense(36)Expense information.
Expense Detail(37)Expense Detail information. The service subtype for this type is Expense (36)

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

Syntax

C#
public DataSet GetDataByKey(
	int serviceType,
	int serviceSubType,
	string sids
)
Visual Basic (Declaration)
Public Function GetDataByKey ( _
	serviceType As Integer, _
	serviceSubType As Integer, _
	sids As String _
) As DataSet
Visual C++
public:
DataSet^ GetDataByKey(
	int serviceType, 
	int serviceSubType, 
	String^ sids
)

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 (if present, otherwise the value is -1)
sids
Type: System..::.String
A space separated list of sid for which the data is requested.

Return Value

The dataset for the data requested. Normally the first table contains the requested data. If one of the sid returns an error, the tag field will contain the error. Consuming application must check the tag field before proceeding with the data

Examples

CopyGets the template parent child for contacts
public static DataSet GetTemplateParentChild(
 WebServiceClient.Generic.OfficeClipGeneric ofg
 )
{
 DataSet ds = null;
 try
 {
    // Service Type 23 is for parent child template
    // Service sub type of 15 is for template type contact
    ds = ofg.GetDataSet(23, 15, string.Empty, string.Empty, string.Empty, -1);
 }
 catch (SoapException ex)
 {
    Console.WriteLine(ex.Message);
 }
 return ds;
}

See Also