Skip to content

CCM-22090: Recipient response message retrieval API - #1090

Open
rhyscoxnhs wants to merge 23 commits into
releasefrom
feature/CCM-22090
Open

CCM-22090: Recipient response message retrieval API#1090
rhyscoxnhs wants to merge 23 commits into
releasefrom
feature/CCM-22090

Conversation

@rhyscoxnhs

@rhyscoxnhs rhyscoxnhs commented Aug 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Summary

Adds proxy configuration for new recipient response message retrieval API.

Reviews Required

  • Dev
  • Test
  • Tech Author
  • Product Owner

Checklist

  • Brief description of work completed, and any technical decisions made as part of the PR
  • PR link added as a comment to the relevant JIRA ticket
  • PR link shared on Slack and/or Teams
  • 2 reviews received
  • Tester approval

@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-22090

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-22090

@github-actions

github-actions Bot commented Aug 10, 2026

Copy link
Copy Markdown

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-22090

cgitim
cgitim previously requested changes Aug 10, 2026
View reviewed changes
Comment thread proxies/shared/policies/ExtractVariables.MessageResponses.Get.Request.xml Outdated
Comment thread proxies/shared/policies/AssignMessage.MessageResponses.Get.Request.xml Outdated
Comment thread sandbox/handlers/message_responses.js Outdated
Comment thread specification/documentation/APIDescription.md Outdated
Comment thread specification/documentation/GetResponses.md Outdated
Comment thread specification/schemas/components/ResponseItem.yaml Outdated
Comment thread specification/responses/2xx/200_Responses.yaml Outdated
Comment thread specification/communications-manager.yaml Outdated
Comment thread sandbox/handlers/message_responses.js Outdated
Comment thread specification/schemas/responses/GetResponsesSuccess.yaml Outdated
@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-22090

@rhyscoxnhs
rhyscoxnhs requested a review from cgitim August 12, 2026 10:44
mjewildnhs
mjewildnhs reviewed Aug 13, 2026
View reviewed changes
Comment thread specification/documentation/GetMessageResponses.md
Comment thread specification/documentation/GetMessageResponses.md Outdated
Comment thread specification/responses/4xx/message_responses/422_TooManyResponses.yaml Outdated
Comment thread specification/endpoints/get_responses.yaml Outdated
mjewildnhs
mjewildnhs reviewed Aug 13, 2026
View reviewed changes
Comment thread specification/responses/4xx/message_responses/400_UnableToGetResponses.yaml Outdated
Comment thread specification/schemas/enums/ErrorTooManyResponses.yaml Outdated
Comment thread sandbox/handlers/message_responses.js
Comment thread specification/documentation/APIDescription.md Outdated
Comment thread tests/sandbox/message_responses/test_success.py Outdated
@github-actions

github-actions Bot commented Aug 14, 2026

Copy link
Copy Markdown

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-22090

@rhyscoxnhs
rhyscoxnhs requested a review from mjewildnhs August 14, 2026 13:37
mjewildnhs
mjewildnhs reviewed Aug 14, 2026
View reviewed changes

@mjewildnhs mjewildnhs left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've paused reviewing until we get an answer on whether we should be following the JSON:API convention as per my review comment.

Comment thread specification/endpoints/get_responses.yaml
@mark-r-bjss

mark-r-bjss commented Aug 17, 2026

Copy link
Copy Markdown
Collaborator

After a team discussion we decided that

  1. It would be best to align the response more closely with existing API responses by adding in a data object wrapper and listing the items within.
  2. To stick with a 500 response if there are too many responses found for the messageId as this is an unexpected real-world scenario.
  3. To extract the repeated fields messageId and messageReference into the new data wrapper.
  4. To sort the patient-responses so that the API produces consistent responses for the same query as this would make testing easier.

@rhyscoxnhs

rhyscoxnhs commented Aug 17, 2026

Copy link
Copy Markdown
Collaborator Author

One revision to the above - since JSON API mandates specific fields for the data wrapper, we can't extract messageId and messageReference out of the attributes object, the only valid fields in the data wrapper are id, attributes, links, relationships and type.

@github-actions

github-actions Bot commented Aug 20, 2026

Copy link
Copy Markdown

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-22090

@rhyscoxnhs

rhyscoxnhs commented Aug 20, 2026

Copy link
Copy Markdown
Collaborator Author

Migrated to JSON:API

mjewildnhs
mjewildnhs reviewed Aug 21, 2026
View reviewed changes

@mjewildnhs mjewildnhs left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not finished yet but posting feedback I have.

Comment thread specification/documentation/GetMessageResponses.md Outdated
Comment thread specification/responses/4xx/415_UnsupportedMedia.yaml
Comment thread specification/endpoints/get_responses.yaml
Comment thread sandbox/handlers/message_responses.js Outdated
Comment thread sandbox/handlers/message_responses.js Outdated
Comment thread sandbox/handlers/message_responses.js
Comment thread sandbox/handlers/message_responses.js Outdated
@github-actions

github-actions Bot commented Aug 24, 2026

Copy link
Copy Markdown

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-22090

@rhyscoxnhs
rhyscoxnhs dismissed cgitim’s stale review August 24, 2026 07:26

Requested changes have been addressed

mjewildnhs
mjewildnhs reviewed Aug 24, 2026
View reviewed changes
Comment thread sandbox/handlers/message_responses.js
Comment thread specification/responses/4xx/415_UnsupportedMedia.yaml
Comment thread tests/api/message_responses/test_200_success.py
@github-actions

github-actions Bot commented Aug 24, 2026

Copy link
Copy Markdown

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-22090

mark-r-bjss
mark-r-bjss approved these changes Aug 26, 2026
View reviewed changes

@mark-r-bjss mark-r-bjss left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved, in that I can't see any issues but it's very hard to follow what's going on with these XML files and we will be relying heavily on the testing to find any issues. Also worth ensuring that somebody with experience in this area reviews this.

@github-actions

github-actions Bot commented Sep 3, 2026

Copy link
Copy Markdown

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-22090

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-22090

@github-actions

github-actions Bot commented Sep 15, 2026

Copy link
Copy Markdown

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-22090

@github-actions

github-actions Bot commented Sep 15, 2026

Copy link
Copy Markdown

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-22090

@github-actions

github-actions Bot commented Sep 15, 2026

Copy link
Copy Markdown

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-22090

@github-actions

github-actions Bot commented Sep 15, 2026

Copy link
Copy Markdown

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-22090

rhyscoxnhs
rhyscoxnhs commented Sep 15, 2026
View reviewed changes
Comment thread sandbox/app.js
Ian-Hodges
Ian-Hodges reviewed Sep 15, 2026
View reviewed changes
Comment thread tests/api/message_responses/test_404.py
Ian-Hodges
Ian-Hodges reviewed Sep 16, 2026
View reviewed changes
Comment thread proxies/shared/policies/AssignMessage.MessageResponses.Get.Request.xml Outdated
@github-actions

github-actions Bot commented Sep 16, 2026

Copy link
Copy Markdown

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-22090

mjewildnhs
mjewildnhs reviewed Sep 16, 2026
View reviewed changes
Comment thread proxies/shared/policies/AssignMessage.MessageResponses.Get.Request.xml Outdated
cgitim
cgitim previously requested changes Sep 16, 2026
View reviewed changes
Comment thread proxies/shared/policies/AssignMessage.MessageResponses.Get.Request.xml Outdated
Comment thread tests/api/message_responses/test_400.py
Comment thread proxies/shared/resources/jsc/helpers/validationChecks.js Outdated
@github-actions

github-actions Bot commented Sep 18, 2026

Copy link
Copy Markdown

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-22090

@rhyscoxnhs
rhyscoxnhs dismissed cgitim’s stale review September 18, 2026 10:14

Feedback addressed

@github-actions

github-actions Bot commented Sep 18, 2026

Copy link
Copy Markdown

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

CCM-22090

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Ian-Hodges Ian-Hodges Ian-Hodges approved these changes
@mark-r-bjss mark-r-bjss mark-r-bjss approved these changes
@cgitim cgitim cgitim left review comments
@mjewildnhs mjewildnhs Awaiting requested review from mjewildnhs

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@rhyscoxnhs @mark-r-bjss @mjewildnhs @Ian-Hodges @cgitim