KOPPS API for Programmes

Following endpoints return different information related to Programmes in KOPPS

Programmes

/api/kopps/v2/programmes/all

Gets a list of al programmes

Examples:
/api/kopps/v2/programmes/all
/api/kopps/v2/programmes/all?l=en

/api/kopps/v2/programme/

Gets a list of programmes having state ESTABLISHED or DEACTIVATED

Examples:
/api/kopps/v2/programme/

/api/kopps/v2/programmes/rounds

Gets a list of programme rounds for given term and study year

/api/kopps/v2/programme/{<[A-Za-z0-9%]+>programmeCode}

Gets a programme by programme code

Examples:
/api/kopps/v2/programme/CDEPR

/api/kopps/v2/programme/{<[A-Za-z0-9]+>programmeCode}.{<[A-Za-z0-9]*>programmeSpecializationCode}.{<[0-9]{4}>academicYear}.{<[1-5]>studyYear}

/api/kopps/v2/programme/{<[A-Za-z0-9]+>programmeCode}.{<[A-Za-z0-9]*>programmeSpecializationCode}.{<[0-9]{4}[1-2]{1}>academicYear}.{<[1-5]>studyYear}

These two endpoints return course information for the given program, program specialization and academic term. The difference is in the format of academic year parameter. If Academic term parameter is only 4 digit, Term digit '2' is appended by the system

Examples:
/api/kopps/v2/programme/CDEPR.COMMON.2018.1
/api/kopps/v2/programme/CDEPR.AEE.2018.1
/api/kopps/v2/programme/CDEPR.COMMON.20182.1
/api/kopps/v2/programme/CDEPR.AEE.20182.1

/api/kopps/v2/programme/{<[A-Za-z0-9]+>programmeCode}.{<[0-9]{4}>academicYear}

/api/kopps/v2/programme/{<[A-Za-z0-9]+>programmeCode}.{<[0-9]{4}[1-2]{1}>academicYear}

These two endpoints return list of specializations for the given program and academic year. The difference is in the format of academic year parameter. If Academic term parameter is only 4 digit, Term digit '2' is appended by the system

Examples:
/api/kopps/v2/programme/CDEPR.20181
/api/kopps/v2/programme/CDEPR.2018

/api/kopps/v2/programmes/{<[A-Za-z0-9%]+>programmeCode}/studyprogramme/version/{<[0-9]{4}[1-2]{1}>validFromTerm}

Gets a study programme version for given programme code and term

Examples:
/api/kopps/v2/programmes/CDEPR/studyprogramme/version/20182
/api/kopps/v2/programmes/CDEPR/studyprogramme/version/20182?l=en

Curriculum

/api/kopps/v2/studyprogramme/{<[0-9]+>studyProgrammeVersionId}/curriculums

Gets a list of curriculums for given study programme version id

Examples:
/api/kopps/v2/studyprogramme/1/curriculums
/api/kopps/v2/studyprogramme/1/curriculums?l=en

Academic Year Plans

/api/kopps/v2/academicyearplan/{<[A-Za-z0-9%]+>programmeCode}/{<[0-9]{4}[1-2]{1}>academicYearStartTerm}/{<[1-5]>studyYearNumber}

Gets a list of course rounds in academic year plan for given programme code (specialization 'common') and academic year

Examples:
/api/kopps/v2/academicyearplan/CDEPR/20182/1

/api/kopps/v2/academicyearplan/{<[A-Za-z0-9%]+>programmeCode}/{<[A-Za-z0-9]+>specializationCode}/{<[0-9]{4}[1-2]{1}>academicYearStartTerm}/{<[1-5]>studyYearNumber}

Gets a list of course rounds in academic year plan for given programme code, speciallization and academic year

Examples:
/api/kopps/v2/academicyearplan/CDEPR/AEE/20182/3

/api/kopps/v2/programme/academic-year-plan/{programmeCode}/{<[VvHh][Tt][0-9]{2}>startterm}

Gets complete academic year plans for the given programme code

Examples:
/api/kopps/v2/programme/academic-year-plan/CDEPR/HT18