iqual/all4schools_connector

This package is abandoned and no longer maintained. No replacement package was suggested.

There is no license information available for the latest version (3.0.0) of this package.

Provides integration with the All4Schools software

3.0.0 2023-10-27 08:14 UTC

Requires

• php: ^8.1
• drupal/core: ^9.5 || ^10

Unknown License

README

This module deals with retrieving data, error management and support for webform data submission to All4Schools.

About All4Schools

All4Schools is a course and students management software with an interface to retrieve/send data about courses and participants. The data is transmitted as JSON in both directions.

Module configuration

The module can be configured in drupal under the following path: /admin/config/services/All4Schools

The following parameters are required:

1. Base url: the API endpoint for your project. For some project an additional test endpoint can be available. Use your local settings file to overwrite it.
2. Request id: A unique id pro client. This should be communicated byt the client / owner of the API.
3. Additionnaly, some implementations might require an AppUserId for POST requests. This should be communicated byt the client / owner of the API.

Tests

There is no unit testing available for now. If you want to quickly test the connector, you can create a script.php file in a custom module and instantiate the example plugin:

<?php

$plugin_manager = \Drupal::service('plugin.manager.all4schools_connector');
$plugin_instance = $plugin_manager->createInstance('example_all4schools_connector');

// Test any method.
$all_courses = $plugin_instance->getCourses();

Check in Lastpass for working API Endpoints / request_id