Renewal web services

Renewal jobs have the following web service APIs.

Name

Description

PolicyRenewalAPI

The policy renewal web service provides methods for managing renewals in PolicyCenter.

The policy renewal web service provides methods to:

  • Start renewals on policies that exist in PolicyCenter. There is no gap in coverage between the renewal and its based-on policy period.
  • Import a policy from a legacy system and renew the policy. There is no gap in coverage between the renewal and its based-on policy period.
  • Process a renewal in a billing system

For more information see Policy renewal web services.

JobAPI

The job web service primarily adds an activity to a job by using an activity pattern. This web service also has methods to find and withdraw jobs.

The job ID of the activity is set to the given job ID. The previous UserID of the activity is set to the current user. The Assignment Engine assigns the newly created activity to the specified group and user. Finally, the activity is saved to the database, and the public ID of the newly created activity is returned.

For more information, see Job web services.

PolicyPeriodAPI

The policy period web service provides methods for performing various operations on policy periods within PolicyCenter. It allows you to do the following:

  • Add a note to the policy and policy period
  • Add a document to the policy period
  • Add a referral reason code to the policy period

For more information, see Policy period web services.

WorkflowAPI

The workflow web service provides methods for performing various operations on workflows within PolicyCenter. This web service can:

  • Invoke a trigger that starts an action to advance the workflow to the next step.
  • Resume a workflow or all workflows. The workflow engine can attempt to advance the workflow (or all workflows) to the next step. If there is an error, then the API logs it.
  • Suspend a workflow.

For more information, see Workflow web service.