Introduction

NovoEd archive APIs are a set of APIs that allows customers to download user-generated content from their courses and integrate it into their own archiving systems. User-generated content (UGC) is anything that a user posts or creates in a course, such as assignment submissions, discussion comments, replies, etc.

The archive APIs allow customers to download the corresponding user-generated content in NovoEd learning experiences in JSON format for a 24-hour period:

• Discussion content including all posts, comments, and replies
• Messages sent between two or more users in the private messaging inbox
• Teams and Groups workspace discussions including posts, comments, replies, documents and meeting information
• Learner assignment submissions 
• Assignment Submission comments and replies
• Public Feedback
• Private Feedback

Note: Data returned includes content that might have been deleted by the user.

Recommended Use

Archive API allows customers to download the content generated in the past 24 hours or 24 hours prior to a specified date and time. NovoEd recommends at least a daily download of data when archiving ongoing courses. Technical implementation is required by customers to save this data, either in JSON format or converted to a specific archiving format required by the compliance systems in place.

Attachments to content are included as links in the JSON API response and can also be downloaded for archiving. 

Set-Up

Prior to using the Archive APIs, you will need to request an API Key and Secret. Then, you will connect it to your preferred course(s) and/or link it to your whole institution.

This article, How to Request and Set Up an API Key and Secret, walks through the process of requesting and setting up the API Key and Secret.

Endpoints

There are eight endpoints:

1. GET Message Archive
2. GET Discussion Archive
3. GET Assignment Submission Archive
4. GET Submission Discussion Archive
5. GET Private Feedback Archive
6. GET Practice Submission Archive
7. GET Practice Submission Discussion Archive
8. GET Team and Group Workspace Archive

Developer Documentation

User-Generated Content APIs

Troubleshooting

• Make sure the API Key and Secret are valid. Customers will receive a 401 error if the API Key and Secret are invalid.
• Make sure calls are being made from an IP address that is authorized to use the key and secret. A 401 error will also be received here if they are not. 
• Make sure a JSON call is being made. This can be done by adding .json to the end of the endpoint before starting to pass the parameters. If the wrong request type is made or HTTP is being requested instead of JSON, an error page will show.