Cancel Notification

Overview

This operation allows the users to manually cancel the enrollment event notification before sending.

  • Process Type: Synchronous

  • Operation type: PUT

Endpoints

  • To cancel a single enrollment event notification

    • The below end-point triggers cancel only for the mentioned notification id

       http://[hostName]:[portNumber]/[api-context-root]/enrollmenteventnotifications/{id}/cancel

  • To cancel multiple enrollment event notifications

    • The below end-point triggers send for multiple notification ids as mentioned in the example payload below

       http://[hostName]:[portNumber]/[api-context-root]/enrollmenteventnotifications/cancel

    • Payload

      {
  "cancelAllFailedNotifications": false,
  "enrollmentEventNotificationList": [
      {"notificationId": ""},
      {"notificationId": ""}
      ..
  ]
}

    • The flag "cancelAllFailedNotifications" is set to 'false' by default.

    • If the flag "cancelAllFailedNotifications" is set to 'true' then it is not required to list the 'enrollmentEventNotification' ids.
      The application cancels all the notifications in the failed status.

Availability

This operation is only available:

  • Non-Obsolete Enrollment event notification with the status 'Failed'.

Resource Representation

Resource representation of an enrollment event notification that can be cancelled:

{
  ... enrollment event notification properties ...
  "links": [
    {
      "href": "http://[hostName]:[portNumber]/[api-context-root]/generic/enrollmenteventnotifications/{id}",
      "rel": "self"
    },
    {
      "href": "http://[hostName]:[portNumber]/[api-context-root]/enrollmenteventnotifications/{id}/cancel",
      "rel": "enrollmenteventnotification:cancel"
      "httpMethod": "PUT"
    }
  ]
}

Outcome

A successful cancel action will:

  • All the notifications are stopped from further processing.

  • Returns success status, example 200 Ok

  • Set the status of the notification to 'Cancelled'.

Refer Enrollment Event Notifications for more information on processing of notifications.

Response Messages

The Oracle Health Insurance application creates the response messages in response to request messages it receives from external interfaces. For more details, please see the "Response Messages" in the HTTP API/IP Concepts, a part of the Developer Guide.

Error Processing

The following are the error messages that are specific to Cancel integration point which may return as the response message:

Table 1. Error Processing
Code Severity Message

POL-IP-ENEN-001

Fatal

Notification ID {ID} is unknown

POL-IP-ENEN-002

Fatal

Only non-obsolete notifications in status 'Failed' can be cancelled or resent.

Authorization

This integration point requires grant access to Cancel Notification IP.