Model null when use Route attribute

Question

In my WebAPI I have model

 public class ListRequest 
 {
    public int Skip { get; set; } = 0;
    public int Take { get; set; } = 30;
 }

My action is

 [HttpGet]
 [Route("api/users")]
 public IHttpActionResult Get([FromUri] ListRequest request) {
    ...
 }

I need to have possibility to not pass any query parameters, then default values should be used. But, when I go to http://localhost:44514/api/users the request is null. If I remove [Route("api/users")] then request is not null and has default values for parameters.

How can I reach that behavior with Route attribute?

Why do you have the `ListRequest request` parameter when your not passing any query string values? (you may as well just initialize a new instance in the method) — , Jul 21 '17 at 10:26
@StephenMuecke I'm not passing any parameters when I want to use default parameter values. Before I add attribute everything works fine, but I need use that attribute — Pr.Dumbledor, Jul 21 '17 at 11:25
You may try using [HttpPost] method to pass a model in the request as a parameter. — Dalvinder Singh, Jul 21 '17 at 11:34
@DalvinderSingh No, it is GET. Model used for filtering, some time other model can has over 5 properties to filter. So I just want GET with filter. And I use model instead of many parameters of action — Pr.Dumbledor, Jul 21 '17 at 11:37
You can find similar question like this here.. https://stackoverflow.com/questions/24075892/how-to-bind-a-request-model-in-webapi-get-request-with-route-attribute — Dalvinder Singh, Jul 21 '17 at 11:54
@DalvinderSingh thank for your help and advices. I solved that — Pr.Dumbledor, Jul 21 '17 at 12:43

Roman Marusyk · Accepted Answer · 2020-05-26T18:44:48.937

2

If you want to init model using Route attributes try

Route("api/users/{*pathvalue}")]

edited May 26 '20 at 18:44

answered Jul 21 '17 at 12:36

Roman Marusyk

23,328
24
73
116

This worked for me but I would like to understand why – user1959309 May 26 '20 at 10:38

score 0 · Answer 2 · edited Jul 21 '17 at 12:42

0

Create your method on post request basis. Get type always receive null value.

[HttpGet]
[Route("api/users")]
public IHttpActionResult Get([FromUri] ListRequest request) {

}

Change to

[HttpPost]
[Route("api/users")]
public IHttpActionResult Get([FromUri] ListRequest request) {
...
}

Because Model (Class) type parameter does not support get type request.

Hope it will help.

edited Jul 21 '17 at 12:42

Maveňツ

1
12
50
89

answered Jul 21 '17 at 12:29

Raja

152
8

I can't change it. Model used for filtering, some time other model can has over 5 properties to filter. So I just want GET with filter. And I use model instead of many parameters of action – Pr.Dumbledor Jul 21 '17 at 12:32
anything else. Get request wont support model type parameter. You need to change according to request basis not your requirement basis. – Raja Jul 21 '17 at 12:36
Why? Where did you find that Get request wont support model type parameter. I always use it. And see the question. It works but only without attribute – Pr.Dumbledor Jul 21 '17 at 12:37
Also you can see the comment below the question. We have already talk about that with DalvinderSingh. So your answer is not helpful. sorry – Pr.Dumbledor Jul 21 '17 at 12:40

score 0 · Answer 3 · answered Dec 12 '19 at 12:26

Use data annotation. For more information visit Default value in mvc model using data annotation

Change

public class ListRequest 
{
    public int Skip { get; set; } = 0;
    public int Take { get; set; } = 30;
}

To

    public class ListRequest 
    {
        [DefaultValue(0)]
        public int Skip { get; set; }
        [DefaultValue(30)]
        public int Take { get; set; }
    }

It works without removing [Route("api/users")] and request will not be null.

Model null when use Route attribute

3 Answers3