CDC

Prime ReportStream

A router of public health data from multiple senders and receivers

Government & public#openapi#open-data#collaboration

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

A router of public health data from multiple senders and receivers

Endpoints 14

  • POSTPost a report to the data hub/reports?client=simple_report&option=ValidatePayload&default=processing_mode_code%3AD&routeTo=fl-phd.elr,fl-phd.download
  • GETGET /settings/organizations/settings/organizationsThe settings for all organizations of the system. Must have admin access.
  • HEADHEAD /settings/organizations/settings/organizationsRetrived the last modified for all settings of the system. Must have admin access.
  • GETGET /settings/organizations/{organizationName}/settings/organizations/:organizationNameA single organization settings
  • PUTPUT /settings/organizations/{organizationName}/settings/organizations/:organizationNameCreate or update the direct settings associated with an organization
  • DELETEDELETE /settings/organizations/{organizationName}/settings/organizations/:organizationNameDelete an organization (and the associated receivers and senders)
  • GETGET /settings/organizations/{organizationName}/receivers/settings/organizations/:organizationName/receiversA list of receivers and their current settings
  • GETGET /settings/organizations/{organizationName}/receivers/{receiverName}/settings/organizations/:organizationName/receivers/:receiverNameThe settings of a single of receiver
  • PUTPUT /settings/organizations/{organizationName}/receivers/{receiverName}/settings/organizations/:organizationName/receivers/:receiverNameUpdate a single reciever
  • DELETEDELETE /settings/organizations/{organizationName}/receivers/{receiverName}/settings/organizations/:organizationName/receivers/:receiverNameDelete a receiver
  • GETGET /settings/organizations/{organizationName}/senders/settings/organizations/:organizationName/sendersA list of senders
  • GETGET /settings/organizations/{organizationName}/senders/{senderName}/settings/organizations/:organizationName/senders/:senderNameThe settings of a single of sender
  • PUTPUT /settings/organizations/{organizationName}/senders/{senderName}/settings/organizations/:organizationName/senders/:senderNameUpdate a single sender
  • DELETEDELETE /settings/organizations/{organizationName}/senders/{senderName}/settings/organizations/:organizationName/senders/:senderNameDelete a sender

API details

Base URL
http://cdcgov.local
Authentication
An API key in the x-functions-key header
OAuth 2.0 (authorization code flow) with 3 scopes
Operations
14 operations on 7 pathsGET 6PUT 3DELETE 3HEAD 1POST 1
Response formats
application/json
Description format
OpenAPI 3.0.2, API version 0.2.0-oas3
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Prime ReportStream in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Prime ReportStream collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the x-functions-key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Post a report to the data hub” (POST /reports?client=simple_report&option=ValidatePayload&default=processing_mode_code%3AD&routeTo=fl-phd.elr,fl-phd.download), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Prime ReportStream?

A router of public health data from multiple senders and receivers It is listed under Government & public and has 14 endpoints.

Who publishes the Prime ReportStream?

It is listed from CDC's public API description (an OpenAPI document), not published by CDC on Swastik Codes. Anyone who controls cdc.gov can claim the profile by adding a DNS TXT record.

What is the base URL of the Prime ReportStream?

Requests go to http://cdcgov.local. Endpoint paths are added to this base URL.

How do I authenticate with the Prime ReportStream?

It accepts 2 methods: an API key in the x-functions-key header; OAuth 2.0 (authorization code flow) with 3 scopes.

How many endpoints does the Prime ReportStream have?

14 operations on 7 paths (6 GET, 3 PUT, 3 DELETE, 1 HEAD, 1 POST).

Is forking the Prime ReportStream free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.