Home > Articles > Web Services

Like this article? We recommend

Like this article? We recommend

Implementing a Basic Web Service in C#

To demonstrate asynchronous Web Service invocation, I've implemented a sample application that provides information about airports. This is the kind of information a pilot might use, and is similar to the information you might find in an airport facilities directory (AFD). The factual information for the sample program was taken from AirNav.com (see Figure 1). AirNav.com provides a disclaimer that encourages pilots to obtain a current AFD for their specific region. The basic idea behind the sample Web Service is that a pilot could type in the region or state and the locator would find an airport in that area. The information returned by the Web Service might include runway information, details about field FBOs (fixed base operators), and related goods and services.

Figure 1Figure 1 AirNav.com is a useful resource for pilots.

Listing 1 provides a couple of enumerated types and classes that we might implement to support the Web Service. I prefer to implement this kind of code in a class library, distinct from the Web Service project, to facilitate reuse in another context. (For example, I might want to create a Windows version of an application based on this code.)

Listing 1—Code To Implement an Airport Locator Application

using System;
using System.Collections;
using System.Drawing;
using System.IO;

namespace AirportLocatorLibrary
{
 public enum Region
 {
  NorthEast, SouthEast, MidWest,
  SouthWest, NorthWest,
  Mexico, Canada
 }

 public enum State
 {
  Alabama, Alaska, Arkansas, Connecticut, Ohio, Michigan,
  Indiana, Illinois, Kansas, California, NewYork, NewJersey,
  Florida, Washington, Oregon, Texas, Nevada /* etc */
 }

 public class AirportLocator : ReadOnlyCollectionBase
 {
  public AirportLocator(): base() {}
  public AirportLocator(Region region) : base()
  {
   InitializeByRegion(region);
  }

  public AirportLocator( State state ) : base()
  {
   InitializeByState(state);
  }

  public Airport this[int index]
  {
   get{ return (Airport)InnerList[index]; }
  }

  public int Add(Airport value)
  {
   return InnerList.Add(value);
  }

  private void InitializeByRegion(Region region)
  {
   if( region != Region.MidWest ) return;
   InitializeByState(State.Michigan);
  }

  private void InitializeByState(State state)
  {
   if( state != State.Michigan ) return;

   Airport airport = new Airport();
   airport.Airspace = Airspace.ClassE;
   airport.Name = "Mason Jewitt";
   airport.FboName = "Aerogenesis";
   airport.AwosFrequency = 119.425;
   airport.UnicomFrequency = 122.7;
   airport.CallSign = "KTEW";
   airport.FieldElevation = 919;
   airport.Position = new Position(
    "42-33.94610N / 084-25.39312W", _
    "42-33-56.766N / 084-25-23.587W");
   airport.VorFrequency = 110.8;
   airport.State = State.Michigan;

   airport.Description =
    "Small airport. (Note: Spartan Wings flying club)";

   Runway runway = new Runway();
   runway.Length = 4000;
   runway.Width = 75;
   runway.Number = 27;

   airport.Runways = new Runway[]{runway};
   airport.NearestCity = "Mason";

   Add(airport);
  }
 }

 public enum Airspace
 {
  ClassA, ClassB, ClassC, ClassD, ClassE, ClassG
 }

 public class Position
 {
  string longitude;
  string latitude;

  public Position(){}
  public Position(string longitude, string latitude)
  {
   this.longitude = longitude;
   this.latitude = latitude;
  }

  public string Longitude
  {
   get{ return longitude; }
   set{ longitude = value; }
  }

  public string Latitude
  {
   get{ return latitude; }
   set{ latitude = value; }
  }
 }

 public class Airport
 {
  private string name;
  private string callSign;
  private Position position;
  private Airspace airspace;
  private State state;
  private string nearestCity;
  private Runway[] runways;
  private string description;
  private double towerFrequency;
  private double unicomFrequency;
  private double atisFrequency;
  private double awosFrequency;
  private double vorFrequency;
  private string fboName;
  private double fieldElevation;

  public Airport(){}

  public string Name
  {
   get{ return name; }
   set{ name = value; }
  }

  public string CallSign
  {
   get{ return callSign; }
   set{ callSign = value; }
  }

  public Position Position
  {
   get{ return position; }
   set{ position = value; }
  }

  public Airspace Airspace
  {
   get{ return airspace; }
   set{ airspace = value; }
  }

  public State State
  {
   get{ return state; }
   set{ state = value; }
  }

  public string NearestCity
  {
   get{ return nearestCity; }
   set{ nearestCity = value; }
  }

  public Runway[] Runways
  {
   get{ return runways; }
   set{ runways = value; }
  }

  public string Description
  {
   get{ return description; }
   set{ description = value; }
  }

  public double TowerFrequency
  {
   get{ return towerFrequency; }
   set{ towerFrequency = value; }
  }

