API-dokumentation

Autentisering

Autentisering sker via headern x-api-key. x-api-key: min-nyckel.

För bakåtkompatibilitet finns även möjlighet att autentisera via headern authorization. authorization: basic min-nyckel-i-base-64

GET-anrop

Vid ett GET-anrop skickas en students personnummer och valfri studieperiod in via anropets URL.

Tillbaka får du en indikation på om studenten kvalificerat sig för vad frågan gäller.

POST-anrop

Vid ett POST-anrop skickas en lista av studenters personnummer och valfri studieperiod in via anropets body. Anges ingen studieperiod kommer nuvarande period att användas.

Tillbaka får du en lista av de inskickade studenterna ihop med en indikation på om studenten kvalificerat sig för vad frågan gäller.

In


	{ "pnrs": ["19810623XXXX","19810623YYYY"], "period": "HT2020" }

Ut


	[

	{ "pnr": "19810623XXXX", "period": "HT2020", "qualified": false },

	{ "pnr": "19810623YYYY", "period": "HT2020", "qualified": false }

	]

Bokoll

För Bokoll kan du undersöka om en student kvalificerar sig som aktiv för en viss studieperiod.

För att en student skall räknas som aktiv skall något av följande kriterier uppfyllas:

Studenten deltar för närvarande i kurs för utbytesstudier oavsett studieperiod.
Studenten deltar för närvarande i kurs för forskarstudier oavsett studieperiod.
Studenten har ansökt eller deltar i kurser som ges på plats i Växjö för sammanlagt minst 7,5 poäng. Samtidigt har studenten klarat av mer än 15 poäng från och med perioden som föregick den efterfrågade perioden.


	[GET] /api/bokoll/{pnr}/{period?}

	[POST] /api/bokoll

Kalmarhem

För Kalmarhem kan du undersöka om en student kvalificerar sig som aktiv för en viss studieperiod.

För att en student skall räknas som aktiv skall något av följande kriterier uppfyllas:

Studenten har manuellt markerats som aktiv oavsett studieperiod.
Studenten har studieuppehåll oavsett studieperiod.
Studenten har ansökt till, deltar, eller har klarat av kurser under perioden för sammanlagt minst 30 poäng.

Du kan även undersöka ifall studenten kvalificerar sig för Bostadsgaranti.

För att en student skall räknas som kvalificerad skall något av följande kriterier uppfyllas.

Studenten har manuellt markerats som kvalificerad oavsett studieperiod.
Studenten anses vara kvalificerad enligt systemet NyA.


	[GET] /api/kalmarhem/activity/{pnr}/{period?}

	[POST] /api/kalmarhem/activity

	[GET] /api/kalmarhem/bostadsgaranti/{pnr}/{period?}

	[POST] /api/kalmarhem/bostadsgaranti

Studentkåren

För Studentkåren kan du få information om forskare, studenter och kurser de läser.

Hämta förskare


	[GET] /api/researcher/

Hämta en student


	[GET] /api/student/{pnr}

Hämta utbildningar som studenten läser


	[GET] /api/student/{pnr}/educations

Hämta flera studentener


	[POST] /api/student/ 

	body: { "pnrs": ["19810623XXXX","19810623YYYY"], "dataType": "students" }

Hämta utbildningar


	[POST] /api/student/ 

	body: { "pnrs": ["19810623XXXX","19810623YYYY"], "dataType": "educations" }