Comments on: Using complex types to make calling services less… complex

By: Zoina

Zoina — Sun, 06 May 2012 13:44:44 +0000

I am following your post, please help me how can I create DTO for my below class

        public class SRMForm : IOracleCustomType
        {
        [OracleObjectMappingAttribute("UCA_APP_CATEGORY")]
        public virtual string uca_app_category    {get;set;}
 
        [OracleObjectMappingAttribute("MODULES")]
        public virtual SRMModules uca_module_description    {get;set;}
       }
 
      public class SRMRights : SRMForm
      {
        [OracleObjectMappingAttribute("CRT")]
        public virtual string Create     {get;set;}
 
        [OracleObjectMappingAttribute("RTV")]
        public virtual string Retrive     {get;set;}
 
        [OracleObjectMappingAttribute("UPD")]
        public virtual string Update     {get;set;}
 
        [OracleObjectMappingAttribute("DLT")]
        public virtual string Delete     {get;set;}
    }
 
 
    public class SRMModules : SRMForm 
    {
        [OracleObjectMappingAttribute("MODULE_NAME")]
        public virtual string ModuleName     {get;set;}
 
        [OracleObjectMappingAttribute("RIGHTS")]
        public virtual SRMRights ModuleRights     {get;set;}
    }

My HTML form looks like

what i want is to create a Data Transfer object “SRMModules” using JQuery by looping “input id=”ModuleName-X” with corresponding Rights ” “input by check boxes but I dont know how to acheive this.

By: Nilesh

Nilesh — Fri, 04 May 2012 09:38:02 +0000

Good Method. I am very happy to pas whole Object into webservice or WebMethod.
Thanks to every one!!!! and Author for this.

By: Matt

Matt — Sat, 31 Mar 2012 18:45:36 +0000

For the messy client side code at the beginning of the article, would it be better to begin with a single quote instead of a double quotes for the jquery ajax data property?

data: '{ "FirstName" : ' + JSON.stringify($("#FirstName").val()) + ', '
            + '"LastName" : ' + JSON.stringify($("#LastName").val()) + '}',

Otherwise, I don’t believe the inputs handle values well if the input values themselves contain single or double quotes; e.g., O’Brien.

By: Rick

Rick — Thu, 23 Feb 2012 19:31:55 +0000

I tested that stringify works in IE8, FF, and Safari without JSON2.js so I’m going to use that :)

var arrParamValuesJson = JSON.stringify(arrParamValues);

By: Rick

Rick — Wed, 22 Feb 2012 21:19:20 +0000

Hi Dave,
Awesome post! I found that I can pass in a JavaScript Array to my function and serialize it without adding another dependency (JSON2) by using
Sys.Serialization.JavaScriptSerializer.serialize()
However, I’m new and need cross browser functionality so… what are your thoughts on this serializer? Also, I plan on changing this to hit a WCF web service.

Here’s my JavaScript function:

function RangeNotValid(arrParamValues) {
    var arrParamValuesJson = Sys.Serialization.JavaScriptSerializer.serialize(arrParamValues);
 
    var jData;
    var editCk = 'RangeNotValid';
    var options = {
        type: "POST",
        async: false,
        cache: false,
        url: "ScriptWS.asmx/ExecuteCheck",
        data: "{'CheckMethodName':'" + editCk + "', 'ParameterArray':" + arrParamValuesJson + "}",
        contentType: "application/json; charset=utf-8",
        dataType: "html",
        success: function (data) {
            jData = data;
        },
        error: function (msg) {
            alert('Error at IsValidDate:' + msg);
        }
    };
    $.ajax(options);
 
    return = jData;
}

Here is my VB.NET web service method:

    (EnableSession:=True)> _
    Web.Script.Services.ScriptMethod(ResponseFormat:=System.Web.Script.Services.ResponseFormat.Xml)> _
    Public Function ExecuteEditCheck(ByVal CheckMethodName As String, ByVal ParameterArray() As String) As String
        Dim ParamList As List(Of Object) = ParameterArray.ToList.ConvertAll(Function(s) CObj(s))
		'Dim ParamList As New List(Of Object)
		'ParamList.Add(ParameterArray)
        Dim Query As XCQuery = UserSession.CRF.Form.Protocol.Queries.FirstOrDefault(Function(Q As XCQuery) Q.Script.FunctionName = CheckMethodName)
 
		Dim ret As String = New XCPatientQuery(Query).Run(ParamList).ToString
		Return ret
		'Return New XCPatientQuery(Query).Run(ParamList).ToString
    End Function

