Web Service: CrystalReportService

Port CrystalReportService

Location:
http://<MRI_Evolution_Site_Path>/Services/Basic/CrystalReportService.svc
Protocol:
SOAP
Transport protocol:
SOAP over HTTP
Operations:
  1. GenerateReportDetail
  2. GetReportParametersDetail
  3. GetReportsDetail

Port type ICrystalReportService

1. GenerateReport

Style: document

Operation type: Request-response. The endpoint receives a message, and sends a correlated message.

Input: ICrystalReportService_GenerateReport_InputMessage (soap:body, use = literal)

parameters type GenerateReport

Parameter Name Required Type Description
sessionId Optional string sessionId parameter (nillable)
impersonateAccountId Optional long impersonateAccountId parameter (nillable)
reportId Optional long reportId parameter
parameters Optional ArrayOfCrystalReportParameterDto parameters parameter (nillable)
CrystalReportParameterDto Optional CrystalReportParameterDto CrystalReportParameterDto parameter (nillable)
DisplayText Optional string DisplayText parameter (nillable)
FilterQueryId Optional long FilterQueryId parameter
PrimaryKeyId Optional long PrimaryKeyId parameter
PrimaryTableCatalogId Optional long PrimaryTableCatalogId parameter
ValidateOnly Optional boolean ValidateOnly parameter
CurrentValues Optional ArrayOfanyType CurrentValues parameter (nillable)
anyType Optional anyType anyType parameter (nillable)
DataType Optional ParameterValueKind NumberParameter, CurrencyParameter, BooleanParameter, DateParameter, StringParameter, DateTimeParameter, TimeParameter
DefaultValues Optional ArrayOfanyType DefaultValues parameter (nillable)
anyType Optional anyType anyType parameter (nillable)
DisplayName Optional string DisplayName parameter (nillable)
EnableAllowEditingDefaultValue Optional boolean EnableAllowEditingDefaultValue parameter
EnableAllowMultipleValue Optional boolean EnableAllowMultipleValue parameter
EnableNullValue Optional boolean EnableNullValue parameter
HasCurrentValue Optional boolean HasCurrentValue parameter
HasCurrentValueField Optional boolean HasCurrentValueField parameter
IsOptionalPrompt Optional boolean IsOptionalPrompt parameter
MaximumValue Optional anyType MaximumValue parameter (nillable)
MinimumValue Optional anyType MinimumValue parameter (nillable)
Name Optional string Name parameter (nillable)
ParameterClass Optional ParameterType ReportParameter, StoreProcedureParameter, QueryParameter, ConnectionParameter, MetaDataParameter
PromptText Optional string PromptText parameter (nillable)
RestrictSelectionToList Optional boolean RestrictSelectionToList parameter
formatType Optional CrystalExportFormatType RichText, WordForWindows, Excel, PortableDocFormat, ExcelRecord

Output: ICrystalReportService_GenerateReport_OutputMessage (soap:body, use = literal)

parameters type GenerateReportResponse

