SkolaOnline API

Funkčnost API byla odvozena podle odposlechnuté komunikace aplikace se serverem, a proto nezaručuji správnost následujícího popisu.

Potřebné hlavičky

base64: 1
Authorization: Basic <TOKEN>

Protože API komunikuje ve formátu JSON, je při odesílání POST požadavku potřeba přidat:

Content-Type: application/json; charset=utf-8

Autorizační token

Je v klasickém Basic authorization formátu, akorát jsou údaje ještě před spojením zakódovány do base64. BASE64(BASE64(UZIVATELSKE_JMENO):BASE64(HESLO))

Formát odpovědí

API by mělo vždy vracet JSON objekt obsahující klíč Status a Data.
Příklad úspěšné odpovědi:

{
   "Status":{
      "Code":"OK",
      "Message":"",
      "Details":null
   },
   "Data":true
}

Příklad chybné odpovědi:

{
   "Status":{
      "Code":"UNAUTHORIZED",
      "Message":"Ověření uživatele se nezdařilo (neplatné přihlášení). Zadejte znovu přihlašovací údaje.",
      "Details":null
   },
   "Data":false
}

Přihlášení (ověření údajů)

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/AuthorizationStatus

Pokud byly odeslány validní přihlašovací údaje v Authorization hlavičce, viz výše, vrátí se Status Code "OK", jinak se vrátí Status Code "UNAUTHORIZED".

Informace o uživateli

POST https://aplikace.skolaonline.cz/SOLWebApi/api/v1/UzivatelInfo
Do obsahu POST se posílá base64 zakódované uživatelské jméno účtu.
Např. "dXppdmF0ZWw="

Data úspěšné odpovědi:

{
   "DATABASE_ID":"DB4",
   "ORGANIZACE_ID":"E123",
   "OSOBA_ID":"C1234567",
   "UZIVATEL_ID":"C123456",
   "UZIV_JMENO":"UzivJmeno",
   "KATEGORIE_ID_CSV":"KAT_STUDENT",
   "JMENO":"Uživatelské Jméno (1.A)",
   "TRIDA_ID":"E123456",
   "TRIDA_NAZEV":"1.A"
}

Období dne

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/ObdobiDne
datum=

Období roku

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/ObdobiRoku

Hodiny dne

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/RozvrhoveUdalosti/yyyy-mm-dd

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/RozvrhoveUdalosti/yyyy-mm-dd/<OSOBA_ID>

Hodiny z rozsahu dní

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/RozvrhoveUdalosti/yyyy-mm-dd/yyyy-mm-dd/<OSOBA_ID>

Detail hodiny

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/RozvrhoveUdalostiDetail/<HODINA_ID>/<ID>

Učitelé studenta

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/UciteleStudenta
studentID= pouzeTridniUcitelNeboZastupce=true

Kontakty na učitele

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/UciteleKontakty
studentID=

Garanti třídy

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/GarantiTridy
tridaID=
pouzeTridniUcitele=true
ucitelID=

Třídy

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/Tridy

Studenti třídy

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/StudentiTridy?tridaID=

Třída studenta

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/TridaStudenta
studdentID=

Hodnocení

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/HodnoceniStudentu[/Hodnoceni_ID]

Druhy hodnocení

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/DruhyHodnoceni

Stupnice hodnocení

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/StupniceHodnoceni

Hodnocení studenta

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/VypisHodnoceniStudent
studentID= datumOd= datumDo

Souhrn hodnocení studenta

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/HodnoceniStudentSuma
studentID=

Vysvědčení

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/Vysvedceni
studentID=

Předměty

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/Predmety

Důvody absence

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/DuvodyAbsence

Druhy výchovných opatření

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/DruhyVychovnychOpatreni

Výchovná opatření

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/VychovnaOpatreni
studentID=

Druhy poznámek do třídní knihy

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/DruhyPoznamkyDoTridniKnihy

Poznámky do třídní knihy

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/PoznamkyDoTridniKnihy

Parametry

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/Parametry

Zprávy

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/Zpravy
datumOdeslaniOd=

Přijaté zprávy

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/ZpravyPrijate
datumOdeslaniOd=

Celková absence

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/DochazkaAbsenceSuma

Detail události

GET https://aplikace.skolaonline.cz/SOLWebApi/api/v1/Udalosti/<UDALOST_ID>