Reinstatement integration

Reinstatement web services

The ReinstatementAPI is a web service to start a reinstatement from an external system.

The ReinstatementAPI.beginReinstatement function can be invoked to begin a reinstatement job. It does not attempt to automatically push the reinstatement job through to completion. The policyNumber and reinstateCode arguments identify which policy is to be reinstated and the reason for the reinstatement. The function throws an exception if the reinstatement cannot be started for any reason.

See also

Reinstatement plugins

The following plugins may be useful to integrate with reinstatement.

Name

Description

IBillingPlugin

If you need to integrate with an external billing system, use this plugin to notify an external billing system about billing events.

MessageTransport

Use this plugin to send a message to an external/remote system by using any transport protocol.

IEffectiveTimePlugin

Determines the time of day (since midnight) for a job. Use to calculate the effective time.

IJobNumberGenPlugin

Generates a new, unique job number. Use to generate reinstatement job numbers.

IPolicyPlugin

Lets PolicyCenter know whether to start various jobs, based on dynamic calculations on the policy. Use to determine when a reinstatement job can be started.

See also

Reinstatement events

PolicyCenter generates events for changes that might be of interest to an external system. You can also programmatically generate an event. For example, in the ReinstatementProcess.gs class, the function startReinstate generates an IssueReinstatement event.

The Reinstatement entity has the following events:

  • ReinstatementAdded
  • ReinstatementChanged
  • ReinstatementRemoved

The PolicyPeriod entity has the following events pertaining to reinstatement:

  • IssueReinstatement – a message that notifies an external system to issue a reinstatement for a particular policy period.

See also