logo
Welcome Guest! To enable all features please Login or Register.

Notification

Icon
Error

Options
View
Go to last post Go to first unread
skdutta  
#1 Posted : Tuesday, April 28, 2009 5:13:52 PM(UTC)
Rank: Administration
skdutta
Groups: Registered, Developer, Administrators

Posts: 257
Location: Atlanta, GA
OfficeClip Web Service can be used to exchange information with the OfficeClip Suite. It models every entity (e.g. contacts, templates etc.) as a table. It offers methods to read, write, append and delete from the table. The consumer of the OfficeClip web services is isolated from the internal details of how the data is exchanged between OfficeClip database and its various layers.

OfficeClip Web Services is supported for the following products:

Web Timesheet Software

Web Expense Report

Web Contact Manager

OfficeClip web services identifies each OfficeClip data element using a unique identifier called sid (serial id). The sid concept is similar to the guid (globally unique identifier) as used in may platforms. The sid is unique across any OfficeClip installation and is created using the OfficeClip installation serial number, the entity and the primary key of that element in the OfficeClip database. The sid is a string that is used to communicate between the web service client and the server.

Each OfficeClip entity is identified by a service type for the OfficeClip web services. OfficeClip is an integrated platform of many web-based applications and it has many entities (and service types). The service types are identified by integer and is used is almost all methods in the web services interface. Some service types are divided into sub types called service sub types. The service sub types are also represented as integer. Not all operations are valid for all service types. The valid operations are specified with the help page of the OfficeClip web services. An exception is thrown if an invalid operation is attempted on a service type.

Here is an example of how to delete a campaign attachment:

Code:

public static DataSet DeleteCampaignAttachment(
 WebServiceClient.Generic.OfficeClipGeneric ofg,
 string sid
 )
{
 DataSet ds = null;
 try
 {
    // Service Type 24 is for campaign data
    bool status = ofg.Delete(24, sid);
    Console.WriteLine((status) ? "Delete Successful" : "Delete Failed");
 }
 catch (SoapException ex)
 {
    Console.WriteLine(ex.Message);
 }
 return ds;
}

For the documentation of entire API click here: Web Services API

OfficeClip Web Services is used to create all the interfaces that communicate with OfficeClip, for example, Microsoft Word Interface, Outlook Interface, QuickBooks Interface etc.

Edited by user Tuesday, April 28, 2009 5:17:04 PM(UTC)  | Reason: Not specified

SK Dutta,

Architect OfficeClip LLC,

Web-based Business Software,

Ph: +1-770-448-7375,

Web: https://www.officeclip.com

Forum Jump  
You cannot post new topics in this forum.
You cannot reply to topics in this forum.
You cannot delete your posts in this forum.
You cannot edit your posts in this forum.
You cannot create polls in this forum.
You cannot vote in polls in this forum.