Reporting

Service for generating and accessing reports.

FetchProducedReport

Receive a specific produced report by its GUID.
The call will return a result code 0 if everything went ok. If something went wrong it will return a result code other than 0 and the result text will contain information about error.

Examples

Sample usage in C# with generated client: 
 ReportingClient client = new ReportingClient();

FetchProducedReportResult result = client.FetchProducedReport("BA7193BC-36C8-466C-83B1-A11C82D80824");
Sample soap request: 
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
   <soapenv:Header/>
   <soapenv:Body>
	  <urn:FetchProducedReport>
		 <urn:ProducedReportGuid>BA7193BC-36C8-466C-83B1-A11C82D80824</urn:ProducedReportGuid>
	  </urn:FetchProducedReport>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    FetchProducedReport

    FetchProducedReport class

    • ProducedReportGuid

      Produced report GUID value.

      string

Output

Returns with result code 0 with produced report details if call was successful, otherwise read result text for error information.
Error codes:
  • 1 : error message from ARC server.
Object

FetchProducedReportResponse

FetchProducedReportResponce class

  • FetchProducedReportResult

    Result of FetchProducedReport
    Object

    FetchProducedReportResult

    The result of fetching produced report.

    • Extension

      Report file extension

      string

    • FileContent

      Report file content.

      string

    • FileDescription

      Report file description.

      string

    • Result

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string

GenerateReport

Generates report according to specified parameters.
The call will return a result code 0 if everything went ok. If something went wrong it will return a result code other than 0 and the result text will contain information about error.

Examples

Sample usage in C# with generated client: 
 ReportingClient client = new ReportingClient();
 
 try
 {
 GenerateReportResult result = client.GenerateReport(
      new GenerateReportRequest()
      {
          Arguments = new[]
          {
               new ReportArgumentValue
               {
                    Name = "creditorid",
                    Value = "5860"
               },
               new ReportArgumentValue
               {
                    Name = "subclients",
                    Value = "1"
               },
               new ReportArgumentValue
               {
                    Name = "reportfordate",
                    Value = "2018-09-28"
               }
          },
          ReportName = "stdrpt_100002_q_customer_list",
          ReportType = ReportType.Data
	         });
     );
 
     if (result.Result.ResultCode != 0)
     {
         throw new Exception(result.Result.ResultText ?? "Unknown error");
     }
 }
 catch(Exception e)
 {
     throw new Exception("Failed to generate report.", e);
 }
Sample soap request: 
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
   <soapenv:Header/>
   <soapenv:Body>
	  <urn:GenerateReport>
		 <urn:ReportRequest>
			<urn:Arguments>
			   <urn:ReportArgumentValue>
				  <urn:Name>creditorid</urn:Name>
				  <urn:Value>5860</urn:Value>
			   </urn:ReportArgumentValue>
			   <urn:ReportArgumentValue>
				  <urn:Name>subclients</urn:Name>
				  <urn:Value>1</urn:Value>
			   </urn:ReportArgumentValue>
			   <urn:ReportArgumentValue>
				  <urn:Name>reportfordate</urn:Name>
				  <urn:Value>2018-09-28</urn:Value>
			   </urn:ReportArgumentValue>
			</urn:Arguments>
			<urn:ReportName>stdrpt_100002_q_customer_list</urn:ReportName>
			<urn:ReportType>Data</urn:ReportType>
		 </urn:ReportRequest>
	  </urn:GenerateReport>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GenerateReport

    GenerateReport class

    • ReportRequest

      List of report arguments and parameters required for report generating.
      ReportName, ReportType and three arguments () are required for this request.
      Object

      GenerateReportRequest

      Generate report request type.

      • Arguments

        List of additional report arguments.
        Array
        Object

        ReportArgumentValue

        Report argument value type.

        • Name

          Argument name.

          string

        • Value

          Argument vale.

          string

      • Offset

        Report offset parameter.

        int

      • ReportName

        Report name.

        string

      • ReportType

        Report type parameter.
        Enum

        ReportType

        Report type.

        • All

          All reports type.

        • Data

          Data report type.

        • PDF

          PDF report type.

        • XLS

          XLS report type.

      • StoreReport

        Store report bool trigger. Affects only PDF report.

        bool

