Ektron CMS400.Net Reference

>>Plug-in Extension > Connecting to the Web Service API From a Plug-in

Connecting to the Web Service API From a Plug-in

You can connect to the Web Service API from a plug-in by using a Web service proxy. Calling a Web service proxy accessor creates a connection to a particular Web service. For example, using the GetContentProxy() creates a connection to the Web Service API Content.asmx.

When using the Web service proxy, the Web service connects to the site that produced the event. For example, if you have three sites and site two uses a plug-in with the OnBeforePublish event that calls a Web service, the Web service connects back to site two only.

Because the Plug-in Architecture and Ektron CMS400.NET run on the same server, no authentication is needed when making a Web Service API call. Once a connection is made, you can call any Web service method that is available. For information on Web service methods, click Help > Contents > Ektron Ektron CMS400.NET API Documentation > Ektron Namespace > Web Services API.

Below is a list of available Web service proxies.

 

Note: In the Web Service Connection column, the ... refers to/<site webroot>/Workarea/webservices/WebServiceAPI

Proxy Accessor

Returns

Web Service Connection

GetActiveDirectoryUserProxy()

ActiveDirectoryUserProxy

…/User/ActiveDirectoryUser.asxm

GetAssetProxy()

AssetProxy

.../Content/Asset.asmx

GetBlogProxy()

BlogProxy

.../Content/Blog.asmx

GetBusinessRulesProxy()

BusinessRulesProxy

…/BusinessRules.asmx

GetCalendarEventTypeProxy()

CalendarEventTypeProxy

.../Calendar/CalendarEventType.asmx

GetCalendarProxy()

CalendarProxy

…/Calendar/.asmx

GetContentProxy()

ContentProxy

.../Content/Content.asmx

GetCustomFieldsProxy()

CustomFieldsProxy

.../CustomFields.asmx

GetFolderProxy()

FolderProxy

.../Folder.asmx

GetFontProxy()

FontProxy

.../Font.asmx

GetFormProxy()

FormProxy

.../Content/Form.asmx

GetLibraryProxy()

LibraryProxy

.../Library.asmx

GetMetadataProxy()

MetadataProxy

.../Metadata.asmx

GetPermissionsProxy ()

PermissionsProxy

.../Permissions.asmx

GetSearchManagerProxy()

SearchManagerProxy

.../Search/SearchManager.asmx

GetSiteMapProxy()

SiteMapProxy

.../SiteMap.asmx

GetSiteProxy()

SiteProxy

.../Site.asmx

GetTaskProxy()

TaskProxy

.../Task.asmx

GetTaskCategoryProxy()

TaskCategoryProxy

.../Task/TaskCategory.asmx

GetTaskCategoryTypeProxy()

TaskCategoryTypeProxy

.../Task/TaskCategoryType.asmx

GetThreadedDiscussionProxy()

ThreadedDiscussionProxy

.../Content/ThreadedDiscussion.asmx

GetUserProxy()

UserProxy

.../User/User.asmx

(continued in Debugging a Plug-in)


Visit the Ektron Dev Center at http://dev.ektron.com 1-866 - 4 - EKTRON

Ektron CMS400.NET Reference Version 8.02 SP1 Rev 1

Ektron Documentation,© 2011 Ektron, Inc.