These articles contain information related to the Client Side Programming in Sitefinity.
Sitefinity CMS introduces the web service API in its full extent. While, in previous versions of Sitefinity CMS, we have always made sure to provide developers with fully exposed API, we have done so only for the server side development scenarios. The web service API is based on the Windows Communication Foundation (WCF) REST approach,where each service represents one entity of the domain model. The web service API follows very strictly convention where for each entity following operations can be performed:
In this section of the manual, we are going to explore the following topics:
Apart from the provider model, Sitefinity CMS uses the web services model. Sitefinity CMS is web service oriented application.
Simply put, the UI interacts with web services, which are also exposed and available for 3rd party applications and devices.
Sitefinity CMS provides a fully exposed web service API. Sitefinity CMS webservice API is made of RESTful webservices, meaning that the design is following the principles outline by Roy Fielding in his doctoral dissertation.
What makes a webservice RESTful?
There are two main approaches to webservices: SOAP and REST: Whereas SOAP based webservices expose methods (such as GetNewsItems or SaveNewsItem), REST works with resources as the cornerstones of its architecture and relies on the HTTP methods to provide the operational context.
Let us take a look at the following diagram comparing the two approaches.
In essence, with both approaches we are providing the client of the service with the ability to accomplish the CRUD tasks , however, where SOAP is offering arbitrarily named methods as an API, REST is able to provide uniform API by combining the resource name with the well known standards of the HTTP protocol.
Sitefinity CMS conventions
For every resource exposed through a webservice, Sitefinity CMS supports CRUD operations. Every call to a webservice supports an optional parameter for the provider name (Overview: Provider model ). If no provider name has been set through an optional query string parameter, default provider will be used.
When requesting a collection of resources, Sitefinity CMS supports also following optional parameters:
All built-in webservices provided by Sitefinity CMS are located in the ~/Sitefinity/Services folder.
Back To Top