How to connect to a local web service from the Windows Phone 8 Emulator

Article
05/20/2016

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

This topic contains the following sections.

Quick solution

This section provides a quick summary of the solution for those who are familiar with WCF web services and with configuring and hosting services in IIS or IIS Express. For more detailed steps and screenshots, see the subsequent sections and procedures in this topic.

Quick solution with IIS Express

Create a firewall exception to allow HTTP requests through the firewall on the port that IIS Express is using.
Get the IP address of the development computer, if necessary, by running ipconfig.
Find the IIS Express configuration file, applicationhost.config, in the folder %USERPROFILE%\Documents\IISExpress\config\. The USERPROFILE environment variable typically has a value of C:\Users\<your user name>.
Open applicationhost.config with Notepad or another text editor and make the following changes.
1. Find the site element for the web service, WebServiceForTesting.
  
  If you don’t see the site element for the web service, you have to deploy the service at least one time to create the element.
2. Within the bindings section of the site element, copy the binding element and paste a copy directly below the existing binding element to create a second binding.
3. In the new binding element, replace localhost with the computer’s IP address.
4. Save the changes.
Run Visual Studio as administrator and open the Visual Studio solution.
In the phone app project, remove the service reference to the service if you have previously added it. Add a new service reference to the reconfigured web service.
1. In the Add Service Reference dialog box, in the Address box, replace localhost with the IP address of your development computer.
2. Click Go.
  
  The second binding for the service in the WCF project is discovered and displayed.
3. Click OK.
  
  A new service reference that uses the IP address of the development computer is added to the Windows Phone project.

Quick solution with IIS

Install the Windows feature HTTP Activation for WCF services.
Create a firewall exception to allow World Wide Web Services (HTTP) through the firewall.
Get the IP address of the development computer, if necessary, by running ipconfig.
Run Visual Studio as administrator and open the Visual Studio solution.
In the web service project, on the Web page of project properties, make the following changes:
1. Deselect the Use IIS Express option.
2. In the Url text box, replace localhost with the IP address of the development computer.
3. Click the Create Virtual Directory button.
4. Save the changes.
In the phone app project, remove the service reference to the service if you have previously added it. Add a new service reference to the reconfigured web service. Notice that the Url displayed in the Add Service Reference dialog box includes the IP address of the development computer.

Setting up projects to demonstrate the problem and test the solution

The Visual Studio solution described in this topic requires the Professional edition or higher of Visual Studio. The Express editions of Visual Studio do not include full support for WCF projects.

To set up the Windows Phone app project and the Visual Studio solution

In Visual Studio 2012 Professional or higher, create a new Windows Phone app. In this test, the project is named PhoneAppForTesting. Give the solution a different name than the project, since the solution will contain two projects. In this test, the solution is named ConnectToLocalWebService. Click OK.
In the New Windows Phone Application dialog box, select Windows Phone OS 8.0 as the target version. Click OK. The new solution and new Windows Phone project are created.

To set up the WCF web service project

In Solution Explorer, right-click on the solution and select Add, then select New Project.
In the Add New Project dialog box, in the list of installed templates, select the WCF category.
In the list of WCF project templates, select the WCF Service Application template. In this test, the project is called WebServiceForTesting. Click OK.

The solution described in this topic requires the WCF Service Application project type. A project of type WCF Service Library runs in a different host process, and cannot be reconfigured as described in this solution.

The new WCF service project is added to the solution.
In Solution Explorer, right-click on the service project and select Properties.
In Project Designer, click Web to open the page of web settings. The settings indicate that the project is configured by default to use IIS Express to host the service, and to connect to the service with a localhost URL.
Build the empty web service project. If you skip this step, you may get an error when you try to add a service reference to the Windows Phone project.
In Solution Explorer, in the web service project, right-click on Service.svc and select View in Browser. Your web browser opens and displays a page indicating that the service is recognized and available.

To configure the phone app project for testing the web service

In Solution Explorer, right-click on the Windows Phone app project and select Add Service Reference.
In the Add Service Reference dialog box, click Discover, then click Services in Solution.
In the Add Service Reference dialog box, click OK. A service reference is added to the Windows Phone project in the Service References folder in Solution Explorer.

