Swagger is an open source framework comprising a large system of tools that contains the endpoint documentation that allows authenticated users to view the Eval25 Data Export API. You will need to access the API documentation via Swagger.
You will need your API user name, which was emailed to you by CollegeNET, and your passcode, which was emailed to you by your institution’s Eval25 Administrator.
Accessing the Data Export API
1. Locate the new User Email Sent to you From CollegeNET
- Double-click the web address located below the text line “You can log into the API interface at the following site.”
2. Enter Your Username and Password
- In the login window, enter your username sent to you from your institution’s Eval25 Administrator and the passcode sent to you in the email from CollegeNET.
3. Click Log In and Access the Eval25 Export API Page
Understanding the Export API Page
On the Eval25 Export API page, you’ll see the primary API modules:
- Form Controller: Allows you to “GET” data and attributes for evaluation forms.
- Institution Controller: Allows you to “GET” session-level data and attributes for your institution.
- Metadata Controller: Allows you to “GET” metadata for courses, instructors and terms.
- Qualitative Summary Controller: Allows you to “GET” qualitative question summary data for a Term ID, Course ID, Instructor ID, School Code, Department Code, Subject, Subject Number, and Number Instructor ID.
- Quantitative Summary Controller: Allows you to “GET” quantitative question summary data for a Term ID, Course ID, Instructor ID, School Code, Department Code, Subject, Subject Number, and Number Instructor ID.
- Question Controller: Allows you to “GET” the question data for a Term ID, Form Code, Form Code Question Type, and Term ID Question Type.
To consume the API, you can use a 3rd party application, such as Postman, or can set up something within any other application.
Alternatively, via Curl commands you can use two separate steps to get the token using the POST method, and then appending the token to the request URL to produce a GET request for the data.
Both of these methods are discussed in the Making an OAuth2 REST API Request via Postman article.
A PDF version of this page has been attached for you to send to your API users. Eval25_Data_Export_API_and_Swagger.pdf