################
URL d'API HDALAB
################

Ces URL n'ont pas de sortie HTML. Elle sont utilisée en particulier par les composants javascript HDALab.

Recherche fulltext dans les fiches
==================================

Ce point d'API est utilisé pour faire des recherches fulltext dans les fiches.
Il est utilisé aux endroits suivants:

    - :ref:`pages_recherche_facette`

+----------+---------------------------------------------------------+
| url      | http://hdalab.iri-research.org/hdalab/hdabo/searchajax/ |
+----------+---------------------------------------------------------+
| view     | :class:`hdabo.views.SearchDatasheet`                    |
+----------+---------------------------------------------------------+

.. autoclass:: hdabo.views.SearchDatasheet
  :noindex:



Recherche dans les catégories Wikipedia
=======================================

Ce point d'API est utilisé pour faire des recherches dans les catégories Wikipedia.
Il est utilisé aux endroits suivants:

    - :ref:`pages_explorer_domaines_artistiques`

+----------+---------------------------------------------------+
| url      | http://hdalab.iri-research.org/hdalab/a/catsearch |
+----------+---------------------------------------------------+
| view     | :func:`hdalab.views.ajax.catsearch`               |
+----------+---------------------------------------------------+

.. autofunction:: hdalab.views.ajax.catsearch
  :noindex:


.. _api_arbre_categories:

Arbre de catégories
===================

Ce point d'API est utilisé pour construire un arbre de catégorie Wikipedia à partir d'un label.
Il est utilisé aux endroits suivants:

    - :ref:`pages_explorer_domaines_artistiques`


+----------+-------------------------------------------------+
| url      | http://hdalab.iri-research.org/hdalab/a/cattree |
+----------+-------------------------------------------------+
| view     | :func:`hdalab.views.ajax.cattree`               |
+----------+-------------------------------------------------+


.. autofunction:: hdalab.views.ajax.cattree
  :noindex:


Remplissage d'arbre
===================

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`.

Il est utilisé dans les pages suivantes:

    - :ref:`pages_explorer_domaines_artistiques`
    - :ref:`pages_recherche_arbre`


+----------+--------------------------------------------------+
| url      | http://hdalab.iri-research.org/hdalab/a/filltree |
+----------+--------------------------------------------------+
| view     | :func:`hdalab.views.ajax.filltree`               |
+----------+--------------------------------------------------+


.. autofunction:: hdalab.views.ajax.filltree
  :noindex:


Filtrage par facette
====================

Ce point d'API est utilisé pour réaliser le filtrage par facette des fiches HDA.
Il est utilisé aux endroits suivants:

    - :ref:`pages_recherche_facette`


+----------+------------------------------------------------+
| url      | http://hdalab.iri-research.org/hdalab/a/filter |
+----------+------------------------------------------------+
| view     | :func:`hdalab.views.ajax.filter`               |
+----------+------------------------------------------------+


.. autofunction:: hdalab.views.ajax.filter
  :noindex:


Recherche de tag
================

Ce point d'API est utilisé pour faire des recherche dans les tags.
Il est utilisé aux endroits suivants:

    - :ref:`pages_recherche_facette`
    - :ref:`renkan_boite_recherche_contenus`

+----------+----------------------------------------------------------+
| url      | http://hdalab.iri-research.org/hdalab/a/tagsearch        |
+----------+----------------------------------------------------------+
| view     | :func:`hdalab.views.ajax.tagsearch`                      |
+----------+----------------------------------------------------------+

.. autofunction:: hdalab.views.ajax.tagsearch
  :noindex:


login ajax
==========

Ce point d'API permet la gestion de la connexion à partir d'un éditeur Renkan.
Il est utilisé aux endroits suivants :

    - :ref:`pages_recherche_facette`


+----------+---------------------------------------------------+
| url      | http://hdalab.iri-research.org/hdalab/ajaxlogin/  |
+----------+---------------------------------------------------+
| view     | :func:`hdalab.views.profile.ajax_login`           |
+----------+---------------------------------------------------+

.. autofunction:: hdalab.views.profile.ajax_login
  :noindex:

Chargement et sauvegarde de renkan
==================================

Ce point d'API permet le chargement et la sauvegarde des renkan. Il est appelé par le client javascript renkan.

Il est utilisé aux endroits suivants :

    - :ref:`pages_edition_renkan`
    - :ref:`affichage-d-un-renkan-en-lecture-seule`
    - :ref:`affichage-d-un-renkan-en-plein-ecran`


+-----------+------------------------------------------------------+
| url       | http://hdalab.iri-research.org/hdalab/renkan/getput/ |
+-----------+------------------------------------------------------+
| view      | :class:`hdalab.views.profile.HdalabRenkanGetPut`     |
+-----------+------------------------------------------------------+
| view GET  | :meth:`hdalab.views.profile.HdalabRenkanGetPut.get`  |
+-----------+------------------------------------------------------+
| view POST | :meth:`hdalab.views.profile.HdalabRenkanGetPut.post` |
+-----------+------------------------------------------------------+

A noter que l'appel de l'URL en GET ou POST mème à des vue différentes.


Appel en HTTP GET:
------------------

.. automethod:: hdalab.views.profile.HdalabRenkanGetPut.get
  :noindex:

Appel en HTTP POST:
-------------------

.. automethod:: hdalab.views.profile.HdalabRenkanGetPut.post
  :noindex:


