How can we help?

My Cases

Using Swagger Docs UI for API Calls
Last Updated: Dec 14, 2017 03:05PM EST

This article applies to:  Echo360 Admins

Before reading further, you need to understand that the Swagger Docs UI is not designed for extensive API use with respect to changing your Echo360 configuration. However, it is VERY helpful in finding all of the available API endpoints, and the model and model schemas for each endpoint.

It can help you familiarize yourself with the calls you can make and what they can (and cannot do), what values you need to be prepared to provide, and to do some basic testing of the API and how it makes changes to your Echo360 institution.

And for some, the Swagger Docs UI is easier to navigate than a desktop API client for making small changes.

The Swagger Docs URL is: https://<echo360URL>/api-documentation. Specifically for each region, the Swagger Docs URLs are:

NOTE: The above Echo360 URLs (minus the /api-documentation part) are also the FQDN (fully qualified domain name) for the API themselves. So that when USING the API, you would enter https://<echo360URL>/<apiEndpoint>

You are also encouraged to download and try out our Java or .NET SDK to help you use the Echo360 API.

swagger docs URL landing page with main endpoints as described

Clicking on one of the listed endpoints expands the item to show all of the available operations for that item.

Clicking on one of the available operations provides fields that you can fill in to run that call. The Try it out! button at the bottom of the operations section runs that call with the values provided.

HOWEVER, in order to run any of the calls from this page, you must have a valid Access Token pasted into the access token field at the top of the page.

No sweat! Use the oauth2access_token operation to get one!
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
Invalid characters found