Using [FromQuery] with a complex object

Question

I'm having an issue with my parameter not binding when I send a request to my API endpoint when passing a query string, the parameter binds if I flatten Submission but this isn't the solution I want. I can't provide the client-side code that sends the request as a third party control handles the request.

I've supplied an example of the query string sent with the request that can be seen in developer tools, however, Person and Property come back as null. Does anyone have any suggestions, specifically server-side changes that I can do to bind this complex object? thanks.

public class Submission {
    public Person Person {get; set; }
    public Property Property { get; set; }
}

public class Person {
   public int Age { get; set; }
}

public class Property {
   public string Address { get; set; }
}

Query string parameters

'Person[Age]': 18
'Property[Address]': test

 [HttpGet("action")]
 public async Task<IActionResult> Submit([FromQuery] Submission model)
 {

 }

Try Person.Age in the querystring.

Ian Kemp - SO dead by AI greed
– Ian Kemp - SO dead by AI greed

2020-11-11 22:33:49 +00:00
Commented Nov 11, 2020 at 22:33 — Ian Kemp - SO dead by AI greed
– Ian Kemp - SO dead by AI greed, Commented Nov 11, 2020 at 22:33

Martin Ullrich · Accepted Answer · 2020-11-11 22:41:30Z

6

In this case the URL you want to call is:

https://localhost:.../.../action?Person.Age=18&Property.Address=test

answered Nov 11, 2020 at 22:41

Martin Ullrich

102k27 gold badges271 silver badges232 bronze badges

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

Comments

Michael Ziluck · Accepted Answer · 2022-11-18 08:48:24Z

0

Change your action :

[HttpGet("Submit")]
public async Task<IActionResult> Submit([FromQuery] Submission model)
{

}

Try this for your Submission model

public class Submission {
    public int Age {
        set { 
           if (Person == null) Person = new Person();
           Person.Age = value;
        }
    }
    public string Address {
        set { 
           if (Person == null) Person = new Person();
           Person.Address = value;
        }
    }
    public Person Person { get; set; }
    public Property Property { get; set; }
}

or you can create

public class SubmissionModel : Submission
{
    public int Age {
        set { 
            if (Person == null) Person = new Person();
            Person.Age = value;
        } 
    }
}

in this case you action will be

[HttpGet("Submit")]
public async Task<IActionResult> Submit([FromQuery] SubmissionModel subModel)
{
    var model = subModel as Submission;
    // other code here
}

In this case you have to call this URL:

https://localhost:.../.../submit?Age=18&Address=myaddress

edited Nov 18, 2022 at 8:48

Michael Ziluck

6857 silver badges22 bronze badges

answered Nov 11, 2020 at 22:59

Serge

44.4k4 gold badges26 silver badges53 bronze badges

1 Comment

dconan Over a year ago

As mentioned in the original post, flattening the object does work, however, my example is a simplified version and I'd prefer to not flatten my multinested class.Thanks for the suggestion though!

Collectives™ on Stack Overflow

Using [FromQuery] with a complex object

2 Answers 2

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related