Skip to content
This repository has been archived by the owner on May 24, 2022. It is now read-only.

Set an active edition

TomAlard edited this page Apr 28, 2022 · 1 revision

Editions

The selection tool supports multiple 'editions' of OSOC. Every edition consists of a list of students and projects. Data from different editions cannot interact with each other.

Active and inactive editions

There can be any amount of editions, but at most one can be 'active'. The others are considered 'inactive'. An active edition is currently ongoing. You may view, modify or remove the data in it, or add new data to it. An inactive edition is an edition that either used to be active or is waiting to be activated. You may only view and remove data from such editions, and only if you have Admin permissions. A newly created edition is always inactive by default.

Activating an edition

Since activating an edition is only rarely supposed to happen, it is not supported by the frontend. To activate an edition, first make sure the edition exists and is inactive. Assume the name of the edition is OSOC2022 for this example.

  • Take the base URL of the website (i.e. https://sel2-1.ugent.be)
  • Add /api/editions/ to it, followed by the name of your edition, followed by /activate (i.e. https://sel2-1.ugent.be/api/editions/OSOC2022/activate)
  • Send a POST request to this URL (this can be done using something like postman or curl)

The edition should now be activated. This request will fail instead if the edition either doesn't exist, is already active, or if there is another active edition.

Inactivating an edition

Watch out! This is a dangerous operation, read the entire section before doing anything.

Just like activating an edition, this is only rarely supposed to happen, and is thus not supported by the frontend. To inactivate an edition, first make sure the edition exists and is active. Now follow the same protocol as in the previous section, but replace /activate with /inactivate in the URL of the request. The edition should now be inactivated. This request will fail instead if the edition either doesn't exist or is already inactive.

If the request was successful, the account of all users with the Coach role will be set to Disabled. This is to make them unable to view the data from the following active edition. The accounts are disabled by default to make it easier to restore their accounts if you want to grant them access to the next edition as well. As an Admin, you may also manually delete these accounts in the Users page.