On MainPage.xaml, add a TextBlock control to display the result returned by the web service. In this test, the TextBlock is named tbWebServiceResult.

        <!--ContentPanel - place additional content here-->
        <Grid x:Name="ContentPanel" Grid.Row="1" Margin="12,0,12,0">
            <TextBlock x:Name="tbWebServiceResult" Width="400" HorizontalAlignment="Center" VerticalAlignment="Center" TextWrapping="Wrap" FontSize="48"/>
        </Grid>

Open the MainPage.xaml.cs code file and add the following code. This code tests the web service by calling its GetData method, which is created by default in a new service project.

        private void TestWebService()
        {
            int testValue = 7;

            ServiceReference1.Service1Client clientForTesting = new ServiceReference1.Service1Client();
            clientForTesting.GetDataCompleted += new EventHandler<ServiceReference1.GetDataCompletedEventArgs>(TestCallback);
            clientForTesting.GetDataAsync(testValue);
        }

        private void TestCallback(object sender, ServiceReference1.GetDataCompletedEventArgs e)
        {
            this.tbWebServiceResult.Text = e.Result;
        }

In the MainPage constructor, after InitializeComponent(), add a line of code to call the TestWebService() method.

        // Constructor
        public MainPage()
        {
            InitializeComponent();

            TestWebService();
        }

To test connecting from the app running on the emulator to the local web service before configuring the solution

Press F5 to run the project in the emulator. The app tries to connect to the web service running on the development computer with localhost. After a few seconds, the app fails with an exception. You typically see a CommunicationException because the app can’t find the web service at localhost.

If you click the View Detail link, the View Detail dialog box opens and displays the following explanation.

The remote server returned an error: NotFound.
Press Shift-F5 to stop debugging.

Configuring the solution when hosting the service with IIS Express

To solve the connection problem caused by the localhost address, you have to configure the web service project and IIS Express to accept connections from other devices on the network. These devices connect to the service by using the IP address of the development computer on which the service is running.

To create a firewall exception for HTTP requests to IIS Express

From the Windows Start screen, search for Windows Firewall. Click to run the program.
On the Windows Firewall screen, click Advanced settings.
On the Windows Firewall with Advanced Security screen, select Inbound Rules. Then click New Rule.
On the Rule Type page of the New Inbound Rule Wizard, select Port. Then click Next.
On the Protocols and Ports page, enter the port number that IIS Express is using in the Specific local ports field. Then click Next.

You can find the port number on the Web page of project properties in Visual Studio.
On the Action page, select Allow the connection. Then click Next.
On the Profile page, select Private and, if applicable, Domain. Do not select Public. Then click Next.
On the Name page, type a name for the rule – for example, Local web service for testing. Then click Finish.

To configure the service and IIS Express to accept connections from the network

On the development computer, open a Command Prompt window and run ipconfig to get your IP address.
From the output of ipconfig, write down your IP address from the line of output captioned IPv4 Address.
Be aware of the following limitations.
- It may appear that you can easily change the address for the service on the Web page of project properties, where the Url of the service is displayed in an editable textbox. However, if you replace the displayed Url with http://<ip address>/, Visual Studio prompts you to create a virtual directory. If you click Yes, this process fails with an error.
- It may also appear that you can replace the Url by closing the solution and changing the IISUrl element manually in the .csproj project file. However, if you replace the value of the IISUrl element manually in the .csproj project file, you cannot reopen the project in Visual Studio. The error message includes the following statement:
  
  You must specify “localhost” for the server name.
Find the IIS Express configuration file, applicationhost.config, in the following folder. The USERPROFILE environment variable typically has a value of C:\Users\<your user name>.

%USERPROFILE%\Documents\IISExpress\config\
Open applicationhost.config with Notepad or another text editor.

In the configuration file, find the site element for the web service, WebServiceForTesting. The XML elements in the configuration file have the following hierarchy:

<configuration>
    <application Host>
        <sites>
            <site> … </site>
        </sites>
    </application Host>
</configuration>

The site element for the web service, WebServiceForTesting, has content similar to the following. If you don’t see the site element for the web service, you have to deploy the service at least one time to create the element.

   <site name="WebServiceForTesting" id="2">
     <application path="/" applicationPool="Clr4IntegratedAppPool">
       <virtualDirectory path="/" physicalPath="D:\My Projects\ConnectToLocalWebService\WebServiceForTesting" />
     </application>
     <bindings>
       <binding protocol="http" bindingInformation="*:60661:localhost" />
     </bindings>
   </site>

Within the bindings section of the site element, copy the binding element and paste a copy directly below the existing binding element to create a second binding.

Although you cannot remove the default localhost binding, you can create an additional binding that uses the computer’s IP address.

In the new binding element, replace localhost with the computer’s IP address. The bindings section now has content similar to the following:

     <bindings>
       <binding protocol="http" bindingInformation="*:60661:localhost" />
       <binding protocol="http" bindingInformation="*:60661:<ip address>" />
     </bindings>

Save the changed file.

You do not have to change the Url on the Web page of project properties, which continues to display localhost.

To verify that the service reference in the phone app project is using the IP address for the web service, check the endpoint element in the ServiceReferences.ClientConfig file.
If IIS Express is still running in the system tray, right-click its icon and select Exit. You have to restart the web server to load the changed configuration file.
If Visual Studio is still open, close Visual Studio and open it again by selecting Run as administrator. Reopen the solution. To register and connect to the web service at an address other than localhost, you have to run Visual Studio with administrator privileges.
Browse the service again to restart IIS Express.
Right-click on the IIS Express icon in the system tray and select Show All Applications. The IIS Express dialog box opens and shows the 2 bindings for the web service in the solution.

To configure the Windows Phone app to connect to IIS Express with an IP address

In Visual Studio, in the Windows Phone project, right-click the service reference in the Service References folder and select Delete. This step removes the service reference that uses the localhost address.
In the Add Service Reference dialog box, click Discover, then click Services in Solution.
In the Add Service Reference dialog box, in the Address box, replace localhost with the IP address of your development computer. Then click Go.
In the Add Service Reference dialog box, click OK. A new service reference that uses the IP address of the development computer is added to the Windows Phone project.

Configuring the solution when hosting the service with Internet Information Services (IIS)

There are fewer steps to configure the solution when hosting the service with Internet Information Services (IIS) than when hosting the service with IIS Express.

The following procedure assumes that IIS is installed and running on your development computer.

To install HTTP Activation for WCF services

From the Windows Start screen, search for Turn Windows features on or off. Click to run the program.
In the Windows Features dialog box, expand .NET Framework 4.5 Advanced Services, then expand WCF Services.
Under WCF Services, check the box next to HTTP Activation. Click OK to install this feature.

To create a firewall exception for HTTP requests to IIS

From the Windows Start screen, search for Allow an app through Windows Firewall. Click to run the program.
In the Allowed apps dialog box, click Change settings.
In the Allowed apps and features list, check the box next to World Wide Web Services (HTTP) to create a firewall exception for calls to the web service. Click OK.

To configure the service and IIS to accept connections from the network

Start or restart Visual Studio with the Run as administrator option and reopen the ConnectToLocalWebService solution.
In the WCF service project, right-click on the project and select Properties.
In Project Designer, click Web to open the page of web settings.
Deselect the Use IIS Express option. The Url displayed in the Project Url text box changes.
In the Url text box, replace localhost with the IP address of the development computer.
Click the Create Virtual Directory button. After a few seconds, a message indicates that the virtual directory has been created.
Save the changes made in Project Designer.

To configure the Windows Phone app to connect to IIS with an IP address

In Visual Studio, in the Windows Phone project, right-click the service reference in the Service References folder and select Delete. This step removes the existing service reference.
In the Add Service Reference dialog box, click Discover, then click Services in Solution. The service in the WCF project is discovered and displayed. Notice that the Url includes the IP address of the development computer.
In the Add Service Reference dialog box, click OK. A new service reference that uses the IP address of the development computer is added to the Windows Phone project

Testing the solution

After configuring the solution, retest your app. Now the app successfully finds and connects to the WCF web service running locally on the development computer.

To test connecting from the app running on the emulator to the local web service after configuring the solution

Press F5 to run the project in the emulator. The emulator starts and runs the app. After a few seconds, the result from the web service is displayed.
Press Shift-F5 to stop debugging.

Connecting to a web service that returns a SOAP or an XML response

Internet Explorer running on Windows Phone 8 cannot display responses that it receives from a web service in SOAP or XML format. If you use the browser on your phone to browse to a web service that sends responses in SOAP or XML format, the browser displays a blank screen.

Support resources

To find answers and solve problems as you work with the tools in Windows Phone SDK 8.0, visit the Tools for Windows Phone Development forum. To see all the forums for Windows Phone development, visit Windows Phone Development Forums. To review other support options, visit MSDN Troubleshooting and Support.