Touchstone Re 2023 API Reference
What's New in the Touchstone Re APIs (Previous Releases)
Early access > What's New in the Touchstone Re APIs (Previous Releases)
 What's New in the Touchstone Re 2022 (10.0) APIs
The following sections describe the changes included in the Touchstone Re™ 2022 (10.0) APIs:
For a list of all the Touchstone Re functions available through the APIs, see Overview.

Highlights

We have implemented the following features and enhancements in the application programming interfaces (APIs) for the Touchstone Re 2022 (10.0) release.                       

New Objects and Properties

We have added the following objects and properties for Touchstone Re.

Objects Description

Reinsurance Company Loss Set Management Service Client

SubmitEventLossToUlf including SubmitEventLossToUlfRequest

and SubmitEventLossToUlfResponse

The new SubmitEventLossToUlf method enables you to convert the event loss tables in a text file to an user loss file format, and attach the ULF data to the reinsurance programs for further analysis in Touchstone Re. You can also import the ULF to a company in Touchstone Re. Additionally, you can save the user loss files in a currency of your choice. Providing you more flexibility for viewing loss results in both local and foreign currency.

We have implemented a new SubmitEventLossToUlf method in the existing Reinsurance Company Loss Set Management API to convert the event loss tables (ELT) in text file to a binary User Loss File (ULF) format .

The SubmitEventLossToUlfRequest class contains the ConvertEventLossToUlfOptions sub-class for configuring the input binary file with event loss tables. This sub-class contains the following properties.

The SubmitEventLossToUlfResponse class returns the sequential identifier (ActivitySID) associated with the activity.

Reinsurance Data Import Service Client  

SubmitCombineClfs including SubmitCombineClfsRequest

and SubmitCombineClfsResponse

The new SubmitCombineClfs method lets you combine multiple company loss files into a single company loss file (CLF). Then you can import this single CLF with a specific company in Touchstone Re for further downstream analysis.

We have implemented the following properties in the SubmitCombineClfsRequest class:

The SubmitCombineClfsResponse class returns the unique sequential identifier for this combine job and any warnings associated with this job.

Object Management Service Client

GetAggregateProgramAnalysisTemplates including GetAggregateProgramAnalysisTemplatesRequest 

and GetAggregateProgramAnalysisTemplatesResponse

The GetAggregateProgramAnalysisTemplates method retrieves a collection of the aggregate program loss analysis templates available for a Business Unit in Touchstone Re.

When you create a new loss template or modify a collection of existing loss templates in the Touchstone Re user interface is subsequently available in the API response when you make a request call next time. Any template you delete from the user interface is not available through the public API request.

The GetAggregateProgramAnalysisTemplatesRequest class inherits the Business Unit SID and SQL Server Instance ID from the request base. The GetAggregateProgramAnalysisTemplatesResponse class returns the ProgramAggregateLossAnalysisTemplates property. This property contains a collection of all the program loss templates within the requested Business Unit in Touchstone Re. The ProgramAggregateLossAnalysisTemplate Class in the AIR.Services.ObjectManagement.Data Namespace contains the unique identifiers such as name, SID, and description that identifies each template and the aggregate loss analysis options for the specific template associated with the SID. 

The AggregateLossAnalysisOptions base class includes the existing ProgramAggregateLossAnalysisOptions sub-class to capture the aggregate loss analysis options for each loss template in the Business Unit.

GetAggregatePortfolioAnalysisTemplates including GetAggregatePortfolioAnalysisTemplatesRequest 

and GetAggregatePortfolioAnalysisTemplatesResponse

The GetAggregatePortfolioAnalysisTemplates method retrieves a collection of the aggregate portfolio loss analysis templates available for a Business Unit in Touchstone Re.

When you create a new loss template or modify a collection of existing loss templates in the Touchstone Re user interface is subsequently available in the API response when you make a request call next time. Any template you delete from the user interface is not available through the public API request.

