Edit Policy

This operation makes it possible to bring the policy back to edit status. Bringing a policy back to edit results in either creation of a new version or change in status depending on the current status of the policy. This operation is only available for the latest version of the policy in the following statuses:

  • Approved

  • Canceled

  • Pended

Whether a policy can be brought back to edit status, can be derived by the presence or absence of the "toedit" link.

Resource representation of a policy that can be brought back to edit status:

{
  ... policy properties ...
  "links": [
    {
      "href": "http://<host>:<port>/[api-context-root]/generic/policies/<id>",
      "rel": "self"
    },
    {
      "href": "http://<host>:<port>/[api-context-root]/policies/<id>/toedit",
      "rel": "policy:toedit"
      "httpMethod": "POST"

    }
  ]
}

In the resource representation of a policy that can’t be changed back to edit status, for example, if the policy is already in edit status:

{
  ... policy properties ...
  "links": [
    {
    "href": "http://<host>:<port>/[api-context-root]/generic/policies/",
    "rel": "self"
    },
  ]
}

Edit Operation

For Policies in Approved or Canceled Status

  • For the current version of the policy, sets the indicator Last Version of the policy to false

  • Creates a new version of the policy (copy of the current version including its dynamic fields and dynamic records) and copies the following underlying children (including their dynamic fields and dynamic records):

    • Policyholders

    • Policy Contract Periods

    • Policy Collection Settings

    • Policy Premium Bill Allocations

    • Policy Bill Receivers

    • Policy Brokers Agents

    • Policy Group Accounts

    • Policy Enrollments

    • Policy Enrollment Insurable Classes

    • Policy Enrollment Products

    • Policy Add-ons

    • Parameter Values

  • Creates a policy status history for status Edit for the newly created policy version

  • Sets the indicator Last Version of the policy to true for the newly created policy

Change event rules are not executed when the new version of policy is created

For Policies in Pended Status

  • Creates a policy status history for status Edit

  • Creates Policy Pend History records for status Edit for all pend reasons that are attached to the policy

    • The Resolved By and Resolved Date Time attributes of the Policy Pend History records of the most recent Policy Status History for status Pended are not set (because they are not yet resolved)

  • Pend reasons that are attached to the policy will remain on the policy (unresolved)

  • The system checks the Pend Resolution rights on the process step in which the policy is pended

  • If Pend Resolution Access Restriction is specified on the process step in which the policy is pended

    • Perform the operation only if the users has the Access Restriction Grant (with Update rights) for the Pend Resolution Access Restriction that is specified on the process step in which the policy is pended

    • The process step in which the policy is pended is the earliest (with the lowest sequence number) process step that is referenced by one or more policy pend reasons

  • In case if the user does not have access to resolve pends for the step in which the policy has pended; the system returns '403 Forbidden' along with the message 'POL-IP-POLI-027' in error details.

  • For details on Pend resolution refer to section "Evaluate Pend Rules" of the Process Policy page in the Operations Guide.

Response Messages

This operation will provide HTTP status codes as defined in Response Messages.

Success

HTTP Status 200 after the operation is completed successfully, request is redirected to policies API and a resource representation of the new or updated policy version (now latest) is returned.

Failure

If an error occurs, the appropriate HTTP status code is returned and a notification is sent containing error details. This way, the operation can be executed again after the reason for failure has been fixed.

The following operation specific error can occur:

Code

Severity

Message Text

POL-HTTP-014

Fatal

To change the policy status back to edit, the policy must be in status Approved, Canceled or Pended and is the latest version.

POL-IP-POLI-027

Fatal

Unresolved pend reasons exist and you don’t have the privileges to resolve them.

Authorization

  • The above described operation is protected by access restriction "policies.toedit IP"

  • Read grant must also be given to the access restriction "policies API"

  • If the access to a policy is restricted by a data access group restriction, then to perform this operation on that policy also a grant for that data access group restriction must be provided with the Create and Update flag set