C# / ASP.NET Core Web API : how to pass a list parameter?

Question

I'm trying to pass a list parameter to an ASP.NET Core 5 Web API.

Here is my endpoint:

[ApiController]
[Route("[controller]")]
public class InvoiceController : ControllerBase
{
    private readonly IConfiguration _configuration;

    public InvoiceController(IConfiguration configuration)
    {
        _configuration = configuration;
    }

    [HttpPost]
    public List<CustomerInvoice> Post(string[] CustomerNumbers, DateTime OrderDateFrom, DateTime OrderDateTo)
    {
    }
}

Sending json post request fails with this error:

The JSON value could not be converted to System.String[]. Path: $ | LineNumber: 0 | BytePositionInLine: 1.

and here is the request:

{
    "CustomerNumbers": ["test"],
    "OrderDateFrom": "2021-01-01",
    "OrderDateTo": "2021-11-02"
}

Instead of using a string array, I also tried List<string>. I got the same error.

Any idea why the framework does not understand how to receive a list?

What's the JSON value look like?

ChiefTwoPencils
– ChiefTwoPencils

2021-12-30 20:22:43 +00:00
Commented Dec 30, 2021 at 20:22 — ChiefTwoPencils
– ChiefTwoPencils, Commented Dec 30, 2021 at 20:22

Jeremy Caney · Accepted Answer · 2021-12-31 00:03:17Z

3

You should create a class and receive JSON with this class. This may solve your problem.

public class ClassExample
{
    public List<string> CustomerNumbers { get; set; }
    public DateTime OrderDateFrom { get; set; }
    public DateTime OrderDateTo { get; set; }
}



[HttpPost]
public List<CustomerInvoice> Post(ClassExample requestParameter)
{
}

edited Dec 31, 2021 at 0:03

Jeremy Caney

7,808115 gold badges58 silver badges86 bronze badges

answered Dec 30, 2021 at 21:03

fatih

2391 gold badge4 silver badges16 bronze badges

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

1 Comment

max Over a year ago

Great. This does work. Thanks. My comment documentations do not appear in swagger with this approach. Do you know if there is a documentation on this?

Collectives™ on Stack Overflow

C# / ASP.NET Core Web API : how to pass a list parameter?

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