Output

Returns with result code 0 if call was successful, otherwise read result text for error information.
Error codes:
  • 1 : error message from ARC server.
Object

GenerateReportResponse

GenerateReport response

  • GenerateReportResult

    Result of GenerateReport
    Object

    GenerateReportResult

    The result of the generate report request.

    • DataRows

      List of report result data rows.
      Array
      Object

      ReportResults

      Report results information.

      • Rows

        List of report result data rows.
        Array
        Object

        ReportResultData

        Report result data information.

        • Value

          Report result value.

          string

    • FooterRows

      List of report result footer rows.
      Array
      Object

      ReportResults

      Report results information.

      • Rows

        List of report result data rows.
        Array
        Object

        ReportResultData

        Report result data information.

        • Value

          Report result value.

          string

    • Headers

      List of report headers.
      Array
      Object

      ReportResultHeader

      Report result header information.

      • Format

        Report result header format.

        string

      • Name

        Report result header name.

        string

      • Title

        Report result header title .

        string

    • ProducedReportGuid

      Produced report GUID string.

      string

    • ReportFileContents

      BASE64 encoded string with file contents.

      string

    • ReportType

      Report type information.
      Enum

      ReportType

      Report type.

      • All

        All reports type.

      • Data

        Data report type.

      • PDF

        PDF report type.

      • XLS

        XLS report type.

    • Result

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string

GetChartData

Receive data of specified chart.
The call will return a result code 0 if everything went ok. If something went wrong it will return a result code other than 0 and the result text will contain information about error.

Examples

Sample usage in C# with generated client: 
ReportingClient client = new ReportingClient();

try
{
    GetChartDataResult result = client.GetChartData("stat_bar_newaccountsbymonth");

    if (result.Result.ResultCode != 0)
    {
        throw new Exception(result.Result.ResultText ?? "Unknown error");
    }
}
catch(Exception e)
{
    throw new Exception("Failed to get chart data", e);
}
Sample soap request: 
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
    <urn:GetChartData>
        <urn:ChartName>stat_bar_newaccountsbymonth</urn:ChartName>
    </urn:GetChartData>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetChartData

    GetChartData class

    • ChartName

      Specified chart name to receive chart data.

      string

Output

Returns with result code 0 if call was successful, otherwise read result text for error information.
Error codes:
  • 1 : error message from ARC server.
Object

GetChartDataResponse

GetChartData response

  • GetChartDataResult

    Result of GetChartData
    Object

    GetChartDataResult

    The result of the get chart data request.

    • BarChartSeries

      Bar chart or stacked bar chart data array.
      Array
      Object

      BarChartData

      Bar chart data type.

      • Category

        Category name.

        string

      • Data

        Bar data array.
        Array
        Object

        BarData

        Bar data type.

        • Value

          Bar data value.

          decimal

    • ChartType

      Chart type.
      Enum

      ChartType

      Chart type information.

      • DonutChart

        Donut chart type.

      • BarChart

        Bar chart type.

      • PieChart

        Pie chart type.

      • LineChart

        Line chart type.

      • StackedBarChart

        Stacked bar chart type.

    • DonutChartSeries

      Donut chart data array.
      Array
      Object

      DonutChartData

      Chart legend posiion information.

      • Category

        Chart legend posiion information.

        string

      • Value

        Chart legend posiion information.

        decimal

    • HorizontalAlignment

      Horizontal alignment bool flag.

      bool

    • LegendPosition

      Chart legend posiion information.
      Enum

      ChartLegendPosition

      Chart legent position type.

      • Top

        Chart legent position top.

      • Bottom

        Chart legent position bottom.

      • Left

        Chart legent position left.

      • Right

        Chart legent position right.

    • LineChartSeries

      Line chart data array.
      Array
      Object

      LineChartData

      Line chart data type.

      • Category

        Line category name.

        string

      • Data

        Line data array.
        Array
        Object

        LineData

        Line data type.

        • Category

          Line category name.

          string

        • Value

          Line value.

          decimal

    • PieChartSeries

      Pie chart data array.
      Array
      Object

      PieChartData

      Pie chart data type.

      • Category

        Pie item category.

        string

      • Value

        Pie item value.

        decimal

    • Result

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string

    • ShowLegend

      Show legend bool flag.

      bool

    • ShowTitle

      Show title bool flag.

      bool

    • ShowTooltip

      Show tooltip bool flag.

      bool

    • TitlePosition

      Chart title posiion information.
      Enum

      ChartTitlePosition

      Chart title position type.

      • Top

        Chart title position top.

      • Bottom

        Chart title position bottom.

    • TooltipTemplate

      Tooltip template string.

      string

