Uppdaterad: 11.1.2021
Det här är en instruktion om uppgifter och format i JSON-gränssnittet för Wilmas utbildningskalender.
Hela förteckningen över utbildningskalendern i JSON-format hittar du med wilmaurl/browsecourses/index_json. Observera att du till skillnad från andra Wilmasidor inte behöver någon nyckel från StarSoft för att få tillgång till utbildningskalenderns info om JSON-gränssnittet. Du behöver heller inga login-uppgifter eftersom allt material i utbildningskalendern är offentligt. JSON-gränssnittet används alltid när utbildningskalendern är i användning, dvs. man behäver inte aktivera JSON-gränssnittet och det går heller inte att inaktivera det.
Tilläggsinformationen finns på wilmaurl/browsecourses/popup?short-term=18383&school-id=4&format=json. Med den kan du också hämta flera utbildningar på en gång genom att i short-term-parametern sätta in kortnumren med kommatecken som avgränsare. Långa utbildningar kan du hämta med parametern long-term. Kommatecknet måste kodas som %2C, till exempel wilmaurl/browsecourses/popup?short-term=18383%2C19895&school-id=4&format=json.
Man kan också hämta fram uppgifter enligt läroanstalt: t.ex. wilmaurl/browsecourses/index_json?school-id=4 ger utbildningarna för den läroanstalt som har kortnummer 4.
Parameter
| Parameter | Ändamål |
|---|---|
| short-term | En lista över korta utbildningar, dvs. kursbaserade, avgränsade med kommatecken. |
| long-term | En lista över långa utbildningar, dvs. utbildningar som leder till examen, avgränsade med kommatecken. |
| school-id | Läroanstaltens kortnummer |
| format | För närvarande är det enda möjliga värdet "json". |
| langid | Språk. Möjliga värden: 1, 2, 3 och tomt, där 1 och tomt är finska, 2 är svenska och 3 är engelska. |
| callback | Anger JSON-svaret som parameter i objektets callback-parameter. Exempel: ...&callback=parseJSON returnerar parseJSON({...}) som resultat. |
| readablejson | Återger JSON i klartext |
Stora och små bokstäver har ingen betydelse.
Utbildningarna indelas enligt läroanstalt och dessutom även i korta och långa. Läroanstalterna bestämmer själva vilka uppgifter och tilläggsuppgifter som ska vara offentliga och under vilka rubriker.
I ett JSON-svar består informationen i huvudsak av följande objekt:
- Läroanstalt med namn, ID och kategorier.
- Kategori med namn, typ, läroanstaltens kortnummer och utbildningar.
- Utbildning med ID, typ och den information som ska visas.
Nyckel
| Nyckel | Ändamål |
|---|---|
| Id | Entitetens kortnummer |
| Caption | Det namn som syns för slutanvändaren. |
| Categories | Kategorier |
| Type | Typ: kort utbildning "short" eller lång utbildning "long". |
| SchoolId | Läroanstaltens kortnummer |
| Headers | De rubriker som läroanstalten valt för den offentliga informationen |
| Courses | Utbildningar |
| Cells | De uppgifter om utbildningen som syns för slutanvändarna. Cellerna för den rad som utgör en utbildning. |
OBS! Payment Method-nycklarna används från Wilma 2.18 och framåt.
Övriga uppgifter
| Nyckel | Ändamål |
|---|---|
| NoSMTPCheckRequiredCourses | Korta utbildningar som inte kräver e-postverifiering. |
| NoSMTPCheckRequiredSchoolings | Långa utbildningar som inte kräver e-postverifiering. |
| CorporationFormsOK, t.ex. (4,5) | Av typen string, inom parentes de skolor, vilkas ansökningsblanketter för företag är i skick. |
Tilläggsuppgifter i JSON-format
Om tilläggsuppgifterna är ifyllda returneras en JSON-lista över tilläggsuppgifterna innehållande utbildningar bestående av x antal poster i nyckel-värde-format av de uppgifter som läroanstalten valt: nyckeln är den valda rubriken och som information kommer innehållet i det/de fält som har valts som information.
Närliggande teman
