SubmitGenerateExposureViewSummary Method

Submits a request to generate an Exposure View Summary for a specific Touchstone® Exposure View.

Syntax

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

Public Function SubmitGenerateExposureViewSummary( _
   ByVal request As SubmitGenerateExposureViewSummaryRequest _
) As SubmitGenerateExposureViewSummaryResponse

Dim instance As ExposureViewSummaryServiceClient
Dim request As SubmitGenerateExposureViewSummaryRequest
Dim value As SubmitGenerateExposureViewSummaryResponse
 
value = instance.SubmitGenerateExposureViewSummary(request)

public SubmitGenerateExposureViewSummaryResponse SubmitGenerateExposureViewSummary( 
   SubmitGenerateExposureViewSummaryRequest request
)

Parameters

request: Contains a SubmitGenerateExposureViewSummaryRequest that identifies the options that specify the characteristics of the Exposure View Summary that you want to generate, along with the associated Touchstone-generated Business Unit Sequential Identifier (SID) and SQL Instance SID.
The Options property contains an ExposureViewSummaryOptions object that enables you to specify the SID of the Exposure View to include in the Exposure View Summary, as well as the desired currency and currency exchange rate.

Return Value

A SubmitGenerateExposureViewSummaryResponse containing the Activity SID that uniquely identifies the asynchronous web service call that you made to generate the specified Exposure View Summary.

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 Exposure View SID to pass into this method, call the GetExposureViews() method. (To find the Project SID to pass into the GetExposureViews() method, call the GetProjects() method.)

Example

The following example shows how to request the generation of a Touchstone Exposure View Summary using the SubmitGenerateExposureViewSummary() method:

using System;
using AIR.Services.Common.Data;
using AIR.Services.ExposureViewSummary.Api;
using AIR.Services.ProjectManagement.Data;
            
class SnippetSubmitGenerateExposureViewSummaryRequest
{
    private static void GenerateExposureViewSummary(int businessUnitSid, int sqlInstanceSid, int exposureViewSid)
    {
        ExposureViewSummaryServiceClient client = new ExposureViewSummaryServiceClient();
        SubmitGenerateExposureViewSummaryRequest request = new SubmitGenerateExposureViewSummaryRequest();
        request.BusinessUnitSid = businessUnitSid;
        request.SqlInstanceSid = sqlInstanceSid;
        request.Options = new ExposureViewSummaryOptions
        {
            Currency = "USD",
            CurrencyExchangeRateSid = 3,
            ExposureViewSid = exposureViewSid
        };
            
        SubmitGenerateExposureViewSummaryResponse response = client.SubmitGenerateExposureViewSummary(request);
        if (response.Status.Code == StatusCode.Success)
        {
            Console.WriteLine("Request successfully submitted with Activity SID: " + response.ActivitySid);
        }
    }
}

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

ExposureViewSummaryServiceClient Class
ExposureViewSummaryServiceClient Members