Thanks

By: dermot mcevoy

dermot mcevoy — Fri, 30 Dec 2011 15:27:02 +0000

Dave, this is a great post, got me out of a jam. This does helps to do atomic transactions where user is sending header/details from jQuery and .net service can process it all within one call. Also like the code when handling DTO and to expand it if require additional data…

var DTO = { ‘NewPerson’ : NewPerson, ‘MoreData’ : MoreData };

$.ajax({
type: “POST”,
contentType: “application/json; charset=utf-8″,
url: “PersonService.asmx/AddPerson”,
data: JSON.stringify(DTO),
dataType: “json”
});

Regards
Dermot

By: Dave Ward

Dave Ward — Mon, 19 Dec 2011 07:36:31 +0000

There’s no need to add the extra complexity of the DTO for a single value. Do something like this:

[WebMethod]
public List<SearchResult> Search(string SearchTerm) {
  return YourSearchMethod(SearchTerm);
}

By: Oscar

Oscar — Mon, 19 Dec 2011 05:10:14 +0000

Dave, thanks for your quick answer, according to this in the web method should instantiate the object and call the search method, also thought to send a dto with just one property assigned (the id) to implement my application according to dto design pattern, is this a good idea or not?, maybe I’m a little confused trying to follow this pattern.

Greetings.

By: Dave Ward

Dave Ward — Mon, 19 Dec 2011 04:46:29 +0000

I would just send the value.

By: Oscar

Oscar — Mon, 19 Dec 2011 04:30:57 +0000

Hi Dave, first of all, thanks for your excellent articles, I have been very helpful in developing in asp.net. I have a question regarding the use of DTO’s, Should I use a dto for a query that only uses a property of the object (the id) to search the database? Or is it more advisable to just send a value?, that is my question.

Thank you in advance and congratulations for your excellent work.

By: KS

KS — Fri, 16 Dec 2011 20:02:38 +0000

Ok.. I will try that.. Thx

By: Dave Ward

Dave Ward — Fri, 16 Dec 2011 19:49:20 +0000

If some properties are missing in the JSON, it will work okay and those properties will be null.

One of the best ways to experiment quickly and figure out how these various cases will work is to use LINQPad. You can try all these simple examples in it without worrying about the complexity of building a whole service, client to consume it, etc.

By: KS

KS — Fri, 16 Dec 2011 19:45:07 +0000

Sorry.. other question..

Hopefully this will solve my problem..

Is it ok if i will create myDTO for all my possible objects, reason for asking on different response JSON string will be different e.g one function return Person and COmpany other function return Person and Address..

So my question if i create general myDTO and pass only require JSON string is it going to be work??

e.g

public class MyDTO {
public Person person { get; set; }
public Company company { get; set; }
public Address address { get; set; }
}

and now i want to desirialze json string which has only Person and Address object or Person and Address object

{“Person”:{“ID”:”123″,”Name”:”Test”},”Company”:{“ID”:”123″,”Name”:”ABC”}}

Or,….

{“Person”:{“ID”:”123″,”Name”:”Test”},”Address”:{“City”:”Toronto″,”Country”:”Canada”}}

Then, I will use JavaScriptSerializer to deserialize that JSON into an object of type MyDTO, will it work or i have to create myDTO for each and every response??

Thank u very much in advance..

By: KS

KS — Fri, 16 Dec 2011 19:32:24 +0000

Wow… It’s seems some hope for me….

I will try that way.. and update you.

I really appreciate your very very quick help… Thank you very much..

Thanks for you time..

By: Dave Ward

Dave Ward — Fri, 16 Dec 2011 19:22:59 +0000

It works the same backwards. You’d need an object like:

public class MyDTO {
  public Person Person { get; set; }
  public Company Company { get; set; }
}

Then, you can use JavaScriptSerializer to deserialize that JSON into an object of type MyDTO, which has properties matching the JSON’s structure.