Ready API Contact Trace Endpoints

Owned by jamal.naveed
Last updated: Sept 02, 2024 by Farwa Ali
1 min read

As a Campus Cloud administrator, you can use the API to grant access to data on Campus Cloud. For more information on these endpoints, please see Ready API Technical Documentation.

To create an API key, follow the steps in this article: Create a New App Integration.

  1. Health and Wellness Endpoint

  2. Form Endpoint

  3. QR Code Endpoint

  4. Case Endpoint

  5. Exposure Notification Endpoint

Health and Wellness Endpoint

When you create an API key for Health & Wellness Insights, anyone who has that token can access the following endpoints:

  • Daily Case Stats

  • Form Completion Stats

As you are creating your API key, make sure to enable the Health & Wellness endpoint (Found in API Management under Insights).

Form Endpoint

The Form endpoint returns an array of Forms and metadata about them. Make sure to enable the Form endpoint.

QR Code Endpoint

You can programmatically view, create, and modify QR Codes used in the Contact Trace module of Campus Cloud. The QR Code endpoint returns a list of QR codes and lets you modify and delete existing codes. You can also create new QR codes with this endpoint. 

Make sure to enable the QR Code endpoint.

Case Endpoint

You can get a list of cases currently active in the Contract Trace module of Campus Cloud. The Case endpoint returns an array of Cases and metadata about them. Make sure to enable the Case endpoint.

Exposure Notification Endpoint

You can programmatically get details of notifications sent to students as part of the Contact Trace module in Campus Cloud. The Exposure Notification endpoint returns an array of sent notifications with information about who they were sent to. Make sure to enable the Exposure Notification endpoint.