ISSP REST API tehnička dokumentacija
Općenito
Dokument opisuje ISSP REST API i izložene resurse. ISSP REST API je namijenjen programskoj interakciji sa sustavima ISSP i ISAK. ISSP REST API bazira se na Hypertext Transfer Protocol-u (HTTP) opisanom na adresi http://www.w3.org/Protocols/. Za korištenje ISSP REST API-ja potrebno je obaviti HTTP zahtjev i obraditi odgovor. Kod poziva se koriste standardne HTTP metode: GET, POST, PUT i DELETE.
Napomena: u trenutnoj verziji API podržava isključivo GET metodu nad izloženim resursima.
Jedini mogući pristup ISSP REST API-ju je kroz kriptirani kanal (HTTP Secure - SSL/TLS).
Autentikacija i autorizacija
Svaki zahtjev mora koristit Basic Authentication.
Zahtjev će biti autoriziran prema ovlastima definiranim za pojedinog korisnika, kategoriju podataka te metodu (pregled ili rad s resursima).
Primjer upotrebe - klijentska aplikacija
C# (System.Net.Http.HttpClient)
using (var client = new System.Net.Http.HttpClient())
{
client.BaseAddress = new Uri("https://issp.srce.hr/api/");
client.DefaultRequestHeaders.Accept.Clear();
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic",
Convert.ToBase64String(Encoding.GetEncoding("iso-8859-1").GetBytes("userName" + ":" + "password")));
// HTTP GET - Studenti/{oib}
HttpResponseMessage response = client.GetAsync("Studenti/12345678901").Result;
if (response.IsSuccessStatusCode)
{
Student stud = response.Content.ReadAsAsync<Student>().Result;
}
}
Studenti
Naziv metode i resursa | Opis |
---|---|
GET Studenti/{oib} | Dohvat skupa podataka o studentu. |
GET Studenti/jmbag/{jmbag} | Dohvat skupa podataka o studentu. |
GET Studenti/{oib}/osnovniPodaci | Dohvat skupa osnovnih podataka o studentu (dohvaćaju se i aktivne kartice). |
GET Studenti/{oib}/status/{statusStudenta} | Provjera statusa studenta ovisno o ulaznom parametru. (u obzir se uzimaju samo aktivni upisi u tekuću ak. godinu) |
GET Studenti/jmbag/{jmbag}/status/{statusStudenta} | Provjera statusa studenta ovisno o ulaznom parametru. (u obzir se uzimaju samo aktivni upisi u tekuću ak. godinu) |
GET Studenti/status/{statusStudenta}/osnovniPodaci | Dohvat skupa osnovnih podataka o studentima bez podataka o karticama. (aktivni upisi u tekuću i slijedeću ak. godinu - ovisno o statusu) |
GET Studenti/oib/{oib}/status/{statusStudenta}/osnovniPodaci | Dohvat skupa osnovnih podataka o studentu bez podataka o karticama. (aktivni upisi u tekuću i slijedeću ak. godinu - ovisno o statusu) |
GET Studenti/brKartice/{brKartice}/slika | Dohvat slike studenta preko broja studentske iskaznice. (dohvaća se slika sa navedene iskaznice) |
GET Studenti/beskontaktniBrKartice/{beskontaktniBrKartice}/slika | Dohvat slike studenta preko broja beskontaktnog sučelja studentske iskaznice. (dohvaća se slika sa navedene iskaznice) |
GET Studenti/brKartice/{brKartice}/potpis | Dohvat potpisa studenta preko broja studentske iskaznice. (dohvaća se potpis sa navedene iskaznice) |
GET Studenti/beskontaktniBrKartice/{beskontaktniBrKartice}/potpis | Dohvat potpisa studenta preko broja beskontaktnog sučelja studentske iskaznice. (dohvaća se potpis sa navedene iskaznice) |
GET Studenti/oib/{oib}/slika | Dohvat slike studenta putem OIB-a. (dohvaća se najnovija slika) |
GET Studenti/jmbag/{jmbag}/slika | Dohvat slike studenta putem JMBAG-a. (dohvaća se najnovija slika) |
GET Studenti/oib/{oib}/maticniPodaci/aktivanUpis | Dohvat matičnih podataka o studentu za studente s aktivnim upisom godine. (za studenta koji nema aktivan upis godine, podaci se ne dohvaćaju) |
GET Studenti/jmbag/{jmbag}/maticniPodaci/aktivanUpis | Dohvat matičnih podataka o studentu za studente s aktivnim upisom godine. (za studenta koji nema aktivan upis godine, podaci se ne dohvaćaju) |
GET Studenti/oib/{oib}/upisiGodine/aktivni/osnovniPodaci | Dohvat osnovnih podataka o upisima godine studenta u tekuću ak. godinu. |
GET Studenti/jmbag/{jmbag}/upisiGodine/aktivni/osnovniPodaci | Dohvat osnovnih podataka o upisima godine studenta u tekuću ak. godinu. |
GET Studenti/oib/{oib}/upisiGodine/aktivniPlus/osnovniPodaci | Dohvat osnovnih podataka o upisima godine studenta u tekuću i slijedeću ak. godinu. |
GET Studenti/jmbag/{jmbag}/upisiGodine/aktivniPlus/osnovniPodaci | Dohvat osnovnih podataka o upisima godine studenta u tekuću i slijedeću ak. godinu. |
GET Studenti/oib/{oib}/upisiGodine/osnovniPodaci | Dohvat osnovnih podataka o svim upisima godine studenta. |
GET Studenti/jmbag/{jmbag}/upisiGodine/osnovniPodaci | Dohvat osnovnih podataka o svim upisima godine studenta. |
GET Studenti/oib/{oib}/upisiGodine/stipendije/MZOS | Dohvat podataka o upisima godine studenta za stipendije MZO-a. |
GET Studenti/jmbag/{jmbag}/upisiGodine/stipendije/MZOS | Dohvat podataka o upisima godine studenta za stipendije MZO-a. |
GET Studenti/oib/{oib}/upisiGodine/stipendije/MZO | Dohvat podataka o upisima godine studenta za potrebe provođenja natječaja za stipendije MZO-a. |
GET Studenti/jmbag/{jmbag}/upisiGodine/stipendije/MZO | Dohvat podataka o upisima godine studenta za potrebe provođenja natječaja za stipendije MZO-a. |
GET Studenti/akGodina/{akGodina}/NEET | Dohvat liste studenata koji su 'nestali' pri upisu u zadanu ak. godinu, a imaju upis u ak. godinu prije. |
GET Studenti/STEM | Dohvat liste studenata koji ulaze u natječaj za STEM stipendije. |
GET Studenti/studProgram/{studProgId}/STEM | Dohvat liste studenata na studijskom programu koji ulaze u natječaj za STEM stipendije. |
GET Studenti/STEM/forAAI | Dohvat liste studenata za STEM stipendije za izvoz u AAI@EduHr sustav radi prikupljanja e-mail adresa. |
GET Studenti/STEM/studDom | Dohvat liste studenata smještenih u studentske domove koji ulaze u natječaj za STEM stipendije. |
GET Studenti/oib/{oib}/STEM/studiji | Dohvat podataka o studijima studenta za natječaj za STEM stipendije. |
GET Studenti/oib/{oib}/matBr/{matBr}/studijUpisnik/{studijUpisnik}/isUpisnik/{isUpisnik} | Dohvat statusa studenta. Dali je redovan ili ukoliko mu je prestalo pravo razlog tog prestanka |
GET Studenti/oib/{oib}/studentskiPoslovi | Dohvat podataka o studentu potrebnih za ostvarivanje prava na obavljanje studentskih poslova. |
Kartice
Naziv metode i resursa | Opis |
---|---|
GET Kartice/{brKartice}/OIB | Dohvat OIB-a studenta preko broja studentske iskaznice. (u obzir se uzimaju i privremene kartice na dan provjere) |
GET Kartice/{beskontaktniBrKartice}/OIB | Dohvat OIB-a studenta preko jedinstvenog broja beskontaktnog sučelja studentske iskaznice. (u obzir se uzimaju i privremene kartice na dan provjere) |
GET Kartice/{brKartice}/JMBAG | Dohvat JMBAG-a studenta preko broja studentske iskaznice. (u obzir se uzimaju i privremene kartice na dan provjere) |
GET Kartice/{beskontaktniBrKartice}/JMBAG | Dohvat JMBAG-a studenta preko jedinstvenog broja beskontaktnog sučelja studentske iskaznice. (u obzir se uzimaju i privremene kartice na dan provjere) |
GET Kartice/{beskontaktniBrKartice}/BrKartice | Dohvat 19-znamenkastog broja studentske iskaznice preko broja beskontaktnog sučelja studentske iskaznice. |
GET Kartice/{brKartice} | Dohvat podataka o studentskoj iskaznici preko broja studentske iskaznice. |
GET Kartice/{beskontaktniBrKartice} | Dohvat podataka o studentskoj iskaznici preko broja beskontaktnog sučelja studentske iskaznice. |
Ustanove
Naziv metode i resursa | Opis |
---|---|
GET Ustanove/{sifVU} | Dohvat osnovnog skupa podataka o visokom učilištu preko šifre učilišta. |
GET Ustanove/brKartice/{brKartice} | Dohvat osnovnog skupa podataka o visokom učilištu preko preko broja studentske iskaznice. |
GET Ustanove/beskontaktniBrKartice/{beskontaktniBrKartice} | Dohvat osnovnog skupa podataka o visokom učilištu preko preko broja beskontaktnog sučelja studentske iskaznice. |
GET Ustanove/{sifVU}/karticePrivremene/dodijeljene | Dohvat skupa podataka o aktivnim dodijeljenim privremenim karticama na dan dohvata. |
Državne potpore
Naziv metode i resursa | Opis |
---|---|
POST DrzavnePotpore/datoteka | Upload datoteke sa podacima o državnim potporama za studenta u propisanom formatu. |
Restorani
Naziv metode i resursa | Opis |
---|---|
GET Restorani/{matBrNadUstanove} | Dohvat liste restorana preko broja nadređene ustanove |
GET Restorani/Blagajne/{matBrNadUstanove} | Dohvat liste blagajni restorana preko broja nadređene ustanove |
GET Restorani/Blagajne/Racuni/{matBrUstanove}/{brBlagajne}/{godina}/{mjesec}/{dan}/{brDana} | Dohvat računa blagajne u zadanom periodu. |
GET Restorani/Blagajne/Stavke/{matBrUstanove}/{brBlagajne}/{godina}/{mjesec}/{dan}/{brDana} | Dohvat stavki računa blagajne u zadanom periodu. |
GET Restorani/Blagajne/Sastavnice/{matBrUstanove}/{brBlagajne}/{godina}/{mjesec}/{dan}/{brDana} | Dohvat sastavnica menija blagajne u zadanom periodu. |