WebApi - Read GET parameters passed from jQuery GET to object

Question

When calling a REST service with jquery, I can pass a POJO object to $.get(...) call, and jquery will serialize the object's properties to GET QueryString.

My REST service is developed using WebAPI, and I'm wondering if I can make it automatically deserialize querystring parameters to an object.

More precisely:

If I have a POST method, I can deserialize the json from message body as below

I have the following jQuery code

var dataObj // my POJO
j$.post('/api/myserv', dataObj, function (data, status, jqXHR) {
    // ....

And the WebApi endpoint

' MyEntity class has same structure as POJO object
Public Function PostValue(<FromBody()> ByVal entity As MyEntity) As HttpResponseMessage 
    ' here I have entity instantiated and setup

When using jquery get, and passing POJO object:

var dataObj // my POJO
j$.get('/api/myserv', dataObj, function (data, status, jqXHR) {
    // ....

This translates to

GET /api/myserv?prop1=val1&prop2=val2&...

In WebApi I would like to instantiate an object as with POST

' MyEntity class hadata from uri, s same structure as POJO object
Public Function GetValue(<FromURI()> ByVal entity As MyEntity) As HttpResponseMessage 
    ' but here the entity is null

To be able to read I have to have a param for every prop in POJO object, like

' MyEntity class hadata from uri, s same structure as POJO object
Public Function GetValue(prop1 As .., prop2 as ..., ) As HttpResponseMessage

Is there any way to be able to read all params from get in a single object, as it'spossib;e with POST from body?

Thank you

Christian Phillips · Accepted Answer · 2013-12-08 19:03:22Z

3

You can use [FromUri] before the object in the WebAPI method parameter. Take a look at Parameter Binding here.

Set your jquery call up like below:

$.ajax({
    url: url,
    type: 'GET',
    dataType: 'json',
    data: { prop1: 1, prop2: "two" },
    success: function (result) {
        //handle
    }
});

edited Dec 8, 2013 at 19:03

answered Dec 8, 2013 at 18:42

Christian Phillips

18.8k8 gold badges55 silver badges85 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

bzamfir Over a year ago

Actually I already did it (see my question), and it didn't worked. But now I tried again, and it did worked now. Strange. Thanks for answer, that made me try again.

Collectives™ on Stack Overflow

WebApi - Read GET parameters passed from jQuery GET to object

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related