Can anyone explain CreatedAtRoute() to me?

c# asp.net asp.net-web-api asp.net-web-api-routing
martial picture martial · Jul 30, 2014 · Viewed 45.1k times · Source

From the template for Web API 2, a post method is always like this:

[ResponseType(typeof(MyDTO))]
public IHttpActionResult PostmyObject(MyDTO myObject)
{
    ...
    return CreatedAtRoute("DefaultApi", new { id = myObject.Id }, myObject);
}

I don't understand this CreatedAtRoute() method. Can anyone explain the CreatedAtRoute() method to me?

Answer

see sharper picture see sharper · Aug 4, 2014

The CreatedAtRoute method is intended to return a URI to the newly created resource when you invoke a POST method to store some new object. So if you POST an order item for instance, you might return a route like 'api/order/11' (11 being the id of the order obviously).

BTW I agree that the MSDN article is of no use in understanding this. The route you actually return will naturally depend on your routing setup.

Related questions

Optional Parameters in Web Api Attribute Routing

I want to handle POST of the following API-Call: /v1/location/deviceid/appid Additional Parameter are coming from the Post-Body. This all works fine for me. Now I wnat to extend my code by allowing "deviceid" and/or "appid" and/…

Read More
How to map WebAPI routes correctly

I'm building an API for a Twitter like site using Web API and have trouble with mapping the routes I have the following actions for the User controller: public User Get(string firstname, string lastname) public User Get(Guid id) …

Read More
A route named 'DefaultApi' is already in the route collection

This question may seems duplicate but this is slightly different. In all other question in SO I had noticed that they have multiple routes registered. but in my case I have just one route. I am creating asp.net webapi (…

Read More