api.search
Rechercher une graphie dans BaBaLex, trouver le(s) mot-vedette(s) associé(s) et les entrées dans les différents lexiques + wiktionnaire. La recherche pourra être effectuée :
- en caractères naturels de la langue :
- alphabet classique, hanzi, kanji, écriture arabe pour les langues respectives
- en transcription alternative uniquement dans le lexique 0 (pas dans le wiktionnaire)
- avec l'alphabet phonétique international pour toutes es langues
- avec la transcription "naturelle" de la langue : hiragana, pinyin
Use cases
- un utilisateur recherche un mot dans la barre de recherche (2.1)
- un utilisateur clique sur une graphie dans un lexique ([3.9 : #6 (closed), #21 (closed))
- Récupération automatique des informations lexicales pour les Flashcards
Lancé par
- utilisateur (recherche de mot)
- système (exemple : création de flashcards)
Request
| Method | URL |
|---|---|
GET |
api/search/<graphy> |
| Type | Params | Values | Details |
|---|---|---|---|
URL |
graphy |
string |
forme écrite du mot (graphie) |
GET |
language |
string |
langue de la recherche |
GET |
user |
user_id |
identifiant de personne qui fait la requête |
GET |
target_lex |
array<lex_id> |
(optional. Default : all) spécifier dans quels lexiques la recherche est effectuée |
Response
| Status | Response |
|---|---|
| 200 | La réponse est l’ensemble “fusionné” (tableau) des entrées lexicales (voir structure d'une entrée) correspondant à la graphie:
|
| 401 ou 403 | Utilisateur non authentifié ou requête non autorisée (TODO : définir) |
| 500 | {"error":"Something went wrong. Please try again later."} |