Tips and Tricks

Leveraging the HTTP Header Location

There's more to RESTful services than just using the HTTP verbs. You should also be leveraging the Location header and status code, for example.

When REST was proposed as a way of leveraging the HTTP protocol, the idea was to do more than just take advantage of the HTTP verbs GET, POST, DELETE and so on -- the goal was to take advantage of all the features of HTTP. If you're creating RESTful services, you should be following that paradigm.

For example, HTTP headers can include a status code that indicates a new resource was created and a URL that points to that resource. In a RESTful application, if you add a new customer, then you should be sending the client a message with headers that include the HTTP Created status code and a Location set to the URL where the new customer could be retrieved. The code to create those headers would look something like this:

Public Function CreateCustomer(cust As Customer) As ActionResult
  Dim newCust As Customer
  '... code to add a customer with Id of 'A123'... 
  Response.StatusCode = HttpStatusCode.Created
  Dim hlpr As New UrlHelper(ControllerContext.RequestContext)
  Response.AppendHeader(
    "Location", hlpr.Action("GetCustomer", "Customer", New With {.id = "A123"}))     
End Function

The client can now check the HTTP status code and, when the client discovers that Created status, use the Location header to find the new resource. It's the RESTful way to do it.

About the Author

Peter Vogel is a system architect and principal in PH&V Information Services. PH&V provides full-stack consulting from UX design through object modeling to database design. Peter tweets about his VSM columns with the hashtag #vogelarticles. His blog posts on user experience design can be found at http://blog.learningtree.com/tag/ui/.

comments powered by Disqus

Featured

  • GitLab Takes Over VS Code Extension, Plans Improvements

    DevOps specialist GitLab has officially taken over the control of a GitLab extension for Microsoft's open source, cross-platform Visual Studio Code editor.

  • VS Code Python Tool Now Does Native Notebooks

    The Python Extension for VS Code Insiders team is previewing the newest implementation of notebooks, used frequently in data science with offerings such as Jupyter Notebooks.

  • As .NET 5 Nears, Content/Documentation Reorganization Starts

    A GitHub project is seeking to reorganize documentation and developer content in advance of the November debut of .NET 5, a unification of all things .NET that combines. .NET Core and other components.

  • Windows Devs Get Cross-Platform Page, Issues Repo

    Developers doing their coding on the Windows OS have received two new resource gifts from Microsoft: a new landing page for those using cross-platform technologies and a new GitHub repo with which to report issues to Windows engineering teams.Developers doing their coding on the Windows OS have received two new resource gifts from Microsoft: a new landing page for those using cross-platform technologies and a new GitHub repo with which to report issues to Windows engineering teams.

  • What's New in Entity Framework Core 5.0 Preview 7

    Microsoft shipped the seventh preview of Entity Framework Core 5.0, boosting its data access technology with a factory to create DbContext instances and more.

.NET Insight

Sign up for our newsletter.

Terms and Privacy Policy consent

I agree to this site's Privacy Policy.

Upcoming Events