Methods of the PolicyCenter reinsurance coverage web service

The RICoverageAPI web service provides two methods so that external systems can find reinsurable risks in PolicyCenter.

findRIPolicyRisk – Finds reinsurable risks of the specified reinsurance coverage group type that are attached to the policy on a particular date.
findRIRiskByCoverableID – Same as above, but finds reinsurable risks only on the specified coverable in the policy.

Finding reinsurable risks by policy

The findRIPolicyRisk method finds reinsurable risks of the specified reinsurance coverage group type that are attached to the policy on a particular date. A reinsurable risk exists on a policy. For example, the property coverages at a particular location constitute a reinsurable risk.

function findRIPolicyRisk(policyNumber : String, coverageCode : String, date : Date) : RIRiskInfo

The parameters are described in the following table.

Parameter	Description
`policyNumber`	A policy number of the policy to find risks in.
`coverageCode`	A code for the coverage pattern of a reinsurance coverage group type. The method finds risks of this reinsurance coverage group type.
`date`	A date on which to find these risks on the policy.

The following illustration shows some of the objects accessed by this method.

Objects accessed when finding reinsurance risks on a policy: PolicyPeriod, Coverable, Coverage, and Reinsurable.

The method returns risk information in an RIRiskInfo instance.

Finding reinsurable risks by coverable on policy

The findRIPolicyRiskByCoverableID method finds reinsurable risks of the specified reinsurance coverage group type that are attached to a specified coverable on the policy on a particular date.

function findRIRiskByCoverableID(policyNumber : String, coverableID : String,
        coverageCode : String, date : Date) : RIRiskInfo

The parameters are described in the following table.

Parameter	Description
`policyNumber`	A policy number of the policy to find risks in.
`coverableID`	A public ID of the coverable in the policy to find risks on.
`coverageCode`	A code for the coverage pattern of a reinsurance coverage group type. The method finds risks of this reinsurance coverage group type.
`date`	A date on which to find these risks on the policy.

The following illustration shows some of the objects accessed by this method.

Objects access when finding reinsurance risks by coverable on a policy: PolicyPeriod, Reinsurable, PolicyRisk.

The method returns risk information in an RIRiskInfo instance.

Reinsurance risk information

Both the findRIPolicyRisk and findRIPolicyRiskByCoverableID methods of the RICoverageAPI web service return risk information in an RIRiskInfo data transfer object. In the base configuration, these methods obtain the RIRiskInfo by calling the findReinsuranceRiskInfo method on the IReinsurancePlugin plugin.

The following illustration shows some of the objects associated with the RIRiskInfo object.

Objects associated with RIRiskInfo: Reinsurable, RIRisk, and RIAgreement.

RIRiskInfo object fields

The RIRiskInfo object has the following fields.

Field	Description
`Agreements`	An array of reinsurance agreement `RIAgreementInfo` objects, as described below.
`Description`	A description such as “Property coverage for Location 1” or “Auto liability coverage for Personal Auto line.” The pattern for the description is shown below. `CoveragePattern.Name coverage for Reinsurable.DisplayName`
`RIRiskID`	The `PublicID` of the `RIRisk` attached to the `Reinsurable`.

Field

Description

Agreements

An array of reinsurance agreement RIAgreementInfo objects, as described below.

Description

A description such as “Property coverage for Location 1” or “Auto liability coverage for Personal Auto line.” The pattern for the description is shown below.

CoveragePattern.Name coverage for Reinsurable.DisplayName

RIRiskID

The PublicID of the RIRisk attached to the Reinsurable.

RIAgreementInfo object fields

The RIRiskInfo object contains information about the reinsurance agreements. The object contains no agreement that is specifically excluded nor any proportional agreement with a 0% share. The object includes all non-proportional agreements. This object does not contain agreements in draft status.

The RIRiskInfo object contains the following information for each RIAgreement as an RIAgreementInfo data transfer object.

Field	Description
`AgreementNumber`	The `AgreementNumber` of the agreement.
`AttachmentPoint`	For non-proportional agreements only, the `AttachmentPoint` of the agreement.
`AttachmentPointIndexed`	For non-proportional agreements only, the `AttachmentIndexed` property of the agreement.
`CededShare`	The `CededShare` percentage of the agreement.
`Comments`	The `Comments` of the agreement.
`Currency`	The `Currency` of the agreement.
`Draft`	For treaties, `true` if the reinsurance program that contains the agreement is not yet active. For facultative agreements, `true` if the facultative agreement is not yet active.
`EffectiveDate`	The effective date of the agreement.
`ExpirationDate`	The expiration date of the agreement.
`Name`	The `Name` of the agreement.
`NotificationThreshold`	For per risk agreements only, the `NotificationThreshold`.
`ProportionalPercentage`	For proportional agreements, the proportional percentage of the risk that the attachment takes. In PolicyCenter, this value is the Prop % column for an agreement.
`RecoveryLimit`	For proportional agreements, the `CededRisk` of the attachment. For non-proportional agreements, the amount of reinsurance specified by the agreement as a calculated percentage.
`TopOfLayer`	For non-proportional agreements only, the `CoverageLimit`.
`TopOfLayerIndexed`	For non-proportional agreements only, the `LimitIndexed` property of the agreement.
`Type`	The `Subtype` of the agreement, such as quota share or surplus.