  public double UnicomFrequency
  {
   get{ return unicomFrequency; }
   set{ unicomFrequency = value; }
  }

  public double AtisFrequency
  {
   get{ return atisFrequency; }
   set{ atisFrequency = value; }
  }

  public double AwosFrequency
  {
   get{ return awosFrequency; }
   set{ awosFrequency = value; }
  }

  public double VorFrequency
  {
   get{ return vorFrequency; }
   set{ vorFrequency = value; }
  }

  public string FboName
  {
   get{ return fboName; }
   set{ fboName = value; }
  }

  public double FieldElevation
  {
   get{ return fieldElevation; }
   set{ fieldElevation = value; }
  }
 }

 public enum Direction
 {
  East, North, West, South
 }

 public class Runway
 {
  private int number;
  private double length;
  private double width;
  private double elevation;
  private string unit;
  private Direction prevailingWind;

  public int Number
  {
   get{ return number; }
   set{ number = value; }
  }

  public int Heading
  {
   get{ return number * 10; }
  }

  public double Length
  {
   get{ return length; }
   set{ length = value; }
  }

  public double Width
  {
   get{ return width; }
   set{ width = value; }
  }

  public string Unit
  {
   get{ return unit; }
   set{ unit = value; }
  }

  public double Elevation
  {
   get{ return elevation; }
   set{ elevation = value; }
  }

  public Direction PrevailingWind
  {
   get{ return prevailingWind; }
   set{ prevailingWind = value; }
  }
 }
}

The code in Listing 1 implements a ReadOnlyCollectionBase, a strongly typed collection, but we could have just as easily used an ADO.NET DataSet. The code has types that describe things like runways, radio frequencies, and airport locations.

The code in Listing 1 is not a Web Service; rather, Listing 1 provides a partial, general solution to managing information about airports. Comparatively, the Web Service itself is the easy part.

The Web Service as I defined it accepts information indicating the general area in which we want to search for airports, and returns a strongly typed collection of Airport objects. (Because I only have one test airport, in the InitializeByState method, the AirportLocator will always return Mason Jewitt's airport information. A real application would probably read this information from a persistent data store—perhaps a database or XML file.) Listing 2 shows the Web Service code, most of which is generated when you create an ASP.NET Web Service project.

Listing 2—The Web Service Code

using System;
using System.Collections;
using System.ComponentModel;
using System.Data;
using System.Diagnostics;
using System.Web;
using System.Web.Services;

namespace AirportLocator
{
 /// <summary>
 /// Summary description for Service1.
 /// </summary>
 public class Service1 : System.Web.Services.WebService
 {
  public Service1()
  {
   //CODEGEN: Call is required by the ASP.NET Web Services Designer
   InitializeComponent();
  }

  #region Component Designer generated code
  //Required by the Web Services Designer
  private IContainer components = null;

  /// <summary>
  /// Required method for Designer support - do not modify
  /// the contents of this method with the code editor.
  /// </summary>
  private void InitializeComponent()
  {
  }

  /// <summary>
  /// Clean up any resources being used.
  /// </summary>
  protected override void Dispose( bool disposing )
  {
   if(disposing && components != null)
   {
    components.Dispose();
   }
   base.Dispose(disposing);
  }
  #endregion

  [WebMethod()]
  public AirportLocatorLibrary.AirportLocator GetAirports(string state)
  {
   return new AirportLocatorLibrary.AirportLocator(
    AirportLocatorLibrary.State.Michigan);
  }

 }
}

This code may look daunting until I tell you that we only have to add the six lines in bold beginning with the WebMethodAttribute and ending with the method curly brace. (By convention we drop the Attribute suffix when applying attributes, and web methods are public.) The rest of the code is part of the ASP.NET Web Service project template.

The rest of our job is just programming, taken care of by the Microsoft Web Services technology. To recap, this code invokes the AirportLocatorLibrary.AirportLocator factory method, which constructs our list of Airports. Here are the steps for creating the Web Service:

  1. Create a new class library project in a new solution.

  2. Add the code from Listing 1 to a .cs module.

  3. Add an ASP.NET Web Service project to the same solution as the one containing the class library.

  4. In the ASP.NET Web Service project, add a project reference to the class library containing the Aiport code.

  5. Add the bold case code from Listing 2 to the Web Service Service1.asmx.cs code behind the file.

Make the Web Service project the startup project, and press F5 to run the Web Service.

When you run the Web Service directly, you get a test page similar to the one shown in Figure 2. Click the GetAiports link (this is the web method defined in Listing 2) to test the web method.

TIP

To ensure that you have a distinct name for your Web Service, change the WebServiceAttribute namespace argument before deploying your Web Service. For example, place this immediately before the class header in Listing 2:

[WebService(Namespace = http://www.softconcepts.com")]

Figure 2Figure 2 When you browse to an .asmx page, a test page is created that provides a simple interface allowing you to test web methods.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020