Courses

NAVIGATE CONTENT
Ex Libris Developer Network Alma Documentation REST APIs Courses

The Courses API allows access to courses and reading lists related information, as described in the map below:

 

Alma provides a set of Web services for handling courses and reading lists related information, enabling you to quickly and easily manipulate their details. These Web services can be used by external systems such as Courses Management Systems to retrieve or update courses and reading lists related data.

Courses

APIPath
Retrieve Courses
GET /almaws/v1/courses
Add a new Course
POST /almaws/v1/courses
Remove Course
DELETE /almaws/v1/courses/{course_id}
Retrieve Course
GET /almaws/v1/courses/{course_id}
Enroll to course
POST /almaws/v1/courses/{course_id}
Update Course
PUT /almaws/v1/courses/{course_id}
Delete Course Enrollment
DELETE /almaws/v1/courses/{course_id}/lists/{list_id}
Retrieve Course Enrollment
GET /almaws/v1/courses/{course_id}/users
Delete Course Enrollment
DELETE /almaws/v1/courses/{course_id}/users/{user_id}

Reading Lists

APIPath
Retrieve Reading Lists
GET /almaws/v1/courses/{course_id}/reading-lists
Create a Reading List
POST /almaws/v1/courses/{course_id}/reading-lists
Remove Reading List
DELETE /almaws/v1/courses/{course_id}/reading-lists/{reading_list_id}
Retrieve a Reading List
GET /almaws/v1/courses/{course_id}/reading-lists/{reading_list_id}
Update a Reading List
PUT /almaws/v1/courses/{course_id}/reading-lists/{reading_list_id}

Citations

APIPath
Retrieve Citations
GET /almaws/v1/courses/{course_id}/reading-lists/{reading_list_id}/citations
Create Citation
POST /almaws/v1/courses/{course_id}/reading-lists/{reading_list_id}/citations
Remove Citation
DELETE /almaws/v1/courses/{course_id}/reading-lists/{reading_list_id}/citations/{citation_id}
Retrieve Citation
GET /almaws/v1/courses/{course_id}/reading-lists/{reading_list_id}/citations/{citation_id}
Remove file from citation
POST /almaws/v1/courses/{course_id}/reading-lists/{reading_list_id}/citations/{citation_id}
Update Citation
PUT /almaws/v1/courses/{course_id}/reading-lists/{reading_list_id}/citations/{citation_id}

Owners

APIPath
Retrieve Owners
GET /almaws/v1/courses/{course_id}/reading-lists/{reading_list_id}/owners
Create Owner
POST /almaws/v1/courses/{course_id}/reading-lists/{reading_list_id}/owners
Delete Owner
DELETE /almaws/v1/courses/{course_id}/reading-lists/{reading_list_id}/owners/{primary_id}
Retrieve Owner
GET /almaws/v1/courses/{course_id}/reading-lists/{reading_list_id}/owners/{primary_id}
Update Owner
PUT /almaws/v1/courses/{course_id}/reading-lists/{reading_list_id}/owners/{primary_id}

Tags

APIPath
Retrieves Tags
GET /almaws/v1/courses/{course_id}/reading-lists/{reading_list_id}/citations/{citation_id}/tags
Update Tags
PUT /almaws/v1/courses/{course_id}/reading-lists/{reading_list_id}/citations/{citation_id}/tags

Test

APIPath
GET Course Test API
GET /almaws/v1/courses/test
POST Course Test API
POST /almaws/v1/courses/test

OpenAPI Specification

For information about the OpenAPI standard, see the OpenAPI Initiative. You can also read about OpenAPI support in Ex Libris APIs.

OpenAPI Specification

Download the OpenAPI specification for these APIs in JSON or YAML format:

Swagger Codegen

Download an SDK powered by the Swagger Code Generator:

Download SDK
Swagger Editor

The Swagger Editor provides a side-by-side view of the specification and the Swagger UI console. It's an easy way to explore the standard and learn by playing.

View this API specification in the Swagger Editor

 

CoursesReading ListsCitationsOwnersTags