The GetAggregatePortfolioAnalysisTemplatesRequest class inherits the Business Unit SID and SQL Server Instance ID from the request base. The GetAggregatePortfolioAnalysisTemplatesResponse class returns the PortfolioAggregateLossAnalysisTemplates property. This property contains a collection of all the portfolio templates within the requested Business Unit in Touchstone Re. The PortfolioAggregateLossAnalysisTemplate Class in the AIR.Services.ObjectManagement.Data Namespace contains the unique identifiers such as name, SID, and description that identifies each template and the aggregate loss analysis options for the specific template associated with the SID. We have implemented the following properties to hold the specific template details:

The AggregateLossAnalysisOptions base class includes the existing PortfolioAggregateLossAnalysisOptions sub-class to capture the aggregate loss analysis options for each portfolio loss template in the Business Unit.

GetAggregateMultiProgramAnalysisTemplates including GetAggregateMultiProgramAnalysisTemplatesRequest 

and GetAggregateMultiProgramAnalysisTemplatesResponse

The GetAggregateMultiProgramAnalysisTemplates method retrieves a collection of multiple program analyses loss templates available for a Business Unit in Touchstone Re.

When you create a new multiple program loss template or modify a collection of existing loss templates in the Touchstone Re user interface is subsequently available in the API response when you make a request call next time. Any template you delete from the user interface is not available through the public API request.

The  GetAggregateMultiProgramAnalysisTemplatesRequest class inherits the Business Unit SID and SQL Server Instance ID from the request base. The GetAggregateMultiProgramAnalysisTemplatesResponse class returns the MultiProgramAggregateLossAnalysisTemplates property. This property contains a collection of multiple program loss templates within the requested Business Unit in Touchstone Re. The MultiProgramAggregateLossAnalysisTemplate Class in the AIR.Services.ObjectManagement.Data Namespace contains the unique identifiers such as name, SID, and description that identifies each template and the aggregate loss analysis options for the specific template associated with the SID. We have implemented the following properties to hold the specific template details:

The AggregateLossAnalysisOptions base class includes the existing MultiProgramAggregateLossAnalysisOptions sub-class to hold all the program SIDs and program filter for the multi-programs in the Business Unit.

AIR.Services.DataExport.Data

Program Perspectives   

The existing SubmitUploadProgramAggregateLossResultToAnalyzeRe method lets you upload loss results produced in Touchstone Re to AnalyzeRe. Previously, the application supported exporting loss perspectives only at a full (100%) participation level for the contract loss results.

With this enhancement, you can select the loss perspectives for a contract either at gross, net, or 100% participation level; and then export the contract results to the Analyze Re application. The exported loss results automatically pass the metadata elements with each set of loss results into Analyze Re.

We have implemented the following properties in the existing Program Perspectives class:             

AIR.Services.Reinsurance.ProgramManagement.Data

ProgramRelationship

Now you can specify the benefit flow for a new or an existing inuring relationship.

We have implemented a new InuringLossFlowType enumeration class in the ProgramRelationship class. This enumeration class lets you select the loss flow benefit for the programs associated in a series of inuring chains.

  • AllDownstreamPrograms = (Optional) Indicates whether Touchstone Re applies the loss flow benefit to all the subsequent children in that reinsurance structure.
  • NextProgramOnly = (Optional) Indicates whether Touchstone Re applies the loss flow benefit only to the direct child program in an inuring chain. Touchstone Re supports this inuring loss flow type only for the reinsurance program that is an inuring program, which means the IsSourcing field in the ProgramRelationship Class is equals to false.

 

Changed Objects and Properties

We have implemented the following change for the existing namespace.

Object Description

AIR.Services.Reinsurance.AggregateLossAnalysis.Data

ProgramLossOutputOptions and PortfolioLossOutputOptions

We have made an internal change in the loss output options classes for saving the loss analysis results. Previously, Zone Sets were supported only at the sub-area results resolution. Now the output options for the program and portfolio analyses does NOT require to save loss results tables by the sub-area geography level. This enables Touchstone Re to generate the loss results tables for cedants at event totals and zone sets.

