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

  • Telerik UI for Blazor Updated

    Progress announced an update to its Telerik UI for Blazor components, targeting Microsoft's open source Blazor framework that lets C# coders create web apps without having to rely upon JavaScript.

  • Infragistics Unveils UI Components for Blazor

    Infragistics, specializing in third-party UI/UX controls and tools, unveiled a new offering targeting Blazor, Microsoft's red-hot open source framework that allows for C#-based web development instead of traditional mainstay JavaScript.

  • AWS Open Sources Tool for Porting .NET Framework Apps to .NET Core

    Leading cloud computing platform Amazon Web Services open sourced the it announced in July for helping users port old .NET Framework applications to the new .NET Core framework.

  • Uno Platform Ports Windows Calculator to Linux

    Uno Platform has ported the famed Windows Calculator, open sourced last year, to Linux as part of a continuing "proof point" effort to demonstrate the reach of what it describes as the sole UI offering available to target Windows, WebAssembly, iOS, macOS, Android and Linux with single-codebase applications coded in C# and XAML.

  • ASP.NET Core OData 8 Preview Supports .NET 5, but with Breaking Changes

    ASP.NET Core OData, which debuted in July 2018, is out in a v8.0 preview that for the first time supports the upcoming .NET 5 milestone release.

Upcoming Events