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

The Driver type exposes the following members.

Constructors

� NameDescription
Public methodDriver

Methods

� NameDescription
Public methodDelete
Deletes a row in the OfficeClip based on the service id.
Service Item(Id)Description
Task(8)The OfficeClip Task. The Service subtype for this type is the Contact(18) and Account(31)
Event(14)The OfficeClip Calendar Events. The Service subtype for this type is the Contact(18) and Account(31)
Contact(18)The contact management metaentity
Note(20)The OfficeClip Notes Entity. The Service subtype for this type is the Contact(18) and Account(31)
Attachment(24)Document attachments with various applications
Mail Merge Campaign(28)The mail merge campaign information
Account(31)Account Information
Project(32)Project information
Service Item(33)Services Item information
Expense(36)Expense information
Expense Type(38)The expense type information
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetDataByKey
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)
Public methodGetDataSet
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
Public methodGetHashCode
Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetXmlData
Returns the Xml for the requested service type. This call is valid for all the service types of the GetDataSet call (see GetDataSet(Int32, Int32, String, String, String, Int32). The output is just an xml string instead of the dataset.
Public methodGetXmlDataByKey
Gets the xml string of a single row of data. This call is valid for all the service types of the GetDataSet call (see GetDataByKey(Int32, Int32, String). The output is just an xml string instead of the dataset.
Public methodGetXmlSchema
Gets the Xml Schema for a particular service type. If the service group is not implemented, a SOAPException is thrown. This call is valid for all the service types that are implemented (see class description).
Public methodInsert
Inserts data into OfficeClip based on a service type. This call is valid for the following service types.
Entity(Id)Description
Tracker Issue(4)The OfficeClip Tracker Issue. Note that the binder Sid must be supplied for each row in order to insert the issue in a binder.
Task(8)The OfficeClip Task. The Service subtype for this type is the Contact(18) and Account(31)
Event(14)The OfficeClip Calendar Events. The Service subtype for this type is the Contact(18) and Account(31)
Contact(18)The contact management metaentity
Note(20)The OfficeClip Notes Entity. The Service subtype for this type is the Contact(18) and Account(31)
Attachment(24)Document attachments with various applications
Mail Merge Campaign(28)The mail merge campaign information
Timesheet(34)Timesheet information. Note that the endDate of the period will automatically be calculated. It will return an error if the startDate is not within a range of valid startDate for the timesheet.
Timesheet Detail(35)Timesheet Detail information
Expense(36)Expense information
Expense Detail(37)Expense Detail information. The service subtype for this type is Expense (36)
Public methodInsertXml
Inserts data into OfficeClip based on a service type. This call is same as the Insert call (that accepts a dataset as a parameter), the only difference is that this call accepts a serialized dataset. See description of the Insert call to find out which service items are accepted by this call.
Public methodIsSessionExists
Checks whether the session exists. This function can be called periodically to make sure that the session has not timed out. If the session does not exists, most web service calls will fail unless the session is recreated.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSessionOver
Destroys the session and effectively logs the user out.
Public methodSetOrganization
Changes the OfficeClip organization in the session. Succeeding calls are made to the new organization. Note that this does not change the organization in the regular OfficeClip login.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodUpdate
Updates OfficeClip data using a key. Update returns a bool showing whether the update succeeded. Note that if a null value of any column is suppled, that column will not get updated in OfficeClip.
Entity(Id)Description
Task(8)The OfficeClip Task. The Service subtype for this type is the Contact(18) and Account(31)
Event(14)The OfficeClip Calendar Events. The Service subtype for this type is the Contact(18) and Account(31)
Contact(18)The contact management metaentity
Note(20)The OfficeClip Notes Entity. The Service subtype for this type is the Contact(18) and Account(31)
Mail Merge Campaign Recipients(29)The mail merge campaign recipient information, the serviceSubType should be sent as -1, the primaryKey is the campaignId
Attachment(24)Document attachments with various applications
Mail Merge Campaign(28)The mail merge campaign information
Timesheet(34)Timesheet information, currently only the exported status of the timesheet can be set using this method
Expense(36)Expense information. currently only the exported status of the expense can be set using this method
Public methodValidateUser
Validates the user and if the user gets validated, the session is created. If the validation is successful, the organization is set to the last organization that is opened in the OfficeClip user interface.

See Also