src/hdabo/views.py
branchdocumentation
changeset 693 09e00f38d177
parent 689 589574f7e7c4
equal deleted inserted replaced
692:b7d19cd87fcf 693:09e00f38d177
   627         return redirect(self.redirect_view)
   627         return redirect(self.redirect_view)
   628 
   628 
   629 
   629 
   630 
   630 
   631 class SearchDatasheet(SearchView):
   631 class SearchDatasheet(SearchView):
       
   632     """
       
   633     Vue permettant la recherche dans les fiches HDALab.
       
   634     La recherche se fait dans les objets :class:`hdabo.models.Datasheet`.
       
   635     C'est une vue qui étend `haystack.views.SearchView <https://django-haystack.readthedocs.io/en/v2.3.2/views_and_forms.html#searchview-template-none-load-all-true-form-class-none-searchqueryset-none-context-class-requestcontext-results-per-page-none>`_.
       
   636 
       
   637     Paramêtres GET:
       
   638 
       
   639     :var (str) q: La requête à effectuer.
       
   640     :var (str) format: format de la réponse. Si `json` le contenu retourné est un contenu json.
       
   641     :var (int) limit: Le nombre maximum de résultat par page.
       
   642     :var (int) page: le numéro de page de résultat.
       
   643 
       
   644 
       
   645     Réponse (application/json):
       
   646 
       
   647     Une liste comprenant les résultats de la recherche.
       
   648     Si le paramêtre `format` est ``json``, cette vue retourne un document json décrit plus bas.
       
   649     Sinon, la vue retourne une page html.
       
   650 
       
   651     exemple de retour json ::
       
   652 
       
   653       {
       
   654         "results": [
       
   655             {
       
   656                 "url": " http://www.lesartsdecoratifs.fr/francais/arts-decoratifs/collections-26/parcours-27/chronologique/xixe-siecle/les-salles-302/couleurs-vives-et-bois-clairs/",
       
   657                 "hda_id": "1279",
       
   658                 "description": "A partir des ...",
       
   659                 "title": "Couleurs vives et bois clairs"
       
   660             },
       
   661             {
       
   662                 "url": "http://www.louvre.fr/oeuvre-notices/autoportrait",
       
   663                 "hda_id": "826",
       
   664                 "description": "Conservé au Louvre...",
       
   665                 "title": "Autoportrait, Jean Fouquet (1452-1455)"
       
   666             },
       
   667             ...
       
   668         ]
       
   669       }
       
   670 
       
   671     """
   632 
   672 
   633     template = "partial/search_datasheet_for_folders.html"
   673     template = "partial/search_datasheet_for_folders.html"
   634 
   674 
   635     def create_response(self):
   675     def create_response(self):
   636         """
   676         """