GetDetailedLossAnalyses Method

Retrieves all Touchstone® Detailed Loss Analyses for a given Project within a specific Business Unit and SQL Server Instance.

The fundamental task of the Touchstone application is to analyze Project data. The Loss Analysis API enables you to improve the effectiveness and productivity of your catastrophic loss analyses by running multiple sensitivity analyses simultaneously. Input options include Event Sets, perils, and financial settings. Sensitivity analyses can vary Exposures or loss options. The Loss Analysis API stores each Detailed Loss Analysis as a Detailed Loss Analysis object, and you can use the GetDetailedLossAnalyses() method to retrieve a list of these objects for a particular Touchstone Project.

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#

Public Function GetDetailedLossAnalyses( _
   ByVal request As GetDetailedLossAnalysesRequest _
) As GetDetailedLossAnalysesResponse

Dim instance As LossAnalysisServiceClient
Dim request As GetDetailedLossAnalysesRequest
Dim value As GetDetailedLossAnalysesResponse
 
value = instance.GetDetailedLossAnalyses(request)

public GetDetailedLossAnalysesResponse GetDetailedLossAnalyses( 
   GetDetailedLossAnalysesRequest request
)

Parameters

request: Contains a GetDetailedLossAnalysesRequest that identifies the Touchstone-generated Business Unit Sequential Identifier (SID), SQL Instance SID, and Project SID associated with the list of Detailed Loss Analyses that you want to retrieve.

Return Value

A GetDetailedLossAnalysesResponse containing a list of Detailed Loss Analyses for the specified Project within the specified SQL Server Instance and Business Unit.

Remarks

To find the Business Unit SID to pass into this method, call the GetBusinessUnits() method.

To find the SQL Instance SID to pass into this method, call the GetSqlInstances() method.

To find the Project SID to pass into this method, call the GetProjects() method.

For information about retrieving the results of a specific Touchstone Detailed Loss Analysis, see the following methods:

For information about exporting the results of a Touchstone Detailed Loss Analysis, see the SubmitLossAnalysisExport() method.

For information about submitting a new Touchstone Detailed Loss Analysis job, see the SubmitDetailedLossAnalysis() method.

Example

The following example shows how to retrieve a list of all Touchstone Detailed Loss Analyses for a given Project within a specific Business Unit and SQL Server Instance using the GetDetailedLossAnalyses() method:

using System;
using AIR.Services.Common.Data;
using AIR.Services.LossAnalysis.Api;
using AIR.Services.LossAnalysis.Data;
            
class SnippetGetDetailedLossAnalysesRequest
{
    private static void GetLossAnalysis(int businessUnitSid, int sqlInstanceSid, int projectSid)
    {
        LossAnalysisServiceClient lossClient = new LossAnalysisServiceClient();
        GetDetailedLossAnalysesRequest request = new GetDetailedLossAnalysesRequest();
        request.BusinessUnitSid = businessUnitSid;
        request.SqlInstanceSid = sqlInstanceSid;
        request.ProjectSid = projectSid;
        GetDetailedLossAnalysesResponse response = lossClient.GetDetailedLossAnalyses(request);
        if (response.Status.Code == StatusCode.Success)
        {
            foreach (DetailedLossAnalysis analysis in response.Analyses)
            {
                Console.WriteLine("SID: " + analysis.Sid);
                Console.WriteLine("Name: " + analysis.AnalysisOptions.Name);
            }
        }
    }
}

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

LossAnalysisServiceClient Class
LossAnalysisServiceClient Members