GetChartList

Receive a list of available charts.
The call will return a result code 0 if everything went ok. If something went wrong it will return a result code other than 0 and the result text will contain information about error.

Examples

Sample usage in C# with generated client: 
ReportingClient client = new ReportingClient();

try
{
    GetChartListResult result = client.GetChartList( new string[] { "stat_bar_newaccountsbymonth" });

    if (result.Result.ResultCode != 0)
    {
        throw new Exception(result.Result.ResultText ?? "Unknown error");
    }
}
catch(Exception e)
{
    throw new Exception("Failed to get chart list", e);
}
Sample soap request: 
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:GetChartList>
            <!--Optional:-->
            <urn:filter>
                <!--Zero or more repetitions:-->
                <arr:string>stat_pie_extrenalaccounts</arr:string>
            </urn:filter>
        </urn:GetChartList>
    </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetChartList

    GetChartList class

    • filter

      Optional list of filtering strings, for example list of chart names.
      Array

      string

Output

Returns with result code 0 if call was successful, otherwise read result text for error information.
Error codes:
  • 1 : error message from ARC server.
Object

GetChartListResponse

GetChartList response

  • GetChartListResult

    Result of GetChartList
    Object

    GetChartListResult

    The result of the get chart list request.

    • Charts

      List with charts details.
      Array
      Object

      ChartInformation

      Chart information.

      • BlockWidth

        Chart block width.

        int

      • ChartType

        Chart type information.
        Enum

        ChartType

        Chart type information.

        • DonutChart

          Donut chart type.

        • BarChart

          Bar chart type.

        • PieChart

          Pie chart type.

        • LineChart

          Line chart type.

        • StackedBarChart

          Stacked bar chart type.

      • ForegroundColor

        Chart foreground color.

        string

      • LocalizedDescription

        Chart localized description string.

        string

      • Name

        Chart name.

        string

    • Result

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string

GetReportArguments

Receive a list of argument for specified report.
The call will return a result code 0 if everything went ok. If something went wrong it will return a result code other than 0 and the result text will contain information about error.

Examples

Sample usage in C# with generated client: 
 ReportingClient client = new ReportingClient();

GetReportArgumentsResult result = client.GetReportArguments("stdrpt_000016_q_activitylog");
Sample soap request: 
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetReportArguments>
         <urn:Name>stdrpt_000016_q_activitylog</urn:Name>
      </urn:GetReportArguments>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetReportArguments

    GetReportArguments

    • Name

      Name of report file without extension from reports definition folder.

      string

Output

Returns the list of specified report arguments with result code 0 if call was successful, otherwise read result text for error information.
Error codes:
  • 1 : error message from ARC server.
Object

GetReportArgumentsResponse

GetReportArguments response

  • GetReportArgumentsResult

    Result of GetReportArguments
    Object

    GetReportArgumentsResult

    The result of get report arguments request.

    • Arguments

      List of report arguments.
      Array
      Object

      ReportArgument

      Report argument information.

      • DefaultValue

        Report argument default value.

        string

      • Enabled

        Report argument enabled flag.

        bool

      • FieldType

        Report argument field type.
        Enum

        ArgumentFieldType

        Report argument field type.

        • String

          Report argument string field type.

        • Int

          Report argument integer field type.

        • Date

          Report argument date field type.

        • Money

          Report argument money field type.

        • Bool

          Report argument boolean field type.

      • LocalizedLabel

        Report argument localized label.

        string

      • Lookup

        Report argument lookup string.

        string

      • MaxLength

        Report argument max lenght.

        int

      • Name

        Report argument name.

        string

      • Required

        Report argument required flag.

        bool

      • Selectable

        Report argument selectable flag.

        bool

    • LocalizedName

      Report localized name.

      string

    • Result

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string

