ASP.NET Core 7 Web API : not accepting class object as parameter

Question

I have created an ASP.NET Core 7 Web API and successfully created about 30 endpoints which are working fine. Just got stuck in some weird situation that I have created one endpoint with this signature:

[HttpPost]
[Route("[action]")]
public async Task<IActionResult> UsersBySearch([FromBody] UserSearchOptions prmUSO)
{
    var (Result, Response) = await UOW.Users.GetUsersBySearch(prmUSO);

    if (Result != null)
    {
       return Ok(Response);
    }
    else
    {
       return BadRequest(new ServiceErrorMsg { Message = new() { "Error fetching user list"}});
     }
}

where the UserSearchOptions class looks like this:

public class UserSearchOptions
{
    public int Skip;
    public int PageSize;
    public string? SortCol;
    public string? SortColDir;
    public string? searchVal;
    public int UserId;
}

Now when I run this, my Swagger API not showing this API with input class object as input parameter, also when I call it with Postman, the API is getting called but the parameter values are not receiving in it.

Could some please help to sort out this problem.

try using a property instead of a field `public int Skip {get;set;}` — jeb, Aug 15 '23 at 11:37
Just to add to @jeb's comment. Records are handy for this as they generate properties. — Brian Rasmussen, Aug 15 '23 at 11:53

score 3 · Accepted Answer · edited Aug 15 '23 at 11:39

3

Try adding the getter and setter to your class.

public class UserSearchOptions
{
    public int Skip { get; set; }
    public int PageSize { get; set; }
    public string? SortCol { get; set; }
    public string? SortColDir { get; set; }
    public string? searchVal { get; set; }
    public int UserId { get; set; }
}

edited Aug 15 '23 at 11:39

marc_s

732,580
175
1,330
1,459

answered Aug 15 '23 at 11:36

Filipe Ferreira

61
4

2

FYI this converts the fields to properties. – phuzi Aug 15 '23 at 11:41

score 2 · Answer 2 · answered Aug 15 '23 at 11:49

You can either change your DTO to use properties instead of fields as per the other answer, or if you really want to use fields you can enable them by setting JsonSerializerOptions.IncludeFields to true for your API as described by https://stackoverflow.com/a/58139922/1064169.

ASP.NET Core 7 Web API : not accepting class object as parameter

2 Answers2