Ilios 3 API Examples

This repository exists as a place for Ilios users to browse, download, and contribute custom code for accessing, adding, and updating data via the Ilios 3 API.

Ilios users, administrators, and developers should feel free to download and build upon the code provided here for their own custom purposes including, but not limited to, the following:

1. Reporting
2. Enrollments
3. Entity creation/update/deletion (Programs, Courses, Sessions, Offerings, Users, Learning Materials, etc.)

At the current time, all custom and contributed apps are stored at the top level of this repository, regardless of functionality or programming language, and are named in a way that attempts to make their purpose fairly obvious. The programming language in which they're written is indicated by the extension of the filename itself (eg,'.php','.py', etc.), and their use should be fairly well-documented within the comments of the code. If any of the examples require an external data source like a .csv file, the relevant data file should be included in the data/ folder.

If you would like to contribute your own code examples to the repository, please feel free to fork the repo and submit a pull request!

While The Ilios Project offers no guarantee to the quality, effectiveness, or outcome of the code provided here, if you have questions about using any of these code samples for your own purposes, feel free to contact us for assistance at [email protected]! We can't guarantee will be able to help you, but there's always a pretty good chance!

If you'd like to get started writing an application that leverages the Ilios 3 API, but you do not know where to begin, checkout out Getting Started. Good luck!

DISCLAIMER: The Ilios Project is furnishing these code samples "as is" and does not provide any warranty of the code whatsoever, whether expressed, implied, or statutory, including, but not limited to, any warranty of merchantability or fitness for a particular purpose or any warranty that the contents of the item will be error-free.

In no respect shall the Ilios Project incur any liability for any damages, including, but not limited to, direct, indirect, special, or consequential damages arising out of, resulting from, or any way connected to the use of these code examples, whether or not based upon warranty, contract, tort, or otherwise; whether or not injury was sustained by persons or property or otherwise; and whether or not loss was sustained from, or arose out of, the results of, the item, or any services that may be provided by the Ilios Project.