Ares API Use Cases

Print Friendly and PDF Follow

The Ares API allows developers to perform actions in Ares and build integrations outside of the installed Ares components. For example, the API allows the developers to connect to the database and route items to a new status.

The following types of calls and endpoints are used in Ares: 

Method

Endpoint

 

Lookup

Update 

Create

Items

Users

Courses

Enrollment by configurable identifier

For more information on the API endpoints see Ares API

Use Case

Example Use Case 1

I know what ITEM I want
and the CITATION is in Primo
and I know what COURSE I want to add it to

— or —

I know what ITEM I want
but the CITATION is NOT in Primo
and I know what COURSE I want to add it to

Caveat: This use case expects that potential instructors already exist or are being loaded into UserValidation.

Example Use Case 2

I know what ITEM I want
and it's in the CATALOG
but the item is CHECKED OUT

Caveat: This use case expects that potential instructors already exist or are being loaded into UserValidation.

Example Use Case 3

I want to seee what I've ALREADY REQUESTED (as opposed to all the items for the courses that a user has instructor-level permissions)

Caveats

  • If you are using Ares Authentication with UserValidation and not populating user passwords, users created by the API (via Lookup Username endpoints) will not be able to log into the DLL until their passwords have been reset by staff or reset using the Forgot Password Ares web page.
  • Lookups by CourseID or mapped identifier will NOT include results from course validation. Sites should enable Course Management to automatically create courses if they need all courses to be returned by the course lookup endpoints.

 

Questions?

If this article didn’t resolve your issue, please take a moment and answer a few questions to help improve our documentation:

Feedback