Program Catalogue

The IAS API enables complete program and intake management for the international program catalogue. These endpoints enforce the same business rules as enforced in the UI with respect to what changes to an intake/program (or deletion) is possible after created.

Data Design

To help visualize how programs and intakes are referenced from the application and offers, we made an entity relationship diagram. You will note there are some relationships and although we provide delete endpoints for intakes and programs, you might not be allowed to delete the entities if they have any references.

Managing Programs

The {code} referenced in all of the program endpoints [UAT | PROD] refers to the program code. This is a unique value per college + program.

Some endpoints will have some specific business rules to take in consideration when providing a request body. For example, CreateProgram and UpdateProgram have some additional notes explaining these rules.

You cannot delete a program once it has one or more intakes, because we have to preserve referential integrity). You must delete the intakes (if possible), before deleting the program.

Managing Intakes

The {code} referenced in all of the intake endpoints [UAT | PROD] refers to the intake code. This is a unique value per college + intake. This {code} is referred to in the UI and in other international objects as the intakeSisIdentifier. For example, you can see that alternative name used in the program selection and new offer info objects.

Some endpoints will have some specific business rules to take in consideration when providing a request body. For example, CreateIntake and UpdateIntake have some additional notes explaining these rules. You cannot delete an intake if there are any applications or offers that reference it (via. foreign key).