Changes for page REST API - Open Tritius
Last modified by Martin Mahr on 2024/10/21 22:20
From version 4.1
edited by Jan Šimeček
on 2024/08/02 11:23
on 2024/08/02 11:23
Change comment:
There is no comment for this version
To version 2.1
edited by Jan Šimeček
on 2024/08/02 09:05
on 2024/08/02 09:05
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,3 +1,197 @@ 1 += Přehled služeb = 2 + 1 1 [[https:~~/~~/swagger.tritius.cz/>>url:https://swagger.tritius.cz/]] 2 2 3 3 Základní URL adresa rozhraní je: [[https:~~/~~/tritius.knihovna.cz/tritius/api>>url:https://tritius.knihovna.cz/tritius/api]]. 6 + 7 +|=Metoda|=URL|=(% colspan="1" %)Název|=Popis 8 +|(% colspan="1" %)[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=GET&colour=Blue||height="18" width="88"]]((( 9 + 10 +)))|(% colspan="1" %) 11 + 12 +{{{/users}}}|(% colspan="1" %)[[Seznam uživatelů>>path:#RESTAPIOpenTritius-Seznamuživatelů]]|(% colspan="1" %)Načte seznam uživatelů systému. 13 +|(% colspan="1" %)((( 14 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=GET&colour=Blue||height="18" width="88"]] 15 +)))|(% colspan="1" %) 16 + 17 +{{{/users/:id}}}|(% colspan="1" %)[[Detail uživatele>>path:#RESTAPIOpenTritius-Detailuživatele]]|(% colspan="1" %)Načte informace o konkrétním uživateli. 18 +|(% colspan="1" %)((( 19 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=GET&colour=Blue||height="18" width="88"]] 20 +)))|(% colspan="1" %) 21 + 22 +{{{/users/identifier/:identifier}}}|(% colspan="1" %)[[Dohledání uživatele podle identifikátoru>>path:#RESTAPIOpenTritius-Dohledáníuživatelepodleidentifikátoru]]|(% colspan="1" %)Dohledá uživatele podle jeho identifikátoru (čárový kód průkazky, RFID čip apod.) 23 +|((( 24 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=GET&colour=Blue||height="18" width="88"]] 25 +)))| 26 + 27 +{{{/users/}}} 28 + 29 +{{{authenticate}}}|[[Autentizace uživatele>>path:#RESTAPIOpenTritius-Autentizaceuživatele]]|Ověří přihlášení uživatele. 30 +|(% colspan="1" %)((( 31 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=GET&colour=Blue||height="18" width="88"]] 32 +)))|(% colspan="1" %) 33 + 34 +{{{/users/logged-tritius-allowed}}}|(% colspan="1" %) |(% colspan="1" %)Vrátí seznam uživatelů s možností přihlášení do Tritia v dané knihovně. 35 +|(% colspan="1" %)((( 36 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?=&0=&colour=Green&title=POST||height="18" width="88"]] 37 +)))|(% colspan="1" %) 38 + 39 +{{{/users}}}|(% colspan="1" %)[[Nový uživatel>>path:#RESTAPIOpenTritius-Novýuživatel]]|(% colspan="1" %)Vytvoří nového uživatele 40 +|(% colspan="1" %)((( 41 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?=&0=&colour=Green&title=POST||height="18" width="88"]] 42 +)))|(% colspan="1" %) 43 + 44 +{{{/users/list-readers}}}|(% colspan="1" %) |(% colspan="1" %)Vrátí seznam čtenářů 45 +|(% colspan="1" %)((( 46 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=PATCH&colour=Yellow||height="18" width="88"]] 47 +)))|(% colspan="1" %) 48 + 49 +{{{/users/:id}}}|(% colspan="1" %)[[Úprava uživatele>>path:#RESTAPIOpenTritius-Úpravauživatele]]|(% colspan="1" %)Upraví konkrétního uživatele. 50 +|(% colspan="1" %)((( 51 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=DELETE&colour=Red||height="18" width="88"]] 52 +)))|(% colspan="1" %) 53 + 54 +{{{/users/:id}}}|(% colspan="1" %)[[Odstranění uživatele>>path:#RESTAPIOpenTritius-Odstraněníuživatele]]|(% colspan="1" %)Odstraní konkrétního uživatele. 55 +|(% colspan="1" %)((( 56 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=PUT||height="18" width="88"]] 57 +)))|(% colspan="1" %) 58 + 59 +{{{/users/:id/groups}}}|(% colspan="1" %)[[Přiřazení uživatelských skupin k uživateli>>path:#RESTAPIOpenTritius-Přiřazeníuživatelskýchskupinkuživateli]]|(% colspan="1" %)Přidání a odebrání uživatelských skupin danému uživateli. 60 +|(% colspan="1" %)((( 61 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=PUT||height="18" width="88"]] 62 +)))|(% colspan="1" %) 63 + 64 +{{{/users/:id/libraries}}}|(% colspan="1" %)[[Přiřazení knihoven k uživateli>>path:#RESTAPIOpenTritius-Přiřazeníknihovenkuživateli]]|(% colspan="1" %)Přidání a odebrání knihoven danému uživateli. 65 +|((( 66 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=PUT||height="18" width="88"]] 67 +)))| 68 + 69 +{{{/users/:id/move-to-archive}}}|[[Přesun do archivu>>path:#RESTAPIOpenTritius-Přesundoarchivu]]|Přesune daného uživatele do archivu. 70 +|((( 71 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=PUT||height="18" width="88"]] 72 +)))| 73 + 74 +{{{/users/:id/move-from-archive}}}|(% colspan="1" %)[[Přesun z archivu>>path:#RESTAPIOpenTritius-Přesunzarchivu]]|Přesune daného uživatele z archivu. 75 +|(% colspan="1" %)((( 76 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=GET&colour=Blue||height="18" width="88"]] 77 +)))|(% colspan="1" %) 78 + 79 +{{{/users/:id/borrows-count}}}|(% colspan="1" %)[[Aktuální počet výpůjček>>path:#RESTAPIOpenTritius-Aktuálnípočetvýpůjček]]|(% colspan="1" %)Vrací počet aktuálních výpůjček uživatele. 80 +|(% colspan="1" %)((( 81 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=GET&colour=Blue||height="18" width="88"]] 82 +)))|(% colspan="1" %) 83 + 84 +{{{/user/has-right}}}|(% colspan="1" %)[[Kontrola přiděleného práva>>path:#RESTAPIOpenTritius-user-has-right]]|(% colspan="1" %)Kontrola přiděleného práva čtenáři. 85 +|(% colspan="1" %)((( 86 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=GET&colour=Blue||height="18" width="88"]] 87 +)))|(% colspan="1" %) 88 + 89 +{{{/news/isxn/:searchAreaId?days=:days&limit=:limit}}}|(% colspan="1" %)[[Výpis ISXN novinek>>path:#RESTAPIOpenTritius-VýpisISXNnovinek]]|(% colspan="1" %)Vrací seznam ISXN pro danou prohledávanou oblast. 90 +|(% colspan="1" %)((( 91 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=GET&colour=Blue||height="18" width="88"]] 92 +)))|(% colspan="1" %) 93 + 94 +{{{/items/identifier/:identifier}}}|(% colspan="1" %)[[Dohledání podle identifikátoru>>path:#RESTAPIOpenTritius-Dohledánípodleidentifikátoru]]|(% colspan="1" %)Dohledá svazek podle jeho identifikátoru. 95 +|(% colspan="1" %)((( 96 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=GET&colour=Blue||height="18" width="88"]] 97 +)))|(% colspan="1" %) 98 + 99 +{{{/items/:identifierType/:identifier}}}|(% colspan="1" %)[[Informace o svazcích>>path:#RESTAPIOpenTritius-Informaceosvazcích]]|(% colspan="1" %)Informace o svazku. 100 +|(% colspan="1" %)((( 101 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=GET&colour=Blue||height="18" width="88"]] 102 +)))|(% colspan="1" %) 103 + 104 +{{{/items/search-by-property/:propertyName/:value/:offset/:limit}}}|(% colspan="1" %)[[Vyhledávání svazků a vrácení informací o svazcích>>path:#RESTAPIOpenTritius-Vyhledávánísvazkůavráceníinformacíosvazcích]]|(% colspan="1" %)Vyhledá svazky a vrátí informace o nich. 105 +|(% colspan="1" %)((( 106 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=PATCH&colour=Yellow||height="18" width="88"]] 107 +)))|(% colspan="1" %) 108 + 109 +{{{/items/:identifierType/:identifier}}}|(% colspan="1" %)[[Aktualizace hodnot ve svazku>>path:#RESTAPIOpenTritius-Aktualizacehodnotvesvazku]]|(% colspan="1" %)Aktualizace hodnot ve svazku. 110 +|(% colspan="1" %)((( 111 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=GET&colour=Blue||height="18" width="88"]] 112 +)))|(% colspan="1" %) 113 + 114 +{{{/borrowings}}}|(% colspan="1" %)[[Informace o výpůjčkách čtenáře>>path:#RESTAPIOpenTritius-Informaceovýpůjčkáchčtenáře]]|(% colspan="1" %)Informace o výpůjčkách. 115 +|((( 116 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=GET&colour=Blue||height="18" width="88"]] 117 +)))| 118 + 119 +{{{/system_version}}}|[[Verze Tritia a VM>>path:#RESTAPIOpenTritius-VerzeTritiaaVM]]|Verze Tritia a VM. 120 +|(% colspan="1" %)((( 121 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?=&0=&colour=Green&title=POST||height="18" width="88"]] 122 +)))|(% colspan="1" %) 123 + 124 +{{{/sql}}}|(% colspan="1" %)[[Spuštění SQL dotazu>>path:#RESTAPIOpenTritius-SpuštěníSQLdotazu]]|(% colspan="1" %)Spuštění SQL dotazu nad DB Tritia. 125 +|(% colspan="1" %)((( 126 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=GET&colour=Blue||height="18" width="88"]] 127 +)))|(% colspan="1" %) 128 + 129 +{{{/system/import-mode}}}|(% colspan="1" %)[[Seznam knihoven v importním módu>>path:#RESTAPIOpenTritius-Seznamknihovenvimportnímmódu]]|(% colspan="1" %)Seznam knihoven v importním módu. 130 +|(% colspan="1" %)((( 131 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=GET&colour=Blue||height="18" width="88"]] 132 +)))|(% colspan="1" %) 133 + 134 +{{{/department}}}|(% colspan="1" %) |(% colspan="1" %)Výpis oddělení v dané knihovně. 135 +|(% colspan="1" %)((( 136 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?=&0=&colour=Green&title=POST||height="18" width="88"]] 137 +)))|(% colspan="1" %) 138 + 139 +{{{/department/load-department-info}}}|(% colspan="1" %)[[Informace o oddělení>>path:#RESTAPIOpenTritius-Info-o-oddeleni]]|(% colspan="1" %)Informace o jednom oddělení 140 +|(% colspan="1" %)((( 141 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?=&0=&colour=Green&title=POST||height="18" width="88"]] 142 +)))|(% colspan="1" %) 143 + 144 +{{{/device}}}|(% colspan="1" %) |(% colspan="1" %)Vytvoří zařízení. 145 +|(% colspan="1" %)((( 146 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?=&0=&colour=Green&title=POST||height="18" width="88"]] 147 +)))|(% colspan="1" %) 148 + 149 +{{{/device/list}}}|(% colspan="1" %) |(% colspan="1" %)Vrátí seznam zařízení v dané knihovně. 150 +|(% colspan="1" %)((( 151 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=PATCH&colour=Yellow||height="18" width="88"]] 152 +)))|(% colspan="1" %) 153 + 154 +{{{/device-setting}}}|(% colspan="1" %) |(% colspan="1" %)Zajistí existenci nastavení pro dané zařízení. 155 +|(% colspan="1" %)((( 156 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=GET&colour=Blue||height="18" width="88"]] 157 +)))|(% colspan="1" %) 158 + 159 +{{{/library}}}|(% colspan="1" %) |(% colspan="1" %)Načtení seznamu knihoven. 160 +|(% colspan="1" %)((( 161 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?=&0=&colour=Green&title=POST||height="18" width="88"]] 162 +)))|(% colspan="1" %) 163 + 164 +{{{/library/load-library-info}}}|(% colspan="1" %)[[Informace o knihovně>>path:#RESTAPIOpenTritius-info-o-knihovne]]|(% colspan="1" %)Informace o jedné knihovně 165 +|(% colspan="1" %)((( 166 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?=&0=&colour=Green&title=POST||height="18" width="88"]] 167 +)))|(% colspan="1" %) 168 + 169 +{{{/settings/filter}}}|(% colspan="1" %) |(% colspan="1" %)Vrátí seznam požadovaných nastavení. 170 +|(% colspan="1" %)((( 171 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=GET&colour=Blue||height="18" width="88"]] 172 +)))|(% colspan="1" %) 173 + 174 +{{{/settings/load-setting-value}}}|(% colspan="1" %)[[Načtení hodnoty nastavení>>path:#RESTAPIOpenTritius-settings-load-setting-value]]|(% colspan="1" %)Načítá hodnotu položky nastavení pro daného uživatele a případě i zařízení. 175 +|(% colspan="1" %)((( 176 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?=&0=&colour=Green&title=POST||height="18" width="88"]] 177 +)))|(% colspan="1" %) 178 + 179 +{{{/web-definition}}}|(% colspan="1" %) |(% colspan="1" %)Vrátí seznam webových definic. 180 +|(% colspan="1" %)((( 181 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?=&0=&colour=Green&title=POST||height="18" width="88"]] 182 +)))|(% colspan="1" %) 183 + 184 +{{{/renew/borrowing}}}|(% colspan="1" %) |(% colspan="1" %)Prodloužení jedné výpůjčky čtenáře. 185 +|(% colspan="1" %)((( 186 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?title=GET&colour=Blue||height="18" width="88"]] 187 +)))|(% colspan="1" %) 188 + 189 +{{{/public/tritiusdesktop/version}}}|(% colspan="1" %)[[TritiusDesktop - verze>>path:#RESTAPIOpenTritius-tritiusDesktop-verze]]|(% colspan="1" %)Podporovaná verze TritiusDesktop. 190 +|(% colspan="1" %)((( 191 +[[image:https://confluence.tritius.cz/plugins/servlet/status-macro/placeholder?=&0=&colour=Green&title=POST||height="18" width="88"]] 192 +)))|(% colspan="1" %) 193 + 194 +{{{/offline_borrow_protocol/borrow}}}|(% colspan="1" %)[[Offline výpůjčák - půjčování>>path:#RESTAPIOpenTritius-offline-borrow-protocol-borrow]]|(% colspan="1" %)Offline výpůjčák - půjčení svazku. 195 +|(% colspan="1" %) |(% colspan="1" %) |(% colspan="1" %) |(% colspan="1" %) 196 + 197 +