Purge Policy

This operation permanently removes a single policy and all of its details from the system. These details include mutations, calculation results and financial transactions. It will not create reversal transactions, and it will not delete or correct financial messages in which transactions of the deleted policies are included.

The purpose of this operation is to facilitate re-using test data in non-production environments, especially in scenarios where the system restricts the removal of certain configuration settings after they have been applied in a calculation.

Do not use this resource in production, as it may cause having financial messages in the system without the originating policies and policy changes.

The resource supports the deletion of the enrollment of a person on that policy but it does not remove the person itself. The same applies for the policyholder: the operation will remove the fact that a certain person is (or was) the policyholder of a policy but it will not remove that person.

Request Purge

To purge a policy and its details, send the following POST request:

http://[hostName]:[portNumber]/[api-context-root]}/purge/policies

Example

To request a POST operation with {id}

http://[hostName]:[portNumber]/[api-context-root]/purge/policies/id/{id}

If the request specifies an {id}, the operation purges all versions of the policy if any version has that {id}.

To request a POST operation with {code}

http://[hostName]:[portNumber]/[api-context-root]/purge/policies/code/{code}

If the request specifies a {code}, the operation purges all versions of the policy only if the policy’s latest version has that {code}.

The request payload does not support the specification of any settings.

When a purge is selected only by its retention period, specify at least one selection parameter to optimize performance. For example, you can purge multiple group clients for single line of business in one request. To purge individual policies, use the unspecified value for the group account parameter.

Purge

What the system deletes

• All financial information for every version of the policy.

• All calculation results for every version of the policy.

• All policy account information for every version of the policy.

• All policy data as specified by the policy’s cascading delete rules.

• All dynamic fields, dynamic records, and multilingual information on deleted items.

• All policy update requests that share the same GID as the policy.

• All enrollment event notifications that share the same GID as the policy.

• Working-copy person record.

If you purge an unapproved policy, the linked working-copy person record is deleted. Active person records are not deleted.

What the system does not delete

• Financial Transaction Sets.

• Financial Messages.

• Payment Registrations.

• Group Accounts (the policy is removed from the group account, but the group account remains).

• Persons (active) or organizations (the person or organization records remain).

The purge is atomic per policy: it completes fully or not at all.

Response Messages

This operation returns HTTP status codes as defined in Response Messages. If an error occurs, the service returns the appropriate HTTP status code and sends a notification with error details.

No operation-specific error codes are defined.

Authorization

A user authorization configuration requires access to this operation. The relevant access restriction is purge.policies IP.

If access to a policy is limited by a data access group restriction, you must also have a grant for that data access group with the Delete flag enabled to purge that policy.