Parameter Name Required Type Description
GenerateReportResult Optional string GenerateReportResult parameter (nillable)
Code Examples
C# Example
// Create the service client
using (var client = new CrystalReportServiceClient())
{
    // Create the request parameters
    string sessionId = "your_value_here";
    long impersonateAccountId = 123;
    long reportId = 123;
    
    // Call the service method
    var response = client.GenerateReport(sessionId, impersonateAccountId, reportId);
    
    // Process the response
    if (response != null)
    {
        // Handle successful response
        Console.WriteLine("Operation completed successfully");
    }
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
   <soap:Header/>
   <soap:Body>
      <bas:GenerateReport>
         <bas:sessionId>sample_value</bas:sessionId>
         <bas:impersonateAccountId>123</bas:impersonateAccountId>
         <bas:reportId>123</bas:reportId>
      </bas:GenerateReport>
   </soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/CrystalReportService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl

# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$reportId = 123

# Call the service method
$result = $proxy.GenerateReport($sessionId, $impersonateAccountId, $reportId)

# Process the result
if ($result) {
    Write-Host "Operation completed successfully"
    $result | Format-List
}

2. GetReportParameters

Style: document

Operation type: Request-response. The endpoint receives a message, and sends a correlated message.

Input: ICrystalReportService_GetReportParameters_InputMessage (soap:body, use = literal)

parameters type GetReportParameters

Parameter Name Required Type Description
sessionId Optional string sessionId parameter (nillable)
impersonateAccountId Optional long impersonateAccountId parameter (nillable)
reportId Optional long reportId parameter

Output: ICrystalReportService_GetReportParameters_OutputMessage (soap:body, use = literal)

parameters type GetReportParametersResponse

Parameter Name Required Type Description
GetReportParametersResult Optional ArrayOfCrystalReportParameterDto GetReportParametersResult parameter (nillable)
CrystalReportParameterDto Optional CrystalReportParameterDto CrystalReportParameterDto parameter (nillable)
DisplayText Optional string DisplayText parameter (nillable)
FilterQueryId Optional long FilterQueryId parameter
PrimaryKeyId Optional long PrimaryKeyId parameter
PrimaryTableCatalogId Optional long PrimaryTableCatalogId parameter
ValidateOnly Optional boolean ValidateOnly parameter
CurrentValues Optional ArrayOfanyType CurrentValues parameter (nillable)
anyType Optional anyType anyType parameter (nillable)
DataType Optional ParameterValueKind NumberParameter, CurrencyParameter, BooleanParameter, DateParameter, StringParameter, DateTimeParameter, TimeParameter
DefaultValues Optional ArrayOfanyType DefaultValues parameter (nillable)
anyType Optional anyType anyType parameter (nillable)
DisplayName Optional string DisplayName parameter (nillable)
EnableAllowEditingDefaultValue Optional boolean EnableAllowEditingDefaultValue parameter
EnableAllowMultipleValue Optional boolean EnableAllowMultipleValue parameter
EnableNullValue Optional boolean EnableNullValue parameter
HasCurrentValue Optional boolean HasCurrentValue parameter
HasCurrentValueField Optional boolean HasCurrentValueField parameter
IsOptionalPrompt Optional boolean IsOptionalPrompt parameter
MaximumValue Optional anyType MaximumValue parameter (nillable)
MinimumValue Optional anyType MinimumValue parameter (nillable)
Name Optional string Name parameter (nillable)
ParameterClass Optional ParameterType ReportParameter, StoreProcedureParameter, QueryParameter, ConnectionParameter, MetaDataParameter
PromptText Optional string PromptText parameter (nillable)
RestrictSelectionToList Optional boolean RestrictSelectionToList parameter
Code Examples
C# Example
// Create the service client
using (var client = new CrystalReportServiceClient())
{
    // Create the request parameters
    string sessionId = "your_value_here";
    long impersonateAccountId = 123;
    long reportId = 123;
    
    // Call the service method
    var response = client.GetReportParameters(sessionId, impersonateAccountId, reportId);
    
    // Process the response
    if (response != null)
    {
        // Handle successful response
        Console.WriteLine("Operation completed successfully");
    }
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
   <soap:Header/>
   <soap:Body>
      <bas:GetReportParameters>
         <bas:sessionId>sample_value</bas:sessionId>
         <bas:impersonateAccountId>123</bas:impersonateAccountId>
         <bas:reportId>123</bas:reportId>
      </bas:GetReportParameters>
   </soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/CrystalReportService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl

# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$reportId = 123

# Call the service method
$result = $proxy.GetReportParameters($sessionId, $impersonateAccountId, $reportId)

# Process the result
if ($result) {
    Write-Host "Operation completed successfully"
    $result | Format-List
}

3. GetReports

Style: document

Operation type: Request-response. The endpoint receives a message, and sends a correlated message.

Input: ICrystalReportService_GetReports_InputMessage (soap:body, use = literal)

parameters type GetReports

Parameter Name Required Type Description
sessionId Optional string sessionId parameter (nillable)
impersonateAccountId Optional long impersonateAccountId parameter (nillable)

Output: ICrystalReportService_GetReports_OutputMessage (soap:body, use = literal)

parameters type GetReportsResponse

Parameter Name Required Type Description
GetReportsResult Optional ArrayOfCrystalReportDto GetReportsResult parameter (nillable)
CrystalReportDto Optional CrystalReportDto CrystalReportDto parameter (nillable)
DisplayText Optional string DisplayText parameter (nillable)
FilterQueryId Optional long FilterQueryId parameter
PrimaryKeyId Optional long PrimaryKeyId parameter
PrimaryTableCatalogId Optional long PrimaryTableCatalogId parameter
ValidateOnly Optional boolean ValidateOnly parameter
AccessLevel Optional ReportType Public, Private, System, Publish
Category Optional string Category parameter (nillable)
Connection Optional ConnectionType Current, DefinedInReport, DataConnection
Description Optional string Description parameter (nillable)
Name Optional string Name parameter (nillable)
OwnedBy Optional long OwnedBy parameter
ReportId Optional long ReportId parameter
Code Examples
C# Example
// Create the service client
using (var client = new CrystalReportServiceClient())
{
    // Create the request parameters
    string sessionId = "your_value_here";
    long impersonateAccountId = 123;
    
    // Call the service method
    var response = client.GetReports(sessionId, impersonateAccountId);
    
    // Process the response
    if (response != null)
    {
        // Handle successful response
        Console.WriteLine("Operation completed successfully");
    }
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
   <soap:Header/>
   <soap:Body>
      <bas:GetReports>
         <bas:sessionId>sample_value</bas:sessionId>
         <bas:impersonateAccountId>123</bas:impersonateAccountId>
      </bas:GetReports>
   </soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/CrystalReportService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl

# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123

# Call the service method
$result = $proxy.GetReports($sessionId, $impersonateAccountId)

# Process the result
if ($result) {
    Write-Host "Operation completed successfully"
    $result | Format-List
}