[FEAT] Enroll users to ZAE RCEs through API

[adesche]

Contact Details

[email protected]

Is your feature request related to a problem? If so, please describe.

Not directly related to the purpose of the request (but for the sake of time), in /academy/identifiers/ route, the documentation describes the return from the request as a list of course IDs. However, under the getIdentifiers() function which the route points to the data returned is the "exam" IDs and not the course IDs. This therefore is providing both incorrect data per the intended use and no data of use for the /academy/enroll/{courseId} route also available in API v2. (e.g. S2 exam ID is 9 whereas the course ID is 11... the exam ID is returned in the identifiers route whereas the course ID should be instead)

What is your new feature idea or request?

I would like the /academy/enroll/{courseId} route to be expanded to the use of the Rating Competency Exams available in ZAE. This would allow for ease-of-access when enrolling students in their necessary competency exam through facility websites (and possibly through the USA frontend) instead of having to utilize the unnecessarily sophisticated Moodle interface.

[bnahin]

Steps to implement:

1. Add RCE Course IDs to the ENV and exams config.
2. Publish IDs in the identifiers endpoint.

   api/app/Http/Controllers/API/v2/AcademyController.php

   Line 54 in e6d2410

   public function getIdentifiers(Request $request)

3. Update enroll endpoint accordingly to allow RCE IDs.

   api/app/Http/Controllers/API/v2/AcademyController.php

   Line 103 in e6d2410

   public function postEnroll(Request $request, int $courseId): Response

4. Update assignment emails accordingly.

   api/app/Console/Commands/SendAcademyRatingExamEmails.php

   Line 80 in e6d2410

   if ($attempt['quiz'] == config('exams.S2.id')) {

5. Future: Update Discord bot messages accordingly, once that is ever implemented.