Abstrakt

W celu umożliwienia kontaktu między eKontaktem a innymi systemami Politechniki Gdańskiej (udostępnianymi przez wspólny system eUczelnia) stworzony został system interfejsów działających poprzez zapytania HTTP, które umożliwiają dostęp do części zasobów takich jak:

Wymiana danych z systemem eUczelnia odbywa się przez zapytania w postaci XML-RPC.

System udostępnia szereg funkcji, które mogą być wykonane:

Wszystkie te metody wykorzystują szereg obiektów pomocniczych, które umożliwiają przekazanie szczegółowych danych dotyczących zapytania takich jak:

Rodzaj danych jakie zostaną zwrócone definiujemy poprzez wybranie w zapytaniu odpowiedniego modelu danych. Modele odzwierciedlają istniejące obiekty w systemie eUczelnia:

Aby nie przeciążać bazy danych, wszystkie pola, które wymagają skomplikowanych zapytań bazodanowych zostały oznaczone jako reference. Domyślnie atrybuty typu reference nie będą występować w zwracanych obiektach. Aby atrybut typu reference był zwrócony poprzez API, musi zostać to zaznaczone w zapytaniu. Przykłady wykorzystania tego mechanizmu można znaleźć w przypadkach użycia na końcu tego opisu. Wyjaśnienie oznaczeń przy opisywaniu obiektów i modeli:

int liczba całkowita
float liczba zmiennoprzecinkowa (możliwe, że będzie to również liczba stałoprzecinkowa w przyszłości)
string łańcuch znaków, sformatowany zgodnie ze standardem HTML o długości nie przekraczającej 250 znaków
text łańcuch znaków, sformatowany zgodnie ze standardem HTML o dowolnej długości
boolean wartość true/false
reference w zależności od sposoby pobierania modelu: tablica identyfikatorów lub obiektów powiązanych. Domyślnie obiekty typu reference nie są zwracane przez system.
date data w formacie iso
? typ danej lub nazwa nie zostały jeszcze ustalone