Usermap API

Changes for document Usermap API

Last modified by Jakub Jirůtka on 2015-03-13, 17:50
From version 3.1
edited by Jakub Jirůtka
on 2015-03-01, 18:05
To version 4.1
edited by Jakub Jirůtka
on 2015-03-13, 17:50
Change comment: přidány informace k předmětovým rolím

Content changes

... ... @@ -2,7 +2,7 @@
2 2
3 3 ## Primární datové zdroje
4 4
5 -Primárním zdrojem dat je Usermap (SSU), konkr. Usermap LDAP, jeho relační přívěšek EXT_UMAP a ještě webové rozhraní (fotky). Více informací o datové doméně Usermap najdete na [této stránce](https://rozvoj.fit.cvut.cz/Main/usermap-db). Dále se synchronizuje s fakultním IDM FIT, odkud se přebírají další fakultní role osob a identity externistů.
5 +Primárním zdrojem dat je Usermap (SSU), konkr. Usermap LDAP, jeho relační přívěšek EXT_UMAP a KOS (pro předmětové role). Více informací o datové doméně Usermap najdete na [této stránce](https://rozvoj.fit.cvut.cz/Main/usermap-db). Dále se synchronizuje s fakultním IDM FIT, odkud se přebírají další fakultní role osob a identity externistů.
6 6
7 7 ## RESTful API
8 8
... ... @@ -13,6 +13,43 @@
13 13 API je zabezpečeno protokolem OAuth 2.0 a využívá [fakultní autorizační server](oauth2).
14 14
15 15
16 +## Poskytované role
17 +
18 +Usermap API zprostředkovává všechny tzv. [celoškolské business role](https://rozvoj.fit.cvut.cz/Main/role-v-idm-cvut) a naše fakultně specifické business i technické role z fakultního IDM. Dále poskytuje tzv. předmětové role (vztah osoby k vyučovanému předmětu), které generuje z KOSu.
19 +
20 +### Předmětové role
21 +
22 +Předmětové role mají obdobnou strukturu jako [business role](role-v-idm-cvut), ale místo organizační jednotky se váží na konkrétní předmět (podle jeho kódu). Kód předmětu je v rámci ČVUT unikátní.
23 +
24 +```plain
25 +P-MI-W20-UCITEL-PREDNASEJICI
26 +| \____/ \_________________/
27 +| | |
28 +| | +---------- název role
29 +| +----------------------- kód předmětu
30 ++--------------------------- typ role předmětová
31 +```
32 +
33 +| Název role | Český popis | Anglický popis |
34 +|---------------------------|------------------------------|-------------------------------------|
35 +| STUDENT | student předmětu | student of the course |
36 +| UCITEL | učitel předmětu | teacher of the course |
37 +| UCITEL-CVICICI | cvičící předmětu | instructor of the course |
38 +| UCITEL-CVICICI-LABORATORE | laboratorní cvičící předmětu | laboratory instructor of the course |
39 +| UCITEL-EDITOR * | editor předmětu | editor of the course |
40 +| UCITEL-GARANT | garant předmětu | guarantor of the course |
41 +| UCITEL-PREDNASEJICI | přednášející předmětu | lecturer of the course |
42 +| UCITEL-ZKOUSEJICI | zkoušející předmětu | examiner of the course |
43 +
44 +_\* Role _editor_ (v KOSu se jmenuje AUTORNAV) zmocňuje daného vyučujícího editovat informace o předmětu._
45 +
46 +Některé předměty jsou ve vztahu rozvrhovaný (nadřízený) a zapisovaný (podřízený). Týká se to typicky tělocviků a jazyků. Rozvrhovaný předmět je jakýsi metapředmět, který sdružuje různé „instance“ téhož předmětu, typicky na různých fakultách. Studenti se zapisují na zapisované (podřízené) předměty a zkoušky, ale vyučující je všechny vidí v rámci rozvrhovaného (nadřízeného) předmětu. V těchto případech se generují role pouze pro rozvrhované předměty, ale v atributu role `courses` jsou uvedeny kódy všech předmětů, kterých se týká, tedy rozvrhovaného i příp. zapisovaných.
47 +
48 +Předmětová role pro učitele vzniká v momentně, kdy mají rozvrháři připravený rozvrh pro příští semestr; typicky 1–2 týdny před závaznými zápisy předmětů (viz [harmonogram semestru](https://kosapi.fit.cvut.cz/projects/kosapi/wiki/Harmonogram_semestru)). Zaniká pak s koncem semestru (tj. koncem zkouškového období daného semestru).
49 +
50 +Kdy má vznikat studentská role ještě není dořešeno, momentálně vzniká se začátkem semestru a zaniká s jeho koncem.
51 +
52 +
16 16 ## Příklady
17 17
18 18 ### Dotazy přes curl
... ... @@ -54,11 +54,11 @@
54 54 'https://kosapi.fit.cvut.cz/usermap/v1/people?query=emails==kevin.flynn@fit.cvut.cz'
55 55 ```sh
56 56
57 -6. Najít uživatele, jejichž jméno/příjmení začíná na Eli Šes a studují na FIT:
94 +6. Najít uživatele, jejichž jméno/příjmení začíná na Pav Kor a pracují na FIT:
58 58
59 59 ```sh
60 60 curl -s -H 'Authorization: Bearer TOKEN' -H 'Accept: application/json' \
61 - -G 'https://kosapi.fit.cvut.cz/usermap/v1/people' --data-urlencode 'query=name=="Eli Šes";roles==B-18000-STUDENT'
98 + -G 'https://kosapi.fit.cvut.cz/usermap/v1/people' --data-urlencode 'query=name=="Pav Kor";roles==B-18000-ZAMESTNANEC'
62 62 ```
63 63 #[warning](curl špatně enkóduje některé znaky v URI, tady uvozovky a mezera, proto je nutné předat query string přes `--data-urlencode`.)
64 64

My Recent Modifications


This wiki is licensed under a Creative Commons BY-SA 3.0 license
XWiki Enterprise 5.4.1 - Documentation