# getProperNouns

## Requête

Permet de récupérer les noms propres dans le format de l'objet [name](https://connector-api.orelc.ac/objets/name).

#### Endpoint

```
[Domain]/academy/api/v1/Dictionary/getProperNouns
```

#### Body

```json
{
    "letter" : "a",
    "fromLanguage" : "km",
    "toLanguage" : "fr"
}
```

{% tabs %}
{% tab title="Javascript" %}

```javascript
const endpoint = "[endpoint]";
const apiKey = "[myAPIKey]";

// Use the username and password to obtain data based on user rights
const username = "[username]"; // optionnel
const password = "[password]"; // optionnel

fetch(endpoint, {
    method: "POST",
    headers: {
        "Authorization": apiKey,
        "Content-Type": "application/json",
        "username ": username,
        "password ": password 
    },
    body: JSON.stringify({
        letter: "a",
        fromLanguage: "km",
        toLanguage: "fr"
    })
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error("Erreur :", error));

```

{% endtab %}

{% tab title="Second Tab" %}

{% endtab %}
{% endtabs %}

Description des champs de la requête

| Champ        | Type   | Description                            | Valeur  |
| ------------ | ------ | -------------------------------------- | ------- |
| letter       | string | La lettre initiale des mots du lexique | requise |
| fromLanguage | string | La langue d'entrée (ISO 639-1)         | requise |
| toLanguage   | string | La langue de traduction (ISO 639-1)    | requise |

## Réponse

```json
{
    "Dictionary": {
        "version": 7,
        "authorization": "demo",
        "endValidity": "",
        "variety": "shiKomori ●",
        "entries": "14/42",
        "names": [
            {
                "id": 277,
                "hasDefinition": true,
                "km": "Abdu-Swamad",
                "fr": "Abdou-Soimad"
            },
            {
                "id": 328,
                "hasDefinition": true,
                "km": "Âfu",
                "fr": "Anfu"
            },            
            {
                "id": 86,
                "hasDefinition": false,
                "km": "Aida",
                "fr": "Aïda"
            },
            {
                "id": 225,
                "hasDefinition": false,
                "km": "Aisate",
                "fr": "Aïssate"
            },
            {
                "id": 226,
                "hasDefinition": false,
                "km": "Aisati",
                "fr": "Aïssati"
            },
            {
                "id": 160,
                "hasDefinition": true,
                "km": "Alawi",
                "fr": "Allaoui"
            }
        ]
    },
    ...
}
```

{% hint style="warning" %}
Avec une **authorization** de démo, cette requête ne renvoie qu'un nombre limité de mots. Le nombre de mots du dictionnaire est inscrits dans le champ **entries.** Vous pouvez vous servir des champs **authorization** et **entries** pour en informer l'utilisateur.
{% endhint %}

Description des champs de la réponse

| Champ | Type  | Description           |
| ----- | ----- | --------------------- |
| names | array | La liste d'objet name |
|       |       |                       |
