department-of-veterans-affairs / va.gov-team

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
284 stars 206 forks source link

NoK/EC: Add VA Profile Health Benefits update functionality to vets-api #91293

Open wesrowe opened 3 months ago

wesrowe commented 3 months ago

Description

User story

As a Cartography team member, I want to add the vets-api code that can make API calls to the Health Benefits endpoint(s) of VA Profile so that we can request updates to associated persons like Next of Kin and Emergency Contacts.

Notes

Example success response:

{
  "messages": [
    {
      "code": "HB204",
      "key": "_VHA_ES_UPDATE_SERVICE_INFO",
      "text": "VHA ES Update Service returned message: mdm.cuf.core.messages.Message@70365e72[code=200,key=sucessfully received,text=<null>,severity=<null>,potentiallySelfCorrectingOnRetry=<null>]",
      "severity": "INFO",
      "potentiallySelfCorrectingOnRetry": false
    }
  ]
}

Possible tasks:

Acceptance criteria

dcloud commented 2 months ago

We'll also need a ticket or two for handling the transaction-status aspect because VA Profile typically has a separate endpoint for checking that a requested change succeeded