GetReportList

Receive a list of produced reports.
The call will return a result code 0 if everything went ok. If something went wrong it will return a result code other than 0 and the result text will contain information about error.

Examples

Sample usage in C# with generated client: 
 ReportingClient client = new ReportingClient();

GetReportListResult result = client.GetReportList(ReportType.PDF);
Sample soap request: 
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetReportList>
         <urn:ReportType>PDF</urn:ReportType>
      </urn:GetReportList>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetReportList

    GetReportList

    • ReportType

      Report type parameter.
      Enum

      ReportType

      Report type.

      • All

        All reports type.

      • Data

        Data report type.

      • PDF

        PDF report type.

      • XLS

        XLS report type.

Output

Returns list of available reports.
Error codes:
  • 1 : error message from ARC server.
Object

GetReportListResponse

GetReportList response

  • GetReportListResult

    Result of GetReportList
    Object

    GetReportListResult

    The result of the GetReportListResult request.

    • Reports

      Array of reports returned by request.
      Array
      Object

      ReportInformation

      Report information type.

      • Description

        Report description string.

        string

      • Group

        Report group string.

        string

      • Name

        Report name string.

        string

      • ReportType

        Report type.
        Enum

        ReportType

        Report type.

        • All

          All reports type.

        • Data

          Data report type.

        • PDF

          PDF report type.

        • XLS

          XLS report type.

      • System

        Report system string.

        string

    • Result

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string

ListProducedReports

Receive a list of produced reports.
The call will return a result code 0 if everything went ok. If something went wrong it will return a result code other than 0 and the result text will contain information about error.

Examples

Sample usage in C# with generated client: 
 ReportingClient client = new ReportingClient();

ListProducedReportsResult result = client.ListProducedReports(new ListProducedReportsFilter(), null, null);
Sample soap request: 
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:ListProducedReports>
         <urn:Filter>
            <urn:ProductionDateFrom>2018-09-14</urn:ProductionDateFrom>
            <urn:ProductionDateTo>2018-09-19</urn:ProductionDateTo>
         </urn:Filter>
         <urn:Offset>0</urn:Offset>
         <urn:Order>LastOpenedAt</urn:Order>
      </urn:ListProducedReports>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    ListProducedReports

    ListProducedReports

    • Filter

      Information used to filter produced reports.
      Object

      ListProducedReportsFilter

      List produced reports filter type.

      • AccountingDateFrom

        Filter reports by specified accountion from date.

        DateTime

      • AccountingDateTo

        Filter reports by specified accountion to date.

        DateTime

      • ClientReferenceNumber

        Filtering trigger by client reference number.

        string

      • Description

        Filter reports by specified description.

        string

      • Hidden

        Filter reports by hidden flag.
        Enum

        YesNoAll

        Filtering trigger type. Applied to filter report properties by enabled, disabled or include both states.

        • No

          No value.

        • Yes

          Yes value.

        • All

          All value.

      • JournalNoFrom

        Filter reports by journal number from specified value.

        string

      • JournalNoTo

        Filter reports by journal number to specified value.

        string

      • OpenedErlier

        Filter reports by opened earlier flag.
        Enum

        YesNoAll

        Filtering trigger type. Applied to filter report properties by enabled, disabled or include both states.

        • No

          No value.

        • Yes

          Yes value.

        • All

          All value.

      • ProducedReportType

        Filtering trigger by produced report type.
        Enum

        ProducedReportType

        Produced report identification type.

        • Unknown

          Unknown report type.

        • LedgerJournal

          Ledger journal report type.

        • AccountingJournal

          Accounting journal report type.

        • InvoiceJournal

          Invoice journal report type.

        • PaymentJournal

          Payment journal report type.

        • TrustAccounting

          Trust accounting report type.

        • CreditorAccountDeduction

          Creditor account deduction report type.

        • PurchaseJournal

          Purchase journal report type.

        • RegressJournal

          Regress journal report type.

        • InvoicePledge

          Invoice pledge report type.

        • CreditorReport

          Creditor report type.

        • RexExport

          Rex export report type.

        • FactoringAccount

          Factoring account report type.

        • Other

          Other report type.

        • TaskPackageQueueReceipt

          Task package queue receipt report type.

        • CreditorAccountDeductionSummary

          Creditor account deduction summary report type.

      • ProductionDateFrom

        Filer repords by specified production from date.

        DateTime

      • ProductionDateTo

        Filer repords by specified production to date.

        DateTime

      • Purged

        Purged reports filtering trigger.
        Enum

        YesNoAll

        Filtering trigger type. Applied to filter report properties by enabled, disabled or include both states.

        • No

          No value.

        • Yes

          Yes value.

        • All

          All value.

      • WithoutReferences

        Reports wIthout reference filtering trigger.
        Enum

        YesNoAll

        Filtering trigger type. Applied to filter report properties by enabled, disabled or include both states.

        • No

          No value.

        • Yes

          Yes value.

        • All

          All value.

    • Offset

      Optionally apply offset in reports count for result list.

      int

    • Order

      Optionally sort list of produced reports according psecified value.
      Enum

      ProducedReportSortOrder

      Produced report sorting order type.

      • Default

        Default sorting order.

      • AccountingDate

        Sort by accounting date.

      • LastOpenedAt

        Sort by last opened date.

      • ClientJournalNo

        Sort by client journal number.

      • Client

        Sort by client.

      • Name

        Sort by name.

      • ProducedAt

        Sort by produced at date.

      • ProducedReportType

        Sort by report type.

