As a user of the History API I want to use RS's documentation to know how to format my request URL to hit the endpoint
Description/Use Case
NIH is building a wrapper for OTC senders to connect and send to Reportstream. However, when finalizing the wrapper they found that the way they have to format their url request for the wrapper to work doesn't match ReportStream's documentation thus we need to update our documentation to be accurate and up to date. Here is NIH's email on the matter:
"_we noticed, when referencing back to the ReportStream docs, there's a discrepancy.
User Story
As a user of the History API I want to use RS's documentation to know how to format my request URL to hit the endpoint
Description/Use Case
NIH is building a wrapper for OTC senders to connect and send to Reportstream. However, when finalizing the wrapper they found that the way they have to format their url request for the wrapper to work doesn't match ReportStream's documentation thus we need to update our documentation to be accurate and up to date. Here is NIH's email on the matter:
"_we noticed, when referencing back to the ReportStream docs, there's a discrepancy.
As you suggested, we are coded to pull status from /api/waters/report/${id}/history, but the documentation at https://reportstream.cdc.gov/developer-resources/api/documentation/responses-from-reportstream states status is pulled from /api/history/simplereport/submissions/${id}. "
Risks/Impacts/Considerations
None
Dev Notes
None
Acceptance Criteria