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

This namespace drives the OfficeClip generic webservice.

Classes

ClassDescription
Public classDriver
The driver class drives all the web services calls. Each web service communicates with the outside world using simple data types. Complex data types are encoded in the xml format which is same as the serialized dataset. Instead of xml, the consumer can also use the dataset (in .net clients). Most services has a service type as argument. The service group determines which entity is addressed (example group, attachment, contact etc.). The service type is an enumerated type in OfficeClip, the integer value of which is used in the web service. Following are the service types that are currently implemented.
Service Item(Id)Description
Tracker Binder(1)The OfficeClip Tracker Binder.
Tracker Issue(4)The OfficeClip Tracker Issue.
Task(8)The OfficeClip Task. The Service subtype for this type is the Contact(18) and Account(31)
Member(11)The OfficeClip Member
Organization(13)The OfficeClip Organization
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)
Template Parent Child(23)The parent child values of the template. The service sub type for this type is the template type.
Attachment(24)Document attachments with various applications
Return Value(25)The return value format for various operations (e.g. Insert, Update)
Template Key Value(27)The Template key value information (used to merge a template)
Mail Merge Campaign(28)The mail merge campaign information
Mail Merge Campaign Recipients(29)The mail merge campaign recipient information
System Information(30)Provides Session and System Information
Account(31)Account Information
Project(32)Project information
Service Item(33)Services Item information
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)
Expense Type(38)The Expense Type information. Expense type categories are: 1=air travel, 2=hotel, 3=auto rental, 4=taxi, 5=telephone, 6+ = other
Meta Information(39)Provides information regarding field name, field type, section name, list choices, default value, is required, is readonly and is visible for entities like contacts, accounts, opportunities etc.
Payroll Category(40)Provides various payroll categories like regular, exempt etc.
Some web services uses a string called the serial id (sid). The serial id is a globally unique string across all OfficeClip installation, application and data rows.