Practical .NET

Send the Right Error Information with HttpException

When something goes wrong with your Web Service the decent thing to do is to return your errors in a variety of ways.

One way to return an error from a Web Service is to raise an HttpException. If you do so, you should support two methods and one property on the HttpException object:

  • GetHttpCode: One of the HTTP protocol's predefined codes
  • GetHtmlMessage: An HTML-formatted message suitable for display in a Web page
  • Message: A plain text string containing useful information about the error

Probably the easiest way to do this is to pass the exception that your service ran into as the third parameter when creating the HttpException object. The odds are good that the ErrorFormatter that generates the HttpException object's HTML will be able to convert your exception into HTML.

Your resulting code would look like this (using 500, the standard HTTP code for "something has gone horribly wrong on the server"):

Try
  '...code with potential problem...
Catch (ex As Exception)
  Throw New Exception(500, "Something has gone horribly wrong", ex)
End Try

Now, that's a strong message no one can ignore.

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

  • How to Do Machine Learning Evolutionary Optimization Using C#

    Resident data scientist Dr. James McCaffrey of Microsoft Research turns his attention to evolutionary optimization, using a full code download, screenshots and graphics to explain this machine learning technique used to train many types of models by modeling the biological processes of natural selection, evolution, and mutation.

  • Old Stone Wall Graphic

    Visual Studio Code Boosts Java Dependency Viewer

    Easier management of project code dependencies and improvements to extensions for popular Java frameworks and runtimes highlight the February update to Java in Visual Studio Code functionality.

  • Blule Squares

    Visual Studio 2019 for Mac 8.5 Preview Adds ASP.NET Core Authentication

    Microsoft, after shipping Visual Studio 2019 for Mac v8.4 with support for ASP.NET Core Blazor Server applications last month, is now previewing the v8.5 series, adding new authentication templates for ASP.NET Core along with other improvements.

  • Q&A with Brice Wilson: What's New in Angular 9

    We caught up with expert web developer/trainer Brice Wilson to get his take on Angular, which always appears at or near the top of periodic rankings of the most popular JavaScript-based web development frameworks.

  • Entity Framework Core Migrations

    Eric Vogel uses code samples and screenshots to demonstrate how to use Entity Framework Core migrations in a .NET Core application through the command line and in code.

.NET Insight

Sign up for our newsletter.

Terms and Privacy Policy consent

I agree to this site's Privacy Policy.

Upcoming Events