Projekt

Obecné

Profil

Upravit Historie

Wiki »

Plán Hradu - API » Historie » Verze 4

Tomáš Zikmund, 2023-10-31 09:37

1 1 Tomáš Zikmund 
h1. Plán Hradu - API
2 





    3
    3
    Tomáš Zikmund
    
h3. Plán (výchozí stav) - API volání





    4
    1
    Tomáš Zikmund
    





    5
    3
    Tomáš Zikmund
    
* Výstup bude ve stejném stylu jako u vyhledávání - s agregací podle archivů, stránkováním a až 20 položkami na jednu stránku.





    6
    1
    Tomáš Zikmund
    





    7
    3
    Tomáš Zikmund
    
* Manuální přepnutí místnosti v roletce (Místnost) musí být propojeno s odpovídajícím patrem.





    8
    
    
    





    9
    1
    Tomáš Zikmund
    
* Zdrojové URL: http://147.228.173.159/plan





    10
    
    
    





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





    12
    1
    Tomáš Zikmund
    





    13
    4
    Tomáš Zikmund
    
        Kontrola autorizace uživatele:





    14
    
    
    
	await fetch("http://147.228.173.159/api/isauth/", {





    15
    
    
    
	"credentials": "include",





    16
    
    
    
	"headers": {},





    17
    
    
    
	"referrer": "http://147.228.173.159/plan",





    18
    
    
    
	"method": "GET",





    19
    
    
    
	"mode": "cors"





    20
    
    
    
	});





    21
    1
    Tomáš Zikmund
    





    22
    4
    Tomáš Zikmund
    
        Zajištění přístupu ke všem archivům inventáře (tj. 1595 Brussels až 2020 Prague):





    23
    
    
    
        await fetch("http://147.228.173.159/api/inventories", {





    24
    
    
    
	"credentials": "include",





    25
    
    
    
	"headers": {},





    26
    
    
    
	"referrer": "http://147.228.173.159/plan",





    27
    
    
    
	"method": "GET",





    28
    
    
    
	"mode": "cors"





    29
    
    
    
	});





    30
    1
    Tomáš Zikmund
    





    31
    
    
    





    32
    4
    Tomáš Zikmund
    
        Načtení místností (objektů) umístěných na plánku - defaultně first floor, vrací všechny místnosti





    33
    
    
    
	včetně souřadnic a umístění v svg grafice (ucelený seznam, včetně místností mimo defaultní patro)





    34
    
    
    
	Některé místnosti nejsou vizualizovány v plánu - atribut: in_plan -> false





    35
    
    
    
	Rozlišení daného patra: dle atributu: floor





    36
    
    
    
	--Objekt s id:200 se v plánku nevyskytuje (in_plan = false)





    37
    
    
    
	await fetch("http://147.228.173.159/api/plan/all", {





    38
    
    
    
	"credentials": "include",





    39
    
    
    
	"headers": {},





    40
    
    
    
	"referrer": "http://147.228.173.159/plan",





    41
    
    
    
	"method": "GET",





    42
    
    
    
	"mode": "cors"





    43
    
    
    
	});





    44
    3
    Tomáš Zikmund
    





    45
    4
    Tomáš Zikmund
    
	





    46
    
    
    
        Vykreslení SVG grafiky korespondujícího patra





    47
    
    
    
	--Žádoucí v mapě vykreslovat pouze objekty s odpovídající hodnotou atributu floor





    48
    
    
    
	Výchozí patro (first floor) - alternativně ground_floor, či second_floor:





    49
    
    
    
	await fetch("http://147.228.173.159/api/downloads/first_floor", {





    50
    
    
    
	"credentials": "include",





    51
    
    
    
	"headers": {},





    52
    
    
    
	"referrer": "http://147.228.173.159/plan",





    53
    
    
    
	"method": "GET",





    54
    
    
    
	"mode": "cors"





    55
    
    
    
	});





    56
    3
    Tomáš Zikmund
    





    57
    
    
    





    58
    4
    Tomáš Zikmund
    
        Seznam místností v rámci plánu - nacházející se v daném patře.





    59
    
    
    
	Pojí se s API call http://147.228.173.159/api/plan/all - provázání přes id





    60
    
    
    
	Přehled místností/komnat, namísto souřadnic a korespondujících podlaží MŮŽE obsahovat





    61
    
    
    
	pole zanořených objektů "Places" - pozice/umístění v dané komnatě





    62
    
    
    
	Opět se jedná o ucelený seznam všech komnat:





    63
    
    
    
	await fetch("http://147.228.173.159/api/plan/list", {





    64
    
    
    
	"credentials": "include",





    65
    
    
    
	"headers": {},





    66
    
    
    
	"referrer": "http://147.228.173.159/plan",





    67
    
    
    
	"method": "GET",





    68
    
    
    
	"mode": "cors"





    69
    
    
    
	});





    70
    1
    Tomáš Zikmund
    





    71
    3
    Tomáš Zikmund
    
	





    72
    4
    Tomáš Zikmund
    
        Výpis záložek (tab view) archivů, v nichž se nalezená/odpovídající díla nacházejí. Atribut data představuje pole, v nichž je uložen počet děl v daném archivu (např. kolik děl je v archivu 1648 Prague apod.)





    73
    
    
    
	(Zde není vypsáno nic)





    74
    
    
    
	await fetch("http://147.228.173.159/api/graph?activeTab=0&page=1&tabbed=true&room=0&cursor=0&items=20%27&group=inventory", {





    75
    3
    Tomáš Zikmund
    
    "credentials": "include",





    76
    
    
    
    "headers": {},





    77
    
    
    
    "referrer": "http://147.228.173.159/plan",





    78
    
    
    
    "method": "GET",





    79
    
    
    
    "mode": "cors"





    80
    4
    Tomáš Zikmund
    
	});





    81
    
    
    
	





    82
    
    
    
	





    83
    
    
    
        Výchozí předvolba výpisu položek - Room/Place/Cursor=0





    84
    
    
    
	(Není zvolena žádná místnost)





    85
    
    
    
	Na jednu stránku výpis až 20 položek





    86
    
    
    
	Možnost agregace výsledků v URL přes zahrnutí atributu inventory (vynecháním se zobrazí kompletní seznam) - &inventory=1621_Prague_A





    87
    
    
    
	(Zde není vypsáno nic)





    88
    
    
    
	await





    89
    
    
    
	fetch("http://147.228.173.159/api/search_v2?activeTab=0&page=1&tabbed=true&room=0&cursor=0&items=20", {





    90
    
    
    
	"credentials": "include",





    91
    
    
    
	"headers": {},





    92
    
    
    
	"referrer": "http://147.228.173.159/plan",





    93
    
    
    
	"method": "GET",





    94
    
    
    
	"mode": "cors"





    95
    
    
    
	});





    96
    
    
    
	





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





    98
    3
    Tomáš Zikmund
    





    99
    4
    Tomáš Zikmund
    
	Vybrání komnaty 9 ("Spanish Hall (today Rudolf Gallery") a pozice 1 ("on the floor"). (komnata = room; pozice = place)





    100
    
    
    
	Zvolen archiv 1621 Prague A, place 1 ("on the floor"), druhá stránka seznamu:	





    101
    
    
    
	await





    102
    
    
    
	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", {





    103
    
    
    
	"credentials": "include",





    104
    
    
    
	"headers": {},





    105
    
    
    
	"referrer": "http://147.228.173.159/plan",





    106
    
    
    
	"method": "GET",





    107
    
    
    
	"mode": "cors"





    108
    
    
    
	});





    109
    
    
    
	





    110
    
    
    
	





    111
    
    
    
	Výpis záložek (tab view) archivů, v nichž se nalezená/odpovídající díla nacházejí. Atribut data představuje pole, v nichž je uložen počet děl v daném archivu (např. kolik děl je v archivu 1648 Prague apod.)





    112
    
    
    
	Vypis archivů: 1621 Prague A, 1621 Prague B, 1635 Prague, data: 24, 24, 15 (vše počty položek)





    113
    
    
    
	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", {





    114
    1
    Tomáš Zikmund
    
    "credentials": "include",





    115
    3
    Tomáš Zikmund
    
    "headers": {},





    116
    1
    Tomáš Zikmund
    
    "referrer": "http://147.228.173.159/plan",





    117
    3
    Tomáš Zikmund
    
    "method": "GET",





    118
    
    
    
    "mode": "cors"





    119
    4
    Tomáš Zikmund
    
	});





    120
    
    
    
	





    121
    
    
    
	





    122
    
    
    
	Možnost přesměrování na detail položky (Item view - zde obraz PrgA-1253) - viz níže:





    123
    
    
    
	await fetch("http://147.228.173.159/api/concordances/PrgA-1253", {





    124
    
    
    
	"credentials": "include",





    125
    
    
    
	"headers": {},





    126
    
    
    
	"referrer": "http://147.228.173.159/item/PrgA-1253",





    127
    
    
    
	"method": "GET",





    128
    
    
    
	"mode": "cors"





    129
    
    
    
	});





    130
    1
    Tomáš Zikmund
    





    131
    
    
    





    132
    
    
    
Při výpisu aktuální komnaty a místa (room + places) se u objektu místnosti zobrazuje identifikátor místnosti a hodnota atributu "label".





    133
    
    
    
Následují POUZE hodnoty atributu "label" objektu "places", identifikátor se neuvádí.