Output

Returns with result code 0 if call was successful, otherwise read result text for error information.
Error codes:
  • 1 : error message from ARC server.
Object

ListProducedReportsResponse

ListProducedReports response

  • ListProducedReportsResult

    Result of ListProducedReports
    Object

    ListProducedReportsResult

    The result of the ListProducedReports request.

    • Offset

      Indicating offset of returned list of reports.

      int

    • Reports

      List of produced reports filtered according to request parameters.
      Array
      Object

      ProducedReport

      Produced report type.

      • AccountingDate

        Accounting date.

        DateTime

      • ClientReferenceName

        Client reference name.

        string

      • Description

        Report description.

        string

      • Extension

        Report file Extension

        string

      • LastOpenedAt

        Last opened at date.

        DateTime

      • ProducedAt

        Produced at date.

        DateTime

      • ProducedReportGuid

        Produced report unique identificator.

        string

      • ProducedReportType

        Produced report type.
        Enum

        ProducedReportType

        Produced report identification type.

        • Unknown

          Unknown report type.

        • LedgerJournal

          Ledger journal report type.

        • AccountingJournal

          Accounting journal report type.

        • InvoiceJournal

          Invoice journal report type.

        • PaymentJournal

          Payment journal report type.

        • TrustAccounting

          Trust accounting report type.

        • CreditorAccountDeduction

          Creditor account deduction report type.

        • PurchaseJournal

          Purchase journal report type.

        • RegressJournal

          Regress journal report type.

        • InvoicePledge

          Invoice pledge report type.

        • CreditorReport

          Creditor report type.

        • RexExport

          Rex export report type.

        • FactoringAccount

          Factoring account report type.

        • Other

          Other report type.

        • TaskPackageQueueReceipt

          Task package queue receipt report type.

        • CreditorAccountDeductionSummary

          Creditor account deduction summary report type.

    • Result

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string

    • Total

      Indicating total count of reports.

      int

Ping

Make a ping request to see that the service is up and running.
This operation enables to check if service is available. The service will return a result code 0 if everything went ok. If something went wrong it will return a result code other than 0 and the result text will contain information about error. However if service is unreachable, e.g. not started, the service will not respond at all.

Examples

Sample usage in C# with generated client: 
ReportingClient client = new ReportingClient();

try
{
    GeneralResult result = client.Ping();

    if (result.Result.ResultCode != 0)
    {
        throw new Exception(result.Result.ResultText ?? "Unknown error");
    }
}
catch(Exception e)
{
    throw new Exception("Failed to ping reporting service.", e);
}
Sample soap request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:Ping/>
     </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    Ping

    Ping

Output

Returns with result code 0 if ping was successful, otherwise read result text for error information.
Object

GeneralResultResponse

GeneralResult response

  • GeneralResult

    Result of GeneralResult
    Object

    GeneralResult

    A general result containing a result with result code and result text.

    • Result

      The result of the request.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string