Projekt

Obecné

Profil

Plán Hradu - API » Historie » Revize 3

Revize 2 (Tomáš Zikmund, 2023-10-15 16:20) → Revize 3/5 (Tomáš Zikmund, 2023-10-31 09:37)

h1. Plán Hradu - API 

 h3. Plán h2. Plan (výchozí stav) - API volání calls 

 * Výstup bude ve stejném Výpis výsledku v obdobném stylu jako u vyhledávání search - s agregací podle agregace dle archivů, stránkováním a stránkování, až 20 položkami itemů na jednu stránku. 

 * 1 stránku 
 Manuální přepnutí místnosti v roletce (Místnost) (Room) se musí být propojeno s odpovídajícím patrem. projevit i přepnutím koresponudujícího patra 

 * Zdrojové URL: http://147.228.173.159/plan 

 h4. Výchozí inicializace při otevření záložky Plánu: 

 //  

         Kontrola autorizace uživatele: 
 
	 await fetch("http://147.228.173.159/api/isauth/", { 
     
	 "credentials": "include", 
     
	 "headers": {}, 
     
	 "referrer": "http://147.228.173.159/plan", 
     
	 "method": "GET", 
     
	 "mode": "cors" 
 
	 }); 

 // 

         Zajištění přístupu ke všem archivům inventáře (tj. 1595 Brussels až 2020 Prague): 
 
         await fetch("http://147.228.173.159/api/inventories", { 
     
	 "credentials": "include", 
     
	 "headers": {}, 
     
	 "referrer": "http://147.228.173.159/plan", 
     
	 "method": "GET", 
     
	 "mode": "cors" 
 
	 }); 

 // 


         Načtení místností (objektů) umístěných na plánku - výchozí nastavení je první patro, defaultně first floor, vrací všechny místnosti 
	 včetně souřadnic a umístění v svg grafice (včetně (ucelený seznam, včetně místností mimo výchozí patro). 
 // defaultní patro) 
	 Některé místnosti nejsou vizualizovány na v plánu - atribut: in_plan -> false 
 // 
	 Rozlišení patra daného patra: dle atributu: floor 
 // Objekt 
	 --Objekt s id:200 se v plánku nevyskytuje (in_plan = false) 
 
	 await fetch("http://147.228.173.159/api/plan/all", { 
     
	 "credentials": "include", 
     
	 "headers": {}, 
     
	 "referrer": "http://147.228.173.159/plan", 
     
	 "method": "GET", 
     
	 "mode": "cors" 
 
	 }); 

 // 

	
         Vykreslení SVG grafiky odpovídajícího korespondujícího patra - 
	 --Žádoucí v mapě by se měly zobrazovat vykreslovat pouze objekty s odpovídající hodnotou atributu floor. 
 // floor 
	 Výchozí patro (první patro) (first floor) - alternativně přízemí nebo druhé patro: 
 ground_floor, či second_floor: 
	 await fetch("http://147.228.173.159/api/downloads/first_floor", { 
     
	 "credentials": "include", 
     
	 "headers": {}, 
     
	 "referrer": "http://147.228.173.159/plan", 
     
	 "method": "GET", 
     
	 "mode": "cors" 
 
	 }); 

 // 


         Seznam místností v rámci plánu nacházejících - nacházející se v daném patře. 
 // Spojuje 
	 Pojí se s API voláním call http://147.228.173.159/api/plan/all - provázání přes id 
 // 
	 Přehled místností/komnat, namísto souřadnic a odpovídajícího patra může korespondujících podlaží MŮŽE obsahovat 
	 pole zanořených objektů "Místa" "Places" - pozice/umístění v dané místnosti. 
 komnatě 
	 Opět se jedná o ucelený seznam všech komnat: 
	 await fetch("http://147.228.173.159/api/plan/list", { 
     
	 "credentials": "include", 
     
	 "headers": {}, 
     
	 "referrer": "http://147.228.173.159/plan", 
     
	 "method": "GET", 
     
	 "mode": "cors" 
 
	 }); 

 // 

	
         Výpis záložek (tab view) archivů, kde v nichž se nacházejí odpovídající položky. nalezená/odpovídající díla nacházejí. Atribut data obsahuje představuje pole, kde v nichž je uložen počet položek děl v daném archivu. 
 // archivu (např. kolik děl je v archivu 1648 Prague apod.) 
	 (Zde není vypsáno nic) 
 
	 await fetch("http://147.228.173.159/api/graph?activeTab=0&page=1&tabbed=true&room=0&cursor=0&items=20%27&group=inventory", { 
     "credentials": "include", 
     "headers": {}, 
     "referrer": "http://147.228.173.159/plan", 
     "method": "GET", 
     "mode": "cors" 
 
	 }); 

 // 
	
	
         Výchozí předvolba výpisu položek - Místnost/Místo/Cursor=0 
 // Room/Place/Cursor=0 
	 (Není zvolena žádná místnost) 
 // 
	 Na jednu stránku se vypisuje výpis až 20 položek 
 // 
	 Možnost agregace výsledků v URL pomocí přes zahrnutí atributu "inventory" (pokud je vynechán, inventory (vynecháním se zobrazí se kompletní seznam) - &inventory=1621_Prague_A 
 // 
	 (Zde není vypsáno nic) 
 
	 await 
	 fetch("http://147.228.173.159/api/search_v2?activeTab=0&page=1&tabbed=true&room=0&cursor=0&items=20", { 
     
	 "credentials": "include", 
     
	 "headers": {}, 
     
	 "referrer": "http://147.228.173.159/plan", 
     
	 "method": "GET", 
     
	 "mode": "cors" 
 
	 }); 

	
 
	
 h4.    Již vybraná místnost a poloha v místnosti: 

 // Vybraná komnata 

	 Vybrání komnaty 9 ("Spanish Hall (today Rudolf Gallery") a pozice 1 ("on the floor") floor"). (komnata = room; pozice = místo) 
 // place) 
	 Zvolen archiv 1621 Prague A, místo place 1 ("on the floor"), druhá stránka seznamu: 
 	
	 await 
	 fetch("http://147.228.173.159/api/search_v2?activeTab=0&page=2&tabbed=true&room=9&place=1&cursor=20&items=20&inventory=1621_Prague_A", { 
     
	 "credentials": "include", 
     
	 "headers": {}, 
     
	 "referrer": "http://147.228.173.159/plan", 
     
	 "method": "GET", 
     
	 "mode": "cors" 
 
	 }); 

 // 
	
	
	 Výpis záložek (tab view) archivů, kde v nichž se nacházejí odpovídající položky. nalezená/odpovídající díla nacházejí. Atribut data obsahuje představuje pole, kde v nichž je uložen počet položek děl v daném archivu (např. kolik děl je v archivu 1648 Prague atd.). 
 // Výpis apod.) 
	 Vypis archivů: 1621 Prague A, 1621 Prague B, 1635 Prague, data: 24, 24, 15 (všechny (vše počty položek): 
 položek) 
	 await fetch("http://147.228.173.159/api/graph?activeTab=0&page=1&tabbed=true&room=9&place=1&cursor=0&items=20%27&group=inventory", { 
     "credentials": "include", 
     "headers": {}, 
     "referrer": "http://147.228.173.159/plan", 
     "method": "GET", 
     "mode": "cors" 
 
	 }); 

 // 
	
	
	 Možnost přesměrování na detail položky (Zobrazení položky (Item view - zde obraz PrgA-1253) - viz níže: 
 
	 await fetch("http://147.228.173.159/api/concordances/PrgA-1253", { 
     
	 "credentials": "include", 
     
	 "headers": {}, 
     
	 "referrer": "http://147.228.173.159/item/PrgA-1253", 
     
	 "method": "GET", 
     
	 "mode": "cors" 
 
	 }); 


 

 Při výpisu vypisování aktuální komnaty a místa (room + places) se u objektu místnosti zobrazuje roomu vypisuje identifikátor místnosti pokoje a hodnota atributu "label". label. 
 Následují Následuje POUZE hodnoty atributu "label" hodnota atribut label objektu "places", places, identifikátor se neuvádí.