# getAccess

## Requête

Permet de récupérer les droits de l'Utilisateur pour le [Dictionnaire](https://connector-api.orelc.ac/objets/dictionary), sa [Licence ](https://connector-api.orelc.ac/objets/license)ainsi que les mentions. La réponse retourne un array d'objets [License](https://connector-api.orelc.ac/objets/license), et un [User](https://connector-api.orelc.ac/objets/user).

#### Endpoint

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

#### Exemple

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

<pre class="language-javascript"><code class="lang-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", 
<strong>    headers: {
</strong>        "Authorization": apiKey,
        "username ": username,
        "password ": password 
    }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error("Erreur :", error));
</code></pre>

{% endtab %}

{% tab title="Second Tab" %}

{% endtab %}
{% endtabs %}

### Réponse

```json
{
    "Dictionary": {
        "variety": "shiKomori",
        "authorization": "all",
        "startValidity": "2021-01-06",
        "endValidity": "2022-01-06",
        "entries": "11554/11554",
        "licenseNumber": 40,
        "userNumber": 36,
        "version": 1
    },
    "Licenses": [
        {
            "number": 40,
            "name": "Apprendre à Parler",
            "description": ""
        }
    ],
    "User": {
        "number": 36,
        "firstName": "John",
        "lastName": "DOE",
        "displayName": "John Doe"
    },
    "message": "Utilisation des données Apprendre à Parler.",
    "provider": "ORELC",
    "web": "www.orelc.ac"
}
```

### Description des champs

| champ    | Type   | Description                    | Valeur par défaut               |
| -------- | ------ | ------------------------------ | ------------------------------- |
| message  | string | Message d'informations/erreurs |                                 |
| provider | URL    | Nom du fournisseur             | ORELC                           |
| web      | URL    | Lien du fournisseur            | <https://www.orelc.ac/academy/> |

#### Dictionary <a href="#dictionaryobject" id="dictionaryobject"></a>

| Champ         | Type    | Description                           | Valeur par défaut                                             |
| ------------- | ------- | ------------------------------------- | ------------------------------------------------------------- |
| variety       | string  | Filtrage du contenu                   | shiKomori \| shiMaore \| shiMwali \| shiNdzuani \| shiNgzidja |
| authorization | string  | Droit utilisateur sur le dictionnaire | all \| demo \| none                                           |
| startValidity | string  | Date de début de validité             | yyyy-mm-dd (peut être vide)                                   |
| endValidity   | string  | Date de fin de validité               | yyyy-mm-dd (peut être vide)                                   |
| entries       | string  | Nombre d'entrées autorisées           | 1000                                                          |
| licenseNumber | integer | Numéro de licence                     | ∞                                                             |
| userNumber    | integer | Numéro de l'utilisateur               | ∞                                                             |
| version       | integer | Numéro de version du dictionnaire     | 1                                                             |

#### Licenses

| Champ       | Type    | Description       | Valeur par défaut |
| ----------- | ------- | ----------------- | ----------------- |
| number      | integer | Numéro de licence | ∞                 |
| name        | integer | Nom               | ∞                 |
| description | string  | Description       |                   |

#### User

| Champ       | Type    | Description             | Valeur par défaut |
| ----------- | ------- | ----------------------- | ----------------- |
| number      | integer | Numéro de l'utilisateur | ∞                 |
| firstName   | string  | Prénom                  | non nul           |
| lastName    | string  | Nom                     | non nul           |
| displayName | string  | Nom d'affichage         |                   |