Going forward, the following requests allows a combination of the Event Total results resolution along with Zone Sets. This produces loss results tables only at Event Totals and Zone Sets. The change in behavior is when you submit a portfolio or program aggregate loss analysis request with Event Totals and Zone Sets, Touchstone Re saves the loss results tables by Event Totals and Zone Sets; and, deletes the huge loss results tables by the sub-area resolution.

To generate loss results with event totals and zone sets, specify the following combination of cedant perspectives in Output Options for the Program and Portfolio Aggregate Loss analyses requests:

  • CedantPerspectiveGeographyLevel = EventTotal and CedantPerspectiveSaveByZoneSet = True
  • ReinsurerPerspectiveGeographyLevel = EventTotal and ReinsurerPerspectiveSaveByZoneSet = True

Deprecated/Removed Objects, Enums, and Properties

We have not deprecated any objects, enumerations, or properties for Touchstone Re.

 What's New in the Touchstone Re 2021 (9.0) APIs
The following sections describe the changes included in the Touchstone Re™ 2021 (9.0) APIs:
For a list of all the Touchstone Re functions available through the APIs, see Overview.

Highlights

AIR has implemented the following features and enhancements in the application programming interfaces (APIs) for the Touchstone Re 2021 (9.0) release.

The SubmitEventLossToUlf method in the ReinsuranceCompanyLossSetManagementServiceClient Namespace is only for future use. Do not apply change management process using this method.

New Objects and Properties

AIR has added the following objects and properties for Touchstone Re 9.0.

Objects Description

ActivityManagement API

SubmitDeleteActivities (including SubmitDeleteActivitiesRequest and SubmitDeleteActivitiesResponse)

AIR has enhanced the Activity Management API to include a new SubmitDeleteActivities method to choose and delete multiple activities in both Touchstone and Touchstone Re.                             

AIR has implemented a new DeleteActivityError class to identify the omitted activities in the submitted request call. This class contains the following properties.

You can use the SubmitDeleteActivities method to input a list of the unique sequential identifiers associated with activities that you want to delete. And then submit a request using the SubmitDeleteActivitiesRequest class for deleting several activities at once.

After successful completion of the request, the status of selected activities in the application shows as DEL, and after a moment the deleted activities are no longer available in the Activity Monitor user interface. 

CompanyLossSetManagement API

SubmitEpToUlf including SubmitEpToUlfRequest and SubmitEpToUlfResponse

AIR has implemented a new SubmitEpToUlf method in the existing Reinsurance Company Loss Set Management API enables you to convert the exceedance probability (EP) or return period (RP) summary loss curves to a user loss file (ULF) for importing into Touchstone Re for application of terms and then attach these in portfolio analysis. Additionally, you can save the user loss files in a currency of your choice. Providing you more flexibility for viewing loss results in both local and foreign currency.

The SubmitEpToUlfRequest class contains the following properties for configuring the input EP binary file.

The sub-class contains the following properties.

The SubmitEpToUlfResponse class returns the sequential identifier associated with the activity.

Use the SubmitEpToUlf method for converting Ep or Rp loss summary points in a CSV file to a binary user loss file (ULF) format. Then you can attach ULF to a reinsurance program for further analysis in Touchstone Re.

ReinsuranceAggregateLossAnalysis API

SubmitProgramAggregateLossAnalysis

AIR has introduced a Japan Earthquake Custom First Loss event set that supports setting different Commercial First Loss percentages by prefecture to run in a single analysis. Previously, the user had to create multiple programs to cover a single cedant and the process was time consuming. Now, users can configure the loss analysis to apply the first loss coverage percentages to each prefecture for a single program.

AIR has added a new JapanEQAreaEventSetRatio class in the ReinsuranceAggregateLossAnalysisData namespace.

AIR has added a new property in the existing ProgramAggregateLossAnalysisOptions class.                                      

ReinsuranceProgramManagment API

Program

AIR updates the Multi-Peril Crop Model for China. The model accounts for subtleties of geography, local soil conditions, crop type and growth stage, event duration and time of year.  

This update offers support for additional Line of Business, extended program coverage rates, and event filters. Additionally, exposure values for the MPCI areas in China can now be distributed down to subarea.

AIR has added the following new properties to the existing Program class.

ReinsuranceAggregateLossAnalysisData

SubmitPortfolioAggregateLossAnalysis

SubmitProgramAggregateLossAnalysis

AIR has implemented Multi-year Analysis for reinsurance and catastrophe bond contracts covering multiple years that provides access to cumulative loss distributions for the duration of these contracts.

AIR has added the following property in the AggregateLossAnalysisOptionsBase and ProgramAggregateLossAnalysisOptions classes.

SubmitPortfolioAggregateLossAnalysis

SubmitProgramAggregateLossAnalysis

                   

AIR has implemented the multiple results data sources for better organization and management of the analyses results data.

Now the AggregateLossAnalysisOptionsBase and ProgramAggregateLossAnalysisOptions classes include a new property to reference the result data source's sequential identifier.

You can use the existing SubmitCreateDatabase method in the Data Source Management API to create multiple result data sources. Then select a specific result data source defined in the program or portfolio loss analyses requests.

Changed Objects and Properties

AIR has not changed any properties for Touchstone Re 2021 (9.0).

Deprecated/Removed Objects, Enums, and Properties

AIR has not deprecated any objects, enumerations, or properties for Touchstone Re 9.0.

 What's New in the Touchstone Re8.0 APIs
The following sections describe the changes included in the Touchstone Re™ 8.0 APIs:
For a list of all the Touchstone Re functions available through the APIs, see Overview.

Highlights

In Touchstone Re 8.0, AIR has expanded the APIs to enable you to:

New Objects and Properties

AIR has added the following objects and properties for Touchstone Re 8.0.

Object or Property

Description

Reinsurance Aggregate Loss Analysis API (ReinsuranceAggregateLossAnalysisServiceClient)

AggregateLossAnalysisOptionsBase

This new class contains the base properties that enable you to specify how Touchstone Re runs an aggregate loss analysis on a portfolio of reinsurance treaties, or a set of reinsurance programs in a given company.

The class contains the following properties, which were previously associated with the PortfolioAggregateLossAnalysisOptions Class

Additionally, the class contains the following new property, which enables you to specify the events to include in the analysis using event identifiers or event years.

By specifying events, you can run the analysis on a subset of the events in a catalog.

SSEventFilter Property of the ProgramAggregateLossAnalysisOptions Class

This new property enables you to specify the events to include in the analysis using event identifiers or event years.

By specifying events, you can run the analysis on a subset of the events in a catalog.

SubmitMultiProgramAggregateLossAnalysis() 
(including SubmitMultiProgramAggregate
LossAnalysisRequest
 
and SubmitMultiProgramAggregate
LossAnalysisResponse

This new method submits a request to run an aggregate loss analysis against a set of reinsurance programs.

The programs must be in the same Touchstone Re company. 

SubmitMultiProgramAggregateLossAnalysis() Method Syntax
SubmitMultiProgramAggregateLossAnalysisResponse SubmitMultiProgramAggregateLossAnalysis
(SubmitMultiProgramAggregateLossAnalysisRequest request);
MultiProgramAggregateLossAnalysisOptions

This new class contains the options that enable you to configure how Touchstone Re runs an aggregate loss analysis against a set of reinsurance programs.

The class includes the following properties:

Reinsurance Data Import API (ReinsuranceDataImportServiceClient)

SubmitCopyCompany() (including SubmitCopyCompanyRequest and SubmitCopyCompanyResponse)

This new method submits a request to copy an existing Touchstone Re company.

You can optionally copy the exposure sets, company loss file sets, reinsurance programs, and user-defined categories associated with the company. 

You cannot copy the company loss associations associated with the company, which are losses from the Touchstone application that are stored on the AIRCompanyLoss database. 

SubmitCopyCompany() Method Syntax
SubmitCopyCompanyResponse SubmitCopyCompany
(SubmitCopyCompanyRequest request);
CopyCompanyOptions

This new class contains the options that enable you to configure how Touchstone Re copies a company.

The class includes the following properties:

Company Management API (CompanyManagementServiceClient)

CopyExposureSetYear() (including CopyExposureSetYearRequest and CopyExposureSetYearResponse)

This new method copies one year of existing exposure set data.

CopyExposureSetYear() Method Syntax
CopyExposureSetYearResponse CopyExposureSetYear
(CopyExposureSetYearRequest request);

The CopyExposureSetYearRequest method includes the following property:

The CopyExposureSetYearResponse method includes the following property:

Reinsurance Exposure Management API (ReinsuranceExposureManagementServiceClient)

CopyExposureSetYearApiOptions

This new class contains the options that enable you to configure how Touchstone Re copies one year of exposure set data.

The class includes the following properties:

Reinsurance Program Management API (ReinsuranceProgramManagementServiceClient)

CopyProgram() (including CopyProgramRequest and CopyProgramResponse)

This new method copies an existing Touchstone Re reinsurance program.

You can optionally copy the inuring (or child) programs associated with the program.

The CopyProgramRequest method contains the following property:

The CopyProgramResponse method contains the following property:

CopyProgram() Method Syntax
CopyProgramResponse CopyProgram
(CopyProgramRequest request);
CopyProgramApiOptions

This new class contains the options that enable you to configure how Touchstone Re copies a reinsurance program.

The class includes the following properties:

CopyMode This new enumeration provides a series of codes that specify the artifacts that Touchstone Re copies along with a reinsurance program.
GetExistingProgramRelationships() (including GetExistingProgramRelationshipsRequest and GetExistingProgramRelationshipsResponse)

This new method retrieves a list of the existing relationships associated with a given reinsurance program.

The GetExistingProgramRelationshipsRequest includes the following properties:

The GetExistingProgramRelationshipsResponse includes the following property:

GetExistingProgramRelationships() Method Syntax
GetExistingProgramRelationshipsResponse GetExistingProgramRelationships
(GetExistingProgramRelationshipsRequest request);
GetAvailableProgramsToCreateProgramRelationships() (including GetAvailableProgramsToCreateProgramRelationshipsRequest and GetAvailableProgramsToCreateProgramRelationshipsResponse)

This new method retrieves a list of the valid potential sourcing or inuring reinsurance programs for a given reinsurance program.

The GetAvailableProgramsToCreateProgramRelationshipsRequest includes the following property:

The GetAvailableProgramsToCreateProgramRelationshipsResponse includes the following property:

GetAvailableProgramsToCreateRelationships() Method Syntax
GetAvailableProgramsToCreateRelationshipsResponse GetAvailableProgramsToCreateRelationships
(GetAvailableProgramsToCreateRelationshipsRequest request);
CreateProgramRelationships() (including CreateProgramRelationshipsRequest and CreateProgramRelationshipsResponse)

This new method creates one or more relationships for a given reinsurance program.

A relationship defines the association between two reinsurance programs. Specifically, the relationship specifies which program inures to the benefit of the other program, the financial perspective of the association, and the relevant participation level. One reinsurance program may have many relationships.

The CreateProgramRelationshipsRequest includes the following properties:

The CreateProgramRelationshipsResponse includes the following property:

CreateProgramRelationships() Method Syntax
CreateProgramRelationshipsResponse CreateProgramRelationships
(CreateProgramRelationshipsRequest request);
UpdateProgramRelationships() (including UpdateProgramRelationshipsRequest and UpdateProgramRelationshipsResponse)

This new method updates one or more relationships for a given reinsurance program.

UpdateProgramRelationships() Method Syntax
UpdateProgramRelationshipsResponse UpdateProgramRelationships
(UpdateProgramRelationshipsRequest request);
DeleteProgramRelationships() (including DeleteProgramRelationshipsRequest and DeleteProgramRelationshipsResponse)

This new method deletes one or more relationships associated with a given reinsurance program.

DeleteProgramRelationships() Method Syntax
DeleteProgramRelationshipsResponse DeleteProgramRelationships
(DeleteProgramRelationshipsRequest request);
ProgramRelationship

This new class contains information about the sourcing or inuring relationship between two reinsurance programs.

The class includes the following properties:

ProgramParticipation This new enumeration provides a series of codes that specify the participation levels supported by Touchstone Re for reinsurance program relationships.
ProgramRelationPerspectives This new enumeration provides a series of codes that specify the financial perspectives supported by Touchstone Re for reinsurance program relationships.
CreateProgram() (including CreateProgramRequest)

This existing class includes two new properties at Layer-level that enables you to assign reinstatement premiums for reinsurance programs and account for the offset of reinsurance losses by premiums.

UpdateProgram() (including UpdateProgramRequest)

This existing class includes two new properties at Layer-level that enables you to assign reinstatement premiums for reinsurance programs and account for the offset of reinsurance losses by premiums.

ReinstatementPremium Class

This new class includes provision and initial premium for each reinsurance programs.

Data Export API (DataExportManagementServiceClient)

ReinsuranceFinancialPerspective

 

This new enumeration provides a financial loss perspective to export all DLFs by final net loss, which is contract loss minus applicable reinstatement premiums. The AIRExportExpress UI in Touchstone Re shows the following loss perspective:

  • Final Net Loss

The following class requests includes the new enumeration:

Reinsurance Company Loss Set Management API (Reinsurance CompanyLossSetManagementServiceClient)

GetAllCompanyLossSets() (including GetAllCompanyLossSetsRequest and GetAllCompanyLossSetsResponse) This new class contains a set of properties that enables you to identify and manage Touchstone Re loss files sets.

The GetAllCompanyLossSetsRequest() class includes the following properties:

The GetAllCompanyLossSetsResponse() class included the following property:

GetAllCompanyLossSets() Method Syntax
GetAllCompanyLossSetsResponse GetAllCompanyLossSets
 (GetAllCompanyLossSetsRequest request);
CompanyLossSet This new class contains information about a company associated with company loss files (CLF) or company loss association (CLA) sets. 

This class includes the following properties:

LossSetProgram This new class contains information about a program associated with a company in a given company loss files set or company loss association.

This class includes the following properties:

SubmitConvertCsvToUlf() (including SubmitConvertCsvToUlfRequest and SubmitConvertCsvToUlfResponse) This new class contains properties of comma-separated-values (CSV) loss files that you want to convert to binary universal list format (ULF) file.  

The SubmitConvertCsvToUlfRequest class includes the following properties:

The SubmitConvertCsvToUlfResponse class includes the following property:

SubmitConvertCsvtoUlf() Method Syntax
SubmitConvertCsvToUlfResponse SubmitConvertCsvToUlf
(SubmitConvertCsvToUlfRequest request);

Reinsurance Portfolio Management API (ReinsurancePortfolioManagementServiceClient)

CopyPortfolio() (including CopyPortfolioRequest and CopyPortfolioResponse) This new class contains the existing portfolio information in Touchstone Re that you can copy and create as a new portfolio.

The CopyPortfolioRequest() class includes the following properties:

The CopyPortfolioResponse() class includes the following property:

CopyPortfolio() Method Syntax
CopyPortfolioResponse CopyPortfolio
 (CopyPortfolioRequest request);
Portfolio

The Portfolio() class contains information about the static and dynamic portfolios that exist in Touchstone Re.

This class includes the following properties:

Changed Objects and Properties

AIR has changed the following properties for Touchstone Re 8.0.

Object or Property

Description

Reinsurance Aggregate Loss Analysis API (ReinsuranceAggregateLossAnalysisServiceClient)

PortfolioAggregateLossAnalysisOptions Class

AIR has removed all the properties in PortfolioAggregateLossAnalysisOptions class, but inherited properties of this class in AggregateLossAnalysisOptionsBase class.

You now define the properties in the AggregateLossAnalysisOptionsBase Class.

Deprecated/Removed Objects, Enums, and Properties

AIR has not deprecated any objects, enumerations, or properties for Touchstone Re 8.0.