Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update History API Endpoint Documentation #16623

Open
brandonnava opened this issue Nov 21, 2024 · 0 comments
Open

Update History API Endpoint Documentation #16623

brandonnava opened this issue Nov 21, 2024 · 0 comments
Labels
platform Platform Team

Comments

@brandonnava
Copy link
Collaborator

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/simple_report/submissions/${id}._ "

Risks/Impacts/Considerations

None

Dev Notes

None

Acceptance Criteria

  • Documentation is updated
@brandonnava brandonnava added the platform Platform Team label Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
platform Platform Team
Projects
None yet
Development

No branches or pull requests

1 participant