Outils


Outils

ORELC Dictionary 1.0/BETA

La licence

L'utilisation de l'Api Dictionary de ORELC 1.0 est libre et sous licence GNU GENERAL PUBLIC LICENSE.
Nous vous demandons ainsi de mettre notre lien www.swadrii.com en claire dans vos applications ou logiciels, ou citer l'une des sources qui se trouvent dans l'objet swadrii.

swadrii : La réponse à une requête
provider → Le fournisseur *
site → l'adresse du site *
api_info → Les informations API
logo → l'URL du logo de l'API

* Infos qui doivent être mentionnées.

Les données

Les données fournies par www.swadrii.com peuvent être récupérées au format JSON ou XML.

La récupération des données

La récupération de données se fait simplement via URL. Cette manière de procéder vous retournera des objets.

Les requêtes

Toutes les URLs sont sous cette forme :
www.swadrii.com/orelc/api/version/service_name/fonction/lang/parameter.ext
version : Le numéro de version de l'API
service_name : Le nom du service. (ex. WsShikomori, WsFrench...)
fonction : Le nom de la fonction que vous voulez appeler. (ex. getWords, viewWord...)
lang : La langue de la réponse ("fr" est actuellement la seule disponible)
parameter : Le paramètre (peut être vide)
ext : L'extension ou le format de la réponse (xml ou json)

Exemple avec l'URL : www.swadrii.com/orelc/api/1.0/WsShikomori/getWords/fr/k.json

Liste des services et fonctions disponibles

Les services disponibles :
WsShikomori : pour les mots en comorien
WsFrench : pour les mots en français (en développement)
WsPlural : pour les pluriels (en développement)
WsVerb : pour les verbes (en développement)
WsName : pour les prénoms comorien (en développement)

Les fonctions disponibles :
Toutes les requêtes doivent commençer par l'URL:
www.swadrii.com/orelc/api/1.0 suivies de l'appel à la fonction et peuvent être utilisées avec n'importe quel service

Exemple de fonctions avec le service : WsShikomori

getWord : Récupère le mot en fonction de l'identifiant entré en paramètre.
URL: /WsShikomori/getWord/fr/125.json

getWords : Récupère tous les mots en fonction de la lettre entrée en paramètre.
URL: /WsShikomori/getWords/fr/a.json

viewWord : Récupère le premier mot trouvé en paramètre.
URL: /WsShikomori/viewWord/fr/gari.xml

searchWords/ : Récupère tous les mots commençant par la chaine de caractère entrée en paramètre.
URL: /WsShikomori/searchWords/fr/ga.xml

Pour le service WsName, les fonctions sont :
getName, getNames, viewName et searchNames

Contacter-nous pour des fonctions supplémentaires

Les objets

Les réponses sont retournées dans des objets XML ou JSON, avec des noms assez explicites. Nous ne commenterons seulement les élèments qui nous sembles nécessaires.

ShikomoriWord : L'entrée en comorien
id → un entier, l'identifiant unique *
class → le numéro de classe grammaticale *
word *
origin
is_shimaore → un boolean, renvoie true si c'est du shiMaore, autrement false *
is_shimwali → un boolean, renvoie true si c'est du shiMwali, autrement false *
is_shindzuani → un boolean, renvoie true si c'est du shiNdzuani, autrement false *
is_shingazidja → un boolean, renvoie true si c'est du shiNgazidja, autrement false *
is_standard → un boolean, renvoie true si c'est une entrée uniforme, autrement false *
has_plural → un boolean, renvoie true si cette entrée a un pluriel, autrement false *
has_infinitive → un boolean, renvoie true si cette entrée a un infinitif, autrement false *
category
category2
category3
last_modification → une date (format : yyyy-MM-dd HH:mm:ss), La date de la dernière modification *

FrenchWord : L'entrée en français
id → un entier, l'identifiant unique *
word *
origin
category
category2
category3
last_modification → une date (format : yyyy-MM-dd HH:mm:ss), La date de la dernière modification *

ShikomoriVerb : L'infinitif
id → un entier, l'identifiant unique *
class → le numéro de classe grammaticale *
word→ le verbe à la forme infinitive *
form
shikomori_id → un entier, l'identifiant de l'objet ShikomoriWord *
initial_form_id → un entier, l'identifiant de la forme initial de l'objet ShikomoriVerb
verb_ending → un texte, la terminaison du verbe
category
last_modification → une date (format : yyyy-MM-dd HH:mm:ss), La date de la dernière modification *

ShikomoriPlural : Le pluriel
id → un entier, l'identifiant unique *
class → le numéro de classe grammaticale *
word *
shikomori_id → un entier, l'identifiant de l'objet ShikomoriWord *
category
category2
category3
last_modification → une date (format : yyyy-MM-dd HH:mm:ss), La date de la dernière modification *

ShikomoriName : Le prénom
id → un entier, l'identifiant unique *
name → le numéro de classe grammaticale *
gender *
meaning_km → un texte, la signification en comorien
meaning_fr → un texte, la signification en français
french_transcription → un texte, le prénom orthographié en français *
shikomori_id → un entier, l'identifiant de l'objet ShikomoriWord
parent_id → un entier, l'identifiant parent de l'objet ShikomoriName
last_modification → une date (format : yyyy-MM-dd HH:mm:ss), La date de la dernière modification *

* Les champs non nul.