Skip to content

the-role-of-soap-in-reporting-services.md

Latest commit

 

History

History
58 lines (47 loc) · 4.07 KB

the-role-of-soap-in-reporting-services.md

File metadata and controls

58 lines (47 loc) · 4.07 KB
title The Role of SOAP in Reporting Services
description The Report Server Web service uses SOAP over HTTP. Report Manager provides an interface to the report server database, which stores reports and related content.
ms.date 09/25/2024
ms.service reporting-services
ms.subservice report-server-web-service
ms.topic reference
ms.custom
updatefrequency5
helpviewer_keywords
Web service [Reporting Services], SOAP
SOAP [Reporting Services], role in Reporting Services
Report Server Web service, SOAP
XML Web service [Reporting Services], SOAP

The role of SOAP in reporting services

The Report Server Web service uses Simple Object Access Protocol (SOAP) messaging to send text-based commands over a network. These commands take the form of XML text that is sent over the World Wide Web using HTTP. By using SOAP as its communication protocol, the Report Server Web service allows applications and components to exchange data with the report server using an open and widely accepted infrastructure. The SOAP standard is defined at www.w3.org/TR/SOAP.

Any client application can act as a SOAP client as long as it's SOAP-aware and can send SOAP requests. Report Manager is one such SOAP client. It provides an interface to the report server database in which all reports and report-related content is stored. End users can use the application to browse through and manage reports and folders in the report server namespace. Report Manager is built on the Report Server Web service infrastructure.

A report server acts as a SOAP server, a SOAP-aware service that can accept requests from SOAP clients and create appropriate responses. The server handles the requests and sends encoded responses back to the client.

SOAP messages in [!INCLUDEssRSnoversion] take many different forms, depending on the type of request made by the client. The following example represents a simple SOAP client request to remove an item from the report server database.

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">  
    <soap:Body>  
        <DeleteItem xmlns="http://www.microsoft.com/sql/ReportingServer">  
            <item>/Samples/Report1</item>  
        </DeleteItem>  
    </soap:Body>  
</soap:Envelope>

The SOAP itself requires that messages be put into an Envelope element, with the bulk of the message inside a Body element. In this example, the body contains a call to the xref:ReportService2010.ReportingService2010.DeleteItem%2A method, which takes a string parameter representing the path of the item to delete. You can create a [!INCLUDEmsCoName] [!INCLUDEdnprdnshort] client proxy class that encapsulates all SOAP operations into methods. The following [!INCLUDEmsCoName] [!INCLUDEc-sharp] method represents the SOAP example given earlier.

public void DeleteItem(string item);

The response from the server might look like the following example:

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">  
    <soap:Body>  
        <DeleteItemResponse xmlns="http://www.microsoft.com/sql/ReportingServer" />  
    </soap:Body>  
</soap:Envelope>

The xref:ReportService2010.ReportingService2010.DeleteItem%2A method has no return value, so an empty response is returned.

Related content