Archiving web services

To check whether a policy term is archived, call the ArchiveAPI method isArchived. It takes a String policy number and an effective date. The method first determines which policy term is effective at the given date. The method returns true if the term is archived, otherwise false.

A term is considered archived if one or more of its policy periods is archived, even if not all are archived.

To request PolicyCenter restore a policy term, call the ArchiveAPI method requestRestore. The restore does not happen synchronously. In other words, the caller cannot assume the restore is complete when the API returns control to the caller. Instead, PolicyCenter simply adds this policy term to the set of policy terms to restore. Eventually, a batch process restores the policy term.

The requestRestore method accepts a String policy number and an effective date. The method first determines which policy term is effective at the given date. Next, it marks that policy term as a term to restore.

PolicyCenter includes a feature to mark a policy as ineligible for additional archiving. This feature sometimes is known as suspending archiving. There are three methods on the ArchiveAPI web service that relate to the suspension of archiving. All three methods take a single argument, which is the policy number of the policy in question. The methods implement the following operations.

• Suspend archiving – From an external system, call the ArchiveAPI method setDoNotArchive.
• Resume archiving – From an external system, call the ArchiveAPI method unsetDoNotArchive. If there are terms that are already archived, resuming archiving does not restore any already-archived terms.
• Check a policy for suspended from archiving – From an external system, call the ArchiveAPI method isDoNotArchive. The method returns true if the policy is currently suspended from archiving, false otherwise. The return result does not indicate whether the policy has any archived terms, only whether the policy is currently suspended from consideration of archiving.