Re-Send Notification

Overview

This operation allows the users to manually resend the enrollment event notification in case the notification failed for any technical reasons.

  • Process Type: Asynchronous

  • Operation type: PUT

For the process and more properties please see section:

  • "Outbound RESTful Service Invocations" in Security Guide (and)

  • The chapter "Long Running Operations through REST" in the Developer Guide describes the common notification structure of the notification message.

End Points

It is possible to trigger resend for the notifications in failed status:

  • To resend a single enrollment event notification

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

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

  • To resend a multiple enrollment event notifications

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

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

    • Payload

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

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

    • If the flag "sendAllFailedNotifications" is set to 'true' then it is not required to list the 'enrollmentEventNotification' ids, System sends 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 resend:

{
  ... 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}/resend",
      "rel": "enrollmenteventnotification:resend"
      "httpMethod": "PUT"
    }
  ]
}

Outcome

A successful resend action:

  • Will send the notification with the notification payload to endpoint as configured in End-point configuration.

  • Returns a success status, example 200 Ok.

In case the resend operation is not successful again due to any technical errors, then:

  • The notification remains in the 'failed' status.

  • The user can also try to resend the notification by doing a put operation on the end-point mentioned above

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

Response Messages

The Oracle Health Insurance application creates the response messages. 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 Resend 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 Resend Notification IP.