How can I correctly implement a .NET controller method that handle POST request retrieving an URI parameter and the request payload?

Question

I have to develop a REST API that have to handle POST request (taking a payload from the body of my request) and at the same time taking an URI parameter.

Into my controller class I have something like this:

public class MailProtocolloController : ApiController
{
    [SharePointContextWebAPIFilter]
    [HttpPost]
    [ActionName("protocollo/mail")]
    public IHttpActionResult InviaAlProtocollo(XXX)
    {



        return Ok("TEST");
    }
}

My problems are:

1. As you can see I am using the ActionName annotation to specify the URL path handled by this controller method. How can I specify the URI parameter into this ActionName annotation? (can I?) It have to handle something like this: protocollo/mail/{id}

2. What input parameter have to be specified for this controller method? One for the ID retrieved from the URI (a string) and an object for the request payload? Or this payload can be retrieved inside the method?

How can I implement this behavior?

Answer 1

Try this:

public class MailProtocolloController : ApiController
{
    [SharePointContextWebAPIFilter]
    [HttpPost]
    [Route("protocollo/mail/{id}")]
    public IHttpActionResult InviaAlProtocollo([FromUri] string id, [FromBody] string context)
    {



        return Ok("TEST");
    }
}

Answer 2

You can use the RouteAttribute to define route mappings where you can use parameter placeholders to get those from the url path.

And you can also get the body of the request if you decorate your parameter which represents the body with the FromBody attribute:

[RoutePrefix("protocollo")]
public class MailProtocolloController : ApiController
{
    [SharePointContextWebAPIFilter]
    [HttpPost]
    [Route("mail/{id}")]
    public IHttpActionResult InviaAlProtocollo(string id, [FromBody]string body)
    {
        return Ok("TEST");
    }
}