> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arquos.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# Obtenir des données équipement

> Cette fonctionnalité permet de récupérer en temps réel les informations techniques stockées sur Arquos.

### Endpoint & Authentification

| Méthode | URL                                                   |
| :------ | :---------------------------------------------------- |
| `POST`  | `https://app.arquos.eu/api/1.1/wf/get_equipment_data` |

**En-têtes (Headers) :**

* `x-api-key: [VOTRE_API_KEY]`

<Note>
  La clé API est propre à chaque partenaire et n'est autorisée que sur les agences qui lui ont été attribuées. Un appel avec une clé invalide, ou visant une agence non autorisée, n'est pas exécuté.
</Note>

### Paramètres de la requête (Body)

<ParamField body="agency_id" type="string" required>
  Identifiant unique de l'agence.
</ParamField>

<ParamField body="equipment_number" type="string" required>
  Numéro unique de l'équipement.
</ParamField>

### Réponse

Si l'équipement existe, l'API retourne un objet contenant toutes les données disponibles parmi les champs techniques suivants.

<Expandable title="Caractéristiques techniques" defaultOpen="true">
  <ResponseField name="adresse" type="string">
    Adresse de l'immeuble.
  </ResponseField>

  <ResponseField name="charge_utile" type="number">
    Charge utile de l'appareil.
  </ResponseField>

  <ResponseField name="complement_adresse" type="string">
    Complément d'adresse sur l'équipement (bâtiment, escalier…).
  </ResponseField>

  <ResponseField name="contrat_entretien" type="string">
    Valeurs possibles : `Parc` ou `Hors parc`.
  </ResponseField>

  <ResponseField name="course" type="number">
    Hauteur de course de l'appareil.
  </ResponseField>

  <ResponseField name="implantation_machinerie" type="string">
    Valeurs possibles : `Haute`, `Basse`, `Latérale` ou `Sans (MRL)`.
  </ResponseField>

  <ResponseField name="marque" type="string">
    Marque de l'équipement.
  </ResponseField>

  <ResponseField name="modele" type="string">
    Modèle de l'équipement.
  </ResponseField>

  <ResponseField name="nom_immeuble" type="string">
    Nom de l'immeuble.
  </ResponseField>

  <ResponseField name="nombre_faces_de_service" type="number">
    Nombre de faces de service.
  </ResponseField>

  <ResponseField name="nombre_niveaux" type="number">
    Nombre de niveaux desservis.
  </ResponseField>

  <ResponseField name="nombre_personnes" type="number">
    Capacité en nombre de personnes.
  </ResponseField>

  <ResponseField name="type_entrainement" type="string">
    Valeurs possibles : `Electrique` ou `Hydraulique`.
  </ResponseField>

  <ResponseField name="vitesse" type="number">
    Vitesse de la cabine.
  </ResponseField>

  <ResponseField name="taux_connaissance" type="number">
    Taux de connaissance de l'équipement en pourcentage.
  </ResponseField>
</Expandable>

<RequestExample>
  ```json JSON theme={null}
  {
    "agency_id": "test_agency_01",
    "equipment_number": "ASC_45678"
  }
  ```

  ```bash cURL theme={null}
  curl --request POST \
    --url https://app.arquos.eu/api/1.1/wf/get_equipment_data \
    --header 'x-api-key: VOTRE_API_KEY' \
    --header 'Content-Type: application/json' \
    --data '{
    "agency_id": "test_agency_01",
    "equipment_number": "ASC_45678"
  }'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "status": "success",
    "response": {
      "marque": "Otis",
      "type_entrainement": "Electrique",
      "implantation_machinerie": "Sans (MRL)",
      "course": 12.5
    }
  }
  ```
</ResponseExample>