CCM-10077 Relax api contact details validation#940
Merged
Conversation
CCM-9675: Release v4.40.0
CCM-10014 - Release v4.42.0 merge to master
|
This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket: CCM-10077 |
5e70e12 to
fe85ade
Compare
simonlabarere
approved these changes
May 28, 2025
masl2
approved these changes
May 29, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Currently the NHS Notify batch send API performs up-front validation of fields in the request payload. Any validation errors cause the entire message request (for the send single message API) or the entire batch (for the send batch API and MESH) to be rejected. The original intention was to fail the request quickly for "client issues" that are within the control of the integrator. However, an unintended consequence of this is that message requests that have a validation error pertaining to a single channel (e.g. a malformed postcode override) would be rejected but may have succeeded via a different channel in the routing plan had the request been accepted. Furthermore, for batch requests a single validation error causes the entire batch to be rejected. Finally, the existing behaviour where an invalid overridden contact detail causes the message request to be rejected differs from the behaviour when contact details are retrieved from PDS as in this case validation occurs during enrichment, after the request has already been accepted.
Test Evidence
Test evidence added to CCM-10077
Reviews Required
Checklist