Mój plan myplan
Zapytanie zwraca w formacie JSON kolekcję z listą wiadomości, komunikatów oraz powiadomień dla danej osoby.
URL
https://isod.ee.pw.edu.pl/isod-portal/wapi?q=mynewsheaders&username=?&apikey=?&semester=?&from=?&to=?&hash=?
https://isod.ee.pw.edu.pl/isod-portal/wapi?q=mynewsfull&username=?&apikey=?&semester=?&from=?&to=?&hash=?
https://isod.ee.pw.edu.pl/isod-portal/wapi?q=mynewsfingerprint&username=?&apikey=?&semester=?
https://isod.ee.pw.edu.pl/isod-portal/wapi?q=mynews&...
https://isod.ee.pw.edu.pl/isod-portal/wapi?q=mynewsfingerprint&tokenslist=[username1=apikey1|username2=apikey2]
Metody
GET
URL Params
Wymagane:
q=mynews[full|headers|fingerprint]
- rodzaj zapytania kierowanego do WAPI - musi być równe mynews
z dodatkiemm specyfikatora,
username=[napis]
- nazwa użytkownika ISOD (login),
apikey=[napis]
- klucz identyfikacyjny API, który można wygenerować na stronie z danymi osobowymi w ISOD.
Opcjonalne:
semester=[napis]
- akronim semestru akademickiego, dla którego wyświetlane są wiadomości.
from=[liczba]
- zmienna używana do stronicowania wyników (pierwszy komunikat to 0, aby pobrać tylko jeden należy podać from=0&to=1)
to=[liczba]
- zmienna używana do stronicowania wyników (ostatni komunikat to (liczba wiadomości - 1), aby pobrać ostani nalezy podać: from=liczba wiadomosci - 1&toliczba wiadomosci)
hash=[napis]
- identyfikator pojedynczej wiadomości do pobrania (można używać w połączeniu z headers)
tokenslist=[username1=apikey1|username2=apikey2]
- rozdzielane znakiem pionwej kreski pary użytkownik i jego klucz do pobierania listy fingerprintów, zamiast pojedynczo, działa tylko w endpoincie mynewsfingerprint (wtedy username i apikey jest opcjonalne)
Zawartość pola type
`1000` - ogłoszenie
`1001` - sprawdzian
`1002` - important
`1003` - stan projektu
`1004` - zmiana grupy projektu
`1005` - zapisy na zajecia
Odpowiedź pozytywna
- Kod: 200
Zawartość (JSON) Zawartość dla zapytania dotyczacego 'mynewsheaders'
{
"items":[
{
"hash": "NEWS_AKJD7897sjljoisJSIo",
"subject":"fdsfadsf hhhhhh",
"modifiedDate":"9.04.2018 13:21",
"modifiedBy":"dr inż. Robert Szmurło",
"type":"1000",
"attachments":[
],
"noAttachments":0
},
{
"hash": "NEWS_khifha789fdfjsdijfldsk",
"subject":"Kim Fowler na Wydziale Elektrycznym PW",
"modifiedDate":"16.05.2013 17:33",
"modifiedBy":"dr inż. Jacek Korytkowski",
"attachments":[
],
"noAttachments":2
}
],
"username":"szmurlor",
"apikey":"AKUKU",
"semester":"2014Z",
"firstname":"Robert",
"lastname":"Szmurło",
"title":"dr inż.",
"usosId":"00001"
}
- Kod: 200
Zawartość (JSON) Zawartość dla zapytania dotyczacego 'mynewsfingerprint'
{"generated":"9.04.2018 13:21","fingerprint":"OfkverYX5nO8c5vTc0gJkA"}
- Kod: 200
Zawartość (JSON) Zawartość dla zapytania dotyczacego 'mynewsfull'
{
"items":[
{
"hash": "NEWS_Ioidjfiodjsfd87f9ds8fuosdij",
"subject":"fdsfadsf hhhhhh",
"content":"\u003cp\u003edfadsfadsfdsg er ggrt gdfg\u003cbr /\u003esfd\u003c/p\u003e\r\u003cp\u003e\u0026nbsp;gsd\u003c/p\u003e\r\u003cp\u003ef g\u003c/p\u003e\r\u003cp\u003esdfa\u003c/p\u003e\r\u003cp\u003e\u0026nbsp;gsdf\u003c/p\u003e\r\u003cp\u003e\u0026nbsp;g\u003c/p\u003e\r\u003cp\u003esdf\u0026nbsp;\u003c/p\u003e",
"type":"1000",
"modifiedDate":"9.04.2018 13:21",
"modifiedBy":"dr inż. Robert Szmurło",
"attachments":[
],
"noAttachments":0
},
{
"hash": "COURSGRA_ihdoif7d89fodasjfiadj",
"subject":"Raport Dziekana ws oceny efektów kształcenia",
"content":"\u003cp\u003eSzanowni Państwo,\u003c/p\u003e\r\u003cp\u003eKonieczność przygotowania Raportu ws oceny efekt\u0026oacute;w kształcenia wynika z Rozporządzenia MNiSW z dn. 05.10.2011 r. w sprawie warunk\u0026oacute;w prowadzenia studi\u0026oacute;w na określonym kierunku i poziomie kształcenia.\u003c/p\u003e\r\u003cp\u003eZgodnie z zapisam w Rozprządzeniu Dziekan przedkłada Raport Radzie Wydziału.\u003c/p\u003e\r\u003cp\u003eW załączeniu Raport wraz z dodatkowymi dokumentami, w tym formularz opinii na temat efekt\u0026oacute;w kształcenia.\u003c/p\u003e\r\u003cp\u003eOpinia powinna być wyrażona przez nauczycieli akademickich zaliczonych do minimum kadrowego określonego kierunku studi\u0026oacute;w.\u003c/p\u003e\r\u003cp\u003ePrzypominam, że dokumenty zawierające opis kierunkowych efekt\u0026oacute;w kształcenia oraz stosowne Rozporządznia MNiSW i Uchwały Senatu PW są dostępne dla wszystkich użytkownik\u0026oacute;w w Portalu informacyjnym w zakładce Dokumenty do pobrania.\u003c/p\u003e\r\u003cp\u003e\u0026nbsp;\u003c/p\u003e\r\u003cp\u003eTomasz Winek\u003c/p\u003e",
"type":"1000",
"modifiedDate":"18.11.2014 20:45",
"modifiedBy":"doc. dr inż. Tomasz Winek",
"attachments":[
{
"filename":"EK_AIR_1st.pdf",
"size":71644,
"linkToDownload":"nie można pobierać plików przez API"
},
{
"filename":"EK_AIR_2st.pdf",
"size":73921,
"linkToDownload":"nie można pobierać plików przez API"
}
],
"noAttachments":2
}
],
"username":"szmurlor",
"apikey":"CHANGE_ME",
"semester":"2014Z",
"firstname":"Robert",
"lastname":"Szmurło",
"title":"dr inż."
}
Komunikat błędu
-
Kod: 400
Błędy zwracane są za pomocą komunikatu tekstowego zamkniętego w obiekt JSON, z atrybutem
message
np.:
{"message":"Brak wymaganego argumentu dotyczącego semestru akademickiego. Oczekiwałem na przykład: ?sem=2010Z"}
Przykładowe zapytanie
http://isod.ee.pw.edu.pl/isod-portal/wapi?q=mynewsfull&username=szmurlor&apikey=CHANGE_ME&hash=AKUKU_jakishash
Uwagi
Brak.