Difference between revisions of "DCS Web Service"

From Catglobe Wiki
Jump to: navigation, search
(New page: ==Introduction== The original reason for creating DCS web service was to retrieve data answered in a questionnaire and display them on a Portal element. ==How to use == CatGlobe.Web.DataMo...)
 
m
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
==Introduction==
+
== Introduction ==
 +
 
 
The original reason for creating DCS web service was to retrieve data answered in a questionnaire and display them on a Portal element.
 
The original reason for creating DCS web service was to retrieve data answered in a questionnaire and display them on a Portal element.
−
==How to use ==
 
−
CatGlobe.Web.DataModule.DataCache.WebService.DCSWebService.GetDCSData(condition, onSuccessFunction, onFailFunction, element_context);
 
  
−
The condition xml should follow the format of:
+
 
−
<source lang="xml" line="0">
+
'''Do not use this service, a new data cache exists, more information about the API is available here&nbsp;'''[[Data cache service|'''Data_cache_service''']]'''.'''
−
<criteria dcs-id="1" top-N="1000" order-by-column="StartDate" order-type="desc">
+
 
−
<column name="StartDate"></column>
+
==Features==
−
<column name="Q25"></column>
+
There are currently 2 functions supported, their return values are tables in [http://json.org JSON]'s array format.
−
<column name="BankName"></column>
+
<source lang=csharp>
−
</criteria>
+
//get top N data ordered by a column descendingly (DESC) or ascendingly (ASC)
 +
public object GetTopDCSData(int dcsId, string[] columns, int topN, string orderByColumn, string orderType)
 +
 
 +
//get specific columns' data
 +
public object GetDCSData(int dcsId, string[] columns)
 +
</source>
 +
 
 +
== How to use  ==
 +
 
 +
The simplest way is to use [http://docs.jquery.com/Ajax/jQuery.ajax#options ajax request using jquery].
 +
 
 +
If the request is not made from an internal page inside Catglobe system, we need to make a dummy login first, then make the call to the web service.
 +
 
 +
<source lang="javascript">
 +
//-------CONFIGURATION--------------------
 +
var dcsId = 4246;//Primary key of the DCS
 +
var columns = "'UserId', 'FirstName', 'DisabledDate', 'DeletedDate', 'Amt', 'Kommune_gammel', 'Region', 'Postnummer', 'Boligtype'";//selected columns
 +
 
 +
var username = "maimai";//your username to login to Catglobe system
 +
var password = "cg";//your password
 +
var rootUrl = 'http://localhost/supernova';//replace this with your site, ex: http://mycatinet.catglobe.com
 +
//--------------------------------------------------
 +
 
 +
var webMethod = rootUrl + '/DataModule/DataCache/WebService/DCSWebService.asmx/GetDCSData';
 +
var loginPage = rootUrl + '/Login.aspx?u='+username+'&p='+password;
 +
var parameters = "{'dcsId':" + dcsId + ",'columns':[" + columns + "]}";//JSON format
 +
 
 +
$.ajax({
 +
  type: "POST",
 +
  url: loginPage,
 +
  success: function(msg)
 +
  {
 +
      //login successfully, now call the web service     
 +
      $.ajax({
 +
        type: "POST",
 +
        url: webMethod,
 +
        data: parameters,
 +
        contentType: "application/json; charset=utf-8",
 +
        dataType: "json",
 +
        success: function(msg)
 +
        {
 +
            var dataTable = eval(msg.d);
 +
            //Code of using the data table here
 +
        },
 +
        error: function(e)
 +
        {       
 +
            //error when connecting to the web service
 +
        }
 +
      });
 +
  },
 +
  error: function(e)
 +
  {
 +
      //error when trying to login
 +
  } 
 +
});
 
</source>
 
</source>
  
Line 28: Line 81:
 
</system.web.extensions>
 
</system.web.extensions>
 
</source>
 
</source>
 +
 +
== Examples ==
 +
 +
[[Display a questionnaire's answers in real time]]
 +
 +
[[Media:TestDCSWebService.zip|Connect to web service from an external site]]

Latest revision as of 03:17, 23 June 2010

Introduction

The original reason for creating DCS web service was to retrieve data answered in a questionnaire and display them on a Portal element.


Do not use this service, a new data cache exists, more information about the API is available here Data_cache_service.

Features

There are currently 2 functions supported, their return values are tables in JSON's array format. 

//get top N data ordered by a column descendingly (DESC) or ascendingly (ASC)
public object GetTopDCSData(int dcsId, string[] columns, int topN, string orderByColumn, string orderType)

//get specific columns' data
public object GetDCSData(int dcsId, string[] columns)

How to use

The simplest way is to use ajax request using jquery.

If the request is not made from an internal page inside Catglobe system, we need to make a dummy login first, then make the call to the web service. 

//-------CONFIGURATION--------------------
var dcsId = 4246;//Primary key of the DCS
var columns = "'UserId', 'FirstName', 'DisabledDate', 'DeletedDate', 'Amt', 'Kommune_gammel', 'Region', 'Postnummer', 'Boligtype'";//selected columns

var username = "maimai";//your username to login to Catglobe system
var password = "cg";//your password
var rootUrl = 'http://localhost/supernova';//replace this with your site, ex: http://mycatinet.catglobe.com
//--------------------------------------------------

var webMethod = rootUrl + '/DataModule/DataCache/WebService/DCSWebService.asmx/GetDCSData';
var loginPage = rootUrl + '/Login.aspx?u='+username+'&p='+password;
var parameters = "{'dcsId':" + dcsId + ",'columns':[" + columns + "]}";//JSON format

$.ajax({
   type: "POST",
   url: loginPage,
   success: function(msg) 
   {
      //login successfully, now call the web service      
      $.ajax({
         type: "POST",
         url: webMethod,
         data: parameters,
         contentType: "application/json; charset=utf-8",
         dataType: "json",
         success: function(msg) 
         {
            var dataTable = eval(msg.d);
            //Code of using the data table here
         },
         error: function(e) 
         {         
            //error when connecting to the web service
         }
      });
   },
   error: function(e) 
   {
      //error when trying to login
   }   
});

Limitation

There is a limit of data retrieval defined by JavaScriptSerializer.maxJsonLength, which is 4 MB Unicode characters as default. If the data retrieval is higher than this, an error will be returned in the onFailFunction: "Error during serialization or deserialization using the JSON JavaScriptSerializer. The length of the string exceeds the value set on the maxJsonLength property"

This can be fixed by updating the web config file: 

<system.web.extensions>    
<scripting>      
<webServices>        
<jsonSerialization maxJsonLength="500000">        
</jsonSerialization>      
</webServices>    
</scripting>
</system.web.extensions>

Examples

Display a questionnaire's answers in real time

Connect to web service from an external site

Retrieved from "http://wiki.catglobe.com/index.php?title=DCS_Web_Service&oldid=12964"