KOPPS API for Courses
Following endpoints return different information related to Courses in KOPPS. The default language is Swedish, but English can be selected by a query argument(?l=en)
Courses
/api/kopps/v2/course/{courseCode}
Its a light weight end point which returns information about one specific course, including recent and future rounds. The course version valid for current term is returned, it may or may not be the latest version. The information is both in English and Swedish by default
Examples:
/api/kopps/v2/course/SF1624
/api/kopps/v2/course/{courseCode}/detailedInformation
This returns more detailed course information, including rounds, round terms, application codes and syllabus etc. It takes an optional query parameter validAtTerm, fromTerm and toTerm. If this parameter is provided, the course information is returned based on version valid for that term else from latest version. All course rounds, examination rounds and syllabus versions are returned regardless of course version.
| Parameter | Mandatory | Possible Values |
|---|---|---|
| validAtTerm | No | 5 digit term value for eg, 20181 |
| fromTerm | No | 5 digit term value for eg, 20181. It is for filtering rounds based on start term or last term |
| toTerm | No | 5 digit term value for eg, 20181. It is for filtering rounds based on start term or last term |
Examples:
/api/kopps/v2/course/DD1321/detailedinformation
/api/kopps/v2/course/DD1321/detailedinformation?validAtTerm=20062
/api/kopps/v2/course/DD1321/detailedinformation?validAtTerm=20062&l=en
/api/kopps/v2/course/{courseCode}/courseroundterms
This returns a list of all the terms for course having course rounds. It also returns rounds per term, examination rounds per term and course syllabus per term. The list of terms can be restricted by providing fromTerm and toTerm parameters. The response includes data in both Swedish and English
| Parameter | Mandatory | Possible Values |
|---|---|---|
| fromTerm | No | 5 digit term value for eg, 20181 |
| toTerm | No | 5 digit term value for eg, 20181 |
Examples:
/api/kopps/v2/course/DD1321/courseroundterms
/api/kopps/v2/course/DD1321/courseroundterms?fromTerm=20142
/api/kopps/v2/course/DD1321/courseroundterms?toTerm=20172&fromTerm=20142
/api/kopps/v2/courses
Returns a list of all courses
Examples:
/api/kopps/v2/courses
/api/kopps/v2/courses?l=en
/api/kopps/v2/courses/count
Returns total number of courses
Examples:
/api/kopps/v2/courses/count
/api/kopps/v2/courses/part
Returns a list of courses according to provided index and batch size parameters. If min_last_term_exam is provided, courses with Cancelled state are filtered on this value. Provides information in both English and Swedish
| Parameter | Mandatory | Possible Values |
|---|---|---|
| index | Yes | Any integer |
| batch_size | Yes | Any integer |
| min_last_exam_term | No | 5 digit term value for eg, 20181 |
Example:
/api/kopps/v2/courses/part?batch_size=1000&index=1
/api/kopps/v2/courses/offerings
Returns a list of course rounds valid for given term parameter. Every object in the list is bundled with lot of data related to the course round for example; semesters, application information, Programme etc.
| Parameter | Mandatory | Possible Values |
|---|---|---|
| from | Yes | 5 digit term value for eg, 20181 |
| skip_coordinator_info | No | boolean true or false. Default false |
Examples:
/api/kopps/v2/courses/offerings?from=20202
/api/kopps/v2/courses/offerings?from=20202&skip_coordinator_info=true
/api/kopps/v2/courses/offerings/roundnumber
Gets a course round according to given ladokuid of its course round application.
| Parameter | Mandatory | Possible Values |
|---|---|---|
| ladokuid | Yes | A valid ladokuid |
/api/kopps/v2/courses/offerings/roundnumber?ladokuid=796c8618-73da-11e8-b4e0-063f9afb40e3
/api/kopps/v2/courses/courserounds
Gets a list of public course rounds (those which have been published to Ladok) according to provided search criteria. Provides information in both English and Swedish
| Parameter | Mandatory | Possible Values |
|---|---|---|
| type | No | Valid course round types e.g,(SAP,UKI). Can provide multiple type parameters |
| semester | No | 5 digit term value for eg, 20181 or 'current' |
| category | No | PU,VU |
| tutoringForm | No | NML,DST,ITD |
| tutoringTime | No | DAG,KVÄ,VSL |
| teachersFurtherEdu | No | boolean |
| inEnglish | No | boolean |
| excludedTypes | No | Valid course round types that shall be excluded. Can provide multiple excludedTypes parameters |
Example:
/api/kopps/v2/courses/courserounds?semester=current&category=PU&tutoringTime=DAG
/api/kopps/v2/courses/search
Search for courses according to provided criteria. None of the query parameters are mandatory but atleast one of them must be provided
| Parameter | Mandatory | Possible Values |
|---|---|---|
| text_pattern | No | Text pattern to search for in course code and course name. Could be complete or a part of course code or name |
| only_mhu | No | boolean |
| in_english_only | No | boolean. If true only return courses that have at least one course round given in english |
| include_non_active | No | boolean |
| term_period | No | format {5 digit term}:{1 digit period} |
| educational_level | No | ADVANCED,BASIC,RESEARCH,PREPARATORY. Can provide multiple educational levels |
| department_prefix | No | valid department code |
Examples:
/api/kopps/v2/courses/search?educational_level=RESEARCH&educational_level=ADVANCED&term_period=20182:1&department_prefix=ADC
/api/kopps/v2/courses/search?educational_level=RESEARCH&educational_level=ADVANCED&term_period=20182:1&department_prefix=ADC&l=en
/api/kopps/v2/courses/{departmentCode}.{format}
Returns a list of active courses given by a specific department. The supported {format}s are json and rss. For each course; the code, title, credits, education level and a brief text description is given, together with a link for more information.
Examples:
/api/kopps/v2/courses/DD.json
/api/kopps/v2/courses/DD.rss
/api/kopps/v2/courses/DD.rss?l=en
Course Syllabus
/api/kopps/v2/syllabuses/{courseCode}
Gets some course information and a list of approved syllabuses for the given course code
Examples:
/api/kopps/v2/syllabuses/DT2118
/api/kopps/v2/syllabuses/DT2118?l=en
/api/kopps/v2/syllabuses/{courseCode}/{semester}
Gets a list of approved syllabuses with detailed syllabus information for the given course code. Course version valid at given semester value is used
Examples
/api/kopps/v2/syllabuses/DT2118/20162
/api/kopps/v2/syllabuses/DT2118/20162?l=en