> ## 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.

# Lire un équipement et ses données techniques

> L’identité de l’équipement, son immeuble et son client, et toutes ses données techniques relevées. Une donnée jamais relevée est absente de la liste.

### Endpoint & Authentification

| Méthode | URL |
| :- | :- |
| `GET` | `https://api.arquos.eu/api/v2/equipment/{id}` |

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

* `Authorization: Bearer [VOTRE_JETON_D_API]`
* `X-Arquos-Agency: [IDENTIFIANT_D_AGENCE]` (facultatif, voir [Agence](/v2/agence))

### Paramètres de la requête

<ParamField path="id" type="string" required>
  L’identifiant de l’objet.
</ParamField>

<ParamField header="X-Arquos-Agency" type="string">
  L’identifiant de l’agence où agir. Absent : l’agence par défaut du compte. Une agence hors de sa portée est refusée (403).
</ParamField>

### Réponse (`200`)

<ResponseField name="id" type="string">
  L’identifiant Arquos.
</ResponseField>

<ResponseField name="number" type="string">
  Le numéro de l’équipement dans l’agence (le `equipment_number` de la V1). Peut valoir `null`.
</ResponseField>

<ResponseField name="serialNumber" type="string">
  Le numéro de série du constructeur. Peut valoir `null`.
</ResponseField>

<ResponseField name="type" type="string">
  Le type d’équipement. Valeurs possibles : `ascenseur`, `monte_charge`, `monte_voiture`, `elevateur`, `porte_fermeture`, `niveleur_de_quai`, `range_voiture`, `autre`. Peut valoir `null`.
</ResponseField>

<ResponseField name="subtype" type="string">
  La précision du type, en texte libre. Peut valoir `null`.
</ResponseField>

<ResponseField name="location" type="string">
  Où il est dans l’immeuble (« Tour Sud », « Bât. B »). Peut valoir `null`.
</ResponseField>

<ResponseField name="maintenanceContract" type="string">
  `parc` : au contrat d’entretien de l’agence ; `hors_parc` : non ; `null` : on ne sait pas. Peut valoir `null`.
</ResponseField>

<ResponseField name="contractNumber" type="string">
  Le numéro du contrat d’entretien. Peut valoir `null`.
</ResponseField>

<ResponseField name="maintainer" type="string">
  La société qui l’entretient, quand ce n’est pas l’agence. Peut valoir `null`.
</ResponseField>

<ResponseField name="building" type="object">
  L’immeuble où il se trouve. Peut valoir `null`.

  <Expandable title="Ses champs">
    <ResponseField name="id" type="string">
      L’identifiant Arquos.
    </ResponseField>

    <ResponseField name="name" type="string">
      Le nom de l’immeuble. Près d’un immeuble sur quatre n’en a pas. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="address" type="string">
      L’adresse de l’immeuble. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="link" type="string">
      Le chemin de la fiche dans Arquos.
    </ResponseField>

    <ResponseField name="url" type="string">
      L’adresse complète de la fiche, à ouvrir dans un navigateur.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="client" type="object">
  Le client de l’immeuble. Peut valoir `null`.

  <Expandable title="Ses champs">
    <ResponseField name="id" type="string">
      L’identifiant Arquos.
    </ResponseField>

    <ResponseField name="name" type="string">
      Le nom du client. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="link" type="string">
      Le chemin de la fiche dans Arquos.
    </ResponseField>

    <ResponseField name="url" type="string">
      L’adresse complète de la fiche, à ouvrir dans un navigateur.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="link" type="string">
  Le chemin de la fiche dans Arquos.
</ResponseField>

<ResponseField name="url" type="string">
  L’adresse complète de la fiche, à ouvrir dans un navigateur.
</ResponseField>

<ResponseField name="data" type="object[]">
  Toutes ses données techniques relevées, rangées par composant. Une donnée jamais relevée est ABSENTE de la liste : sa présence dit qu’on la connaît.

  <Expandable title="Chaque élément">
    <ResponseField name="code" type="string">
      Le code de la donnée au catalogue des données techniques. C’est lui qu’on envoie pour la corriger.
    </ResponseField>

    <ResponseField name="label" type="string">
      Le nom de la donnée, tel qu’il se lit dans Arquos. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="value" type="string | number | boolean | array">
      La valeur relevée : un nombre pour une mesure, un texte pour un choix, une liste pour un choix multiple. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="unit" type="string">
      L’unité de la valeur (mm, kg, m/s…), quand elle en a une. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="component" type="string">
      Le composant décrit (`car_door`, `machine`, `controller`…), ou `null` pour une donnée de l’équipement lui-même. Peut valoir `null`.
    </ResponseField>
  </Expandable>
</ResponseField>

### Les erreurs

| Code | Quand |
| :- | :- |
| `400` | Requête mal formée ou champ obligatoire manquant. |
| `401` | Jeton absent, inconnu ou révoqué. |
| `403` | Agence hors de votre portée. |
| `404` | Objet introuvable dans vos agences. |
| `429` | Trop d’appels : réessayez après le délai de l’en-tête Retry-After. |

Le corps d'une erreur porte `error`, sa raison en français. Voir [Les erreurs](/v2/erreurs).

<RequestExample>
  ```bash cURL theme={"system"}
  curl --request GET \
  --url https://api.arquos.eu/api/v2/equipment/ID_DE_L_OBJET \
  --header 'Authorization: Bearer arq_agent_VOTRE_JETON'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={"system"}
  {
  "id": "0b6f0e0c-2c55-4a4c-9a0e-6f0a3b6f2b1d",
  "number": "53 A 00068 01",
  "serialNumber": "040D45A",
  "type": "ascenseur",
  "subtype": null,
  "location": "Tour Sud",
  "maintenanceContract": "parc",
  "contractNumber": "C-2024-118",
  "maintainer": null,
  "building": {
    "id": "ad48d3ca-e5d3-46fc-9b12-eb8942ba95da",
    "name": "Les Jardins Saint-Nicolas",
    "address": "26 Rue du Port, 14000 Caen",
    "link": "/buildings/ad48d3ca-e5d3-46fc-9b12-eb8942ba95da",
    "url": "https://app.arquos.eu/buildings/ad48d3ca-e5d3-46fc-9b12-eb8942ba95da"
  },
  "client": {
    "id": "74484d22-a117-4113-b6bd-b1f98c506725",
    "name": "Cabinet Beauséjour",
    "link": "/clients/74484d22-a117-4113-b6bd-b1f98c506725",
    "url": "https://app.arquos.eu/clients/74484d22-a117-4113-b6bd-b1f98c506725"
  },
  "link": "/equipment/0b6f0e0c-2c55-4a4c-9a0e-6f0a3b6f2b1d",
  "url": "https://app.arquos.eu/equipment/0b6f0e0c-2c55-4a4c-9a0e-6f0a3b6f2b1d",
  "data": [
    {
      "code": "charge-utile",
      "label": "Charge utile",
      "value": 630,
      "unit": "kg",
      "component": null
    },
    {
      "code": "nombre-niveaux",
      "label": "Nombre de niveaux",
      "value": 7,
      "unit": null,
      "component": null
    },
    {
      "code": "marque-machine",
      "label": "Marque",
      "value": "Otis",
      "unit": null,
      "component": "machine"
    }
  ]
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.