|
1 ################ |
|
2 URL d'API HDALAB |
|
3 ################ |
|
4 |
|
5 Ces URL n'ont pas de sortie HTML. Elle sont utilisée en particulier par les composants javascript HDALab. |
|
6 |
|
7 Recherche fulltext dans les fiches |
|
8 ================================== |
|
9 |
|
10 Ce point d'API est utilisé pour faire des recherches fulltext dans les fiches. |
|
11 Il est utilisé aux endroits suivants: |
|
12 |
|
13 - :ref:`pages_recherche_facette` |
|
14 |
|
15 +----------+---------------------------------------------------------+ |
|
16 | url | http://hdalab.iri-research.org/hdalab/hdabo/searchajax/ | |
|
17 +----------+---------------------------------------------------------+ |
|
18 | view | :class:`hdabo.views.SearchDatasheet` | |
|
19 +----------+---------------------------------------------------------+ |
|
20 |
|
21 .. autoclass:: hdabo.views.SearchDatasheet |
|
22 :noindex: |
|
23 |
|
24 |
|
25 |
|
26 Recherche dans les catégories Wikipedia |
|
27 ======================================= |
|
28 |
|
29 Ce point d'API est utilisé pour faire des recherches dans les catégories Wikipedia. |
|
30 Il est utilisé aux endroits suivants: |
|
31 |
|
32 - :ref:`pages_explorer_domaines_artistiques` |
|
33 |
|
34 +----------+---------------------------------------------------+ |
|
35 | url | http://hdalab.iri-research.org/hdalab/a/catsearch | |
|
36 +----------+---------------------------------------------------+ |
|
37 | view | :func:`hdalab.views.ajax.catsearch` | |
|
38 +----------+---------------------------------------------------+ |
|
39 |
|
40 .. autofunction:: hdalab.views.ajax.catsearch |
|
41 :noindex: |
|
42 |
|
43 |
|
44 .. _api_arbre_categories: |
|
45 |
|
46 Arbre de catégories |
|
47 =================== |
|
48 |
|
49 Ce point d'API est utilisé pour construire un arbre de catégorie Wikipedia à partir d'un label. |
|
50 Il est utilisé aux endroits suivants: |
|
51 |
|
52 - :ref:`pages_explorer_domaines_artistiques` |
|
53 |
|
54 |
|
55 +----------+-------------------------------------------------+ |
|
56 | url | http://hdalab.iri-research.org/hdalab/a/cattree | |
|
57 +----------+-------------------------------------------------+ |
|
58 | view | :func:`hdalab.views.ajax.cattree` | |
|
59 +----------+-------------------------------------------------+ |
|
60 |
|
61 |
|
62 .. autofunction:: hdalab.views.ajax.cattree |
|
63 :noindex: |
|
64 |
|
65 |
|
66 Remplissage d'arbre |
|
67 =================== |
|
68 |
|
69 Ce point d'API est utilisé pour ajouter des fiches à un arbre de catégorie, comme par exemple produit par l'api :ref:`api_arbre_categories`. |
|
70 |
|
71 Il est utilisé dans les pages suivantes: |
|
72 |
|
73 - :ref:`pages_explorer_domaines_artistiques` |
|
74 - :ref:`pages_recherche_arbre` |
|
75 |
|
76 |
|
77 +----------+--------------------------------------------------+ |
|
78 | url | http://hdalab.iri-research.org/hdalab/a/filltree | |
|
79 +----------+--------------------------------------------------+ |
|
80 | view | :func:`hdalab.views.ajax.filltree` | |
|
81 +----------+--------------------------------------------------+ |
|
82 |
|
83 |
|
84 .. autofunction:: hdalab.views.ajax.filltree |
|
85 :noindex: |
|
86 |
|
87 |
|
88 Filtrage par facette |
|
89 ==================== |
|
90 |
|
91 Ce point d'API est utilisé pour réaliser le filtrage par facette des fiches HDA. |
|
92 Il est utilisé aux endroits suivants: |
|
93 |
|
94 - :ref:`pages_recherche_facette` |
|
95 |
|
96 |
|
97 +----------+------------------------------------------------+ |
|
98 | url | http://hdalab.iri-research.org/hdalab/a/filter | |
|
99 +----------+------------------------------------------------+ |
|
100 | view | :func:`hdalab.views.ajax.filter` | |
|
101 +----------+------------------------------------------------+ |
|
102 |
|
103 |
|
104 .. autofunction:: hdalab.views.ajax.filter |
|
105 :noindex: |
|
106 |
|
107 |
|
108 Recherche de tag |
|
109 ================ |
|
110 |
|
111 Ce point d'API est utilisé pour faire des recherche dans les tags. |
|
112 Il est utilisé aux endroits suivants: |
|
113 |
|
114 - :ref:`pages_recherche_facette` |
|
115 - :ref:`renkan_boite_recherche_contenus` |
|
116 |
|
117 +----------+----------------------------------------------------------+ |
|
118 | url | http://hdalab.iri-research.org/hdalab/a/tagsearch | |
|
119 +----------+----------------------------------------------------------+ |
|
120 | view | :func:`hdalab.views.ajax.tagsearch` | |
|
121 +----------+----------------------------------------------------------+ |
|
122 |
|
123 .. autofunction:: hdalab.views.ajax.tagsearch |
|
124 :noindex: |
|
125 |
|
126 |
|
127 login ajax |
|
128 ========== |
|
129 |
|
130 Ce point d'API permet la gestion de la connexion à partir d'un éditeur Renkan. |
|
131 Il est utilisé aux endroits suivants : |
|
132 |
|
133 - :ref:`pages_recherche_facette` |
|
134 |
|
135 |
|
136 +----------+---------------------------------------------------+ |
|
137 | url | http://hdalab.iri-research.org/hdalab/ajaxlogin/ | |
|
138 +----------+---------------------------------------------------+ |
|
139 | view | :func:`hdalab.views.profile.ajax_login` | |
|
140 +----------+---------------------------------------------------+ |
|
141 |
|
142 .. autofunction:: hdalab.views.profile.ajax_login |
|
143 :noindex: |
|
144 |
|
145 Chargement et sauvegarde de renkan |
|
146 ================================== |
|
147 |
|
148 Ce point d'API permet le chargement et la sauvegarde des renkan. Il est appelé par le client javascript renkan. |
|
149 |
|
150 Il est utilisé aux endroits suivants : |
|
151 |
|
152 - :ref:`pages_edition_renkan` |
|
153 - :ref:`affichage-d-un-renkan-en-lecture-seule` |
|
154 - :ref:`affichage-d-un-renkan-en-plein-ecran` |
|
155 |
|
156 |
|
157 +-----------+------------------------------------------------------+ |
|
158 | url | http://hdalab.iri-research.org/hdalab/renkan/getput/ | |
|
159 +-----------+------------------------------------------------------+ |
|
160 | view | :class:`hdalab.views.profile.HdalabRenkanGetPut` | |
|
161 +-----------+------------------------------------------------------+ |
|
162 | view GET | :meth:`hdalab.views.profile.HdalabRenkanGetPut.get` | |
|
163 +-----------+------------------------------------------------------+ |
|
164 | view POST | :meth:`hdalab.views.profile.HdalabRenkanGetPut.post` | |
|
165 +-----------+------------------------------------------------------+ |
|
166 |
|
167 A noter que l'appel de l'URL en GET ou POST mème à des vue différentes. |
|
168 |
|
169 |
|
170 Appel en HTTP GET: |
|
171 ------------------ |
|
172 |
|
173 .. automethod:: hdalab.views.profile.HdalabRenkanGetPut.get |
|
174 :noindex: |
|
175 |
|
176 Appel en HTTP POST: |
|
177 ------------------- |
|
178 |
|
179 .. automethod:: hdalab.views.profile.HdalabRenkanGetPut.post |
|
180 :noindex: |
|
181 |
|
182 |