PHPackages                             melonsmasher/ethos-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. melonsmasher/ethos-php

ActiveLibrary[API Development](/categories/api)

melonsmasher/ethos-php
======================

A PHP library to interact with the Ellucian Ethos API.

v0.1.2(5y ago)4831MITPHPPHP >=7.2.0

Since Jun 20Pushed 5y ago1 watchersCompare

[ Source](https://github.com/MelonSmasher/ethos-php)[ Packagist](https://packagist.org/packages/melonsmasher/ethos-php)[ Docs](https://github.com/MelonSmasher/ethos-php)[ RSS](/packages/melonsmasher-ethos-php/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (2)Versions (11)Used By (1)

ethos-php
=========

[](#ethos-php)

A PHP library to interact with the Ellucian Ethos API.

[![License](https://camo.githubusercontent.com/b8cadaa967891081f8f165695470689986c028821dd8a040132f6e661795dc0d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c7565)](https://raw.githubusercontent.com/MelonSmasher/ethos-php/master/LICENSE)[![GitHub issues](https://camo.githubusercontent.com/912cb872db5c444f5949565bfd9ff0bf0aa98c42468b1acad7002caf92b7405e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f4d656c6f6e536d61736865722f6574686f732d706870)](https://github.com/MelonSmasher/ethos-php/issues)[![GitHub top language](https://camo.githubusercontent.com/0154aec3a5ff557ea88de9e418910241afa84e5ee34d73265d9bdeb050ee59f6/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f746f702f4d656c6f6e536d61736865722f6574686f732d706870)](https://camo.githubusercontent.com/0154aec3a5ff557ea88de9e418910241afa84e5ee34d73265d9bdeb050ee59f6/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f746f702f4d656c6f6e536d61736865722f6574686f732d706870)[![Packagist PHP Version Support](https://camo.githubusercontent.com/43bea9c838e02abbc185cf524e35b80e1b0287534e26ec28723408a0b88894bb/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f4d656c6f6e536d61736865722f6574686f732d706870)](https://camo.githubusercontent.com/43bea9c838e02abbc185cf524e35b80e1b0287534e26ec28723408a0b88894bb/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f4d656c6f6e536d61736865722f6574686f732d706870)[![Codacy grade](https://camo.githubusercontent.com/28644e1227ad95a554595fb6b402d6bc036698afb315031d82afca42fe85cfc6/68747470733a2f2f696d672e736869656c64732e696f2f636f646163792f67726164652f3932316234323738623961663439373162343030336338373461353261626466)](https://camo.githubusercontent.com/28644e1227ad95a554595fb6b402d6bc036698afb315031d82afca42fe85cfc6/68747470733a2f2f696d672e736869656c64732e696f2f636f646163792f67726164652f3932316234323738623961663439373162343030336338373461353261626466)

---

Installation
------------

[](#installation)

```
composer require melonsmasher/ethos-php
```

API Docs
--------

[](#api-docs)

Complete API docs can be [found here](https://melonsmasher.github.io/ethos-php/docs/).

Features
--------

[](#features)

As of now `ethos-php` has support for `316` models/routes. It supports nearly all Banner & Colleague models with the following feature set.

- A fluent API allowing for methods to be chained to improve readability.
- Convenience methods that return the response data as an object: `data()`, as an array: `toArray()`, and as a JSON string: `toJson()`.
- Simple control over API pagination. Max ten items returned per-page.
- Automatic re-authentication when a session expires.
- Support for Banner and Colleague backends.
- Automatically versioned API calls.
- Control over request params and headers.
- Class level awareness of Ethos CRUD support.
- Support for ID based routes. E.G. `/api/persons/35b16136-bafd-4b5d-9dd2-995ad9f4ba00`
- Support for the `/consume` subscription message queue route.

Features To Come
----------------

[](#features-to-come)

- Support for the `/publish` subscription message queue route.

Usage/Examples
--------------

[](#usageexamples)

The example below demonstrates the fluent API, convenience methods, and control over pagination.

```