Lire un équipement et ses données techniques

curl --request GET \
--url https://api.arquos.eu/api/v2/equipment/ID_DE_L_OBJET \
--header 'Authorization: Bearer arq_agent_VOTRE_JETON'

{
"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"
  }
]
}

curl --request GET \
--url https://api.arquos.eu/api/v2/equipment/ID_DE_L_OBJET \
--header 'Authorization: Bearer arq_agent_VOTRE_JETON'

{
"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"
  }
]
}

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)

Paramètres de la requête

string

required

L’identifiant de l’objet.

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

Réponse (`200`)

string

L’identifiant Arquos.

string

Le numéro de l’équipement dans l’agence (le equipment_number de la V1). Peut valoir null.

string

Le numéro de série du constructeur. Peut valoir null.

string

Le type d’équipement. Valeurs possibles : ascenseur, monte_charge, monte_voiture, elevateur, porte_fermeture, niveleur_de_quai, range_voiture, autre. Peut valoir null.

string

La précision du type, en texte libre. Peut valoir null.

string

Où il est dans l’immeuble (« Tour Sud », « Bât. B »). Peut valoir null.

string

parc : au contrat d’entretien de l’agence ; hors_parc : non ; null : on ne sait pas. Peut valoir null.

string

Le numéro du contrat d’entretien. Peut valoir null.

string

La société qui l’entretient, quand ce n’est pas l’agence. Peut valoir null.

object

L’immeuble où il se trouve. Peut valoir null.

Show Ses champs

string

L’identifiant Arquos.

string

Le nom de l’immeuble. Près d’un immeuble sur quatre n’en a pas. Peut valoir null.

string

L’adresse de l’immeuble. Peut valoir null.

string

Le chemin de la fiche dans Arquos.

string

L’adresse complète de la fiche, à ouvrir dans un navigateur.

object

Le client de l’immeuble. Peut valoir null.

Show Ses champs

string

L’identifiant Arquos.

string

Le nom du client. Peut valoir null.

string

Le chemin de la fiche dans Arquos.

string

L’adresse complète de la fiche, à ouvrir dans un navigateur.

string

Le chemin de la fiche dans Arquos.

string

L’adresse complète de la fiche, à ouvrir dans un navigateur.

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.

Show Chaque élément

string

Le code de la donnée au catalogue des données techniques. C’est lui qu’on envoie pour la corriger.

string

Le nom de la donnée, tel qu’il se lit dans Arquos. Peut valoir null.

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.

string

L’unité de la valeur (mm, kg, m/s…), quand elle en a une. Peut valoir null.

string

Le composant décrit (car_door, machine, controller…), ou null pour une donnée de l’équipement lui-même. Peut valoir null.

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.

curl --request GET \
--url https://api.arquos.eu/api/v2/equipment/ID_DE_L_OBJET \
--header 'Authorization: Bearer arq_agent_VOTRE_JETON'

{
"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"
  }
]
}

Démarrer

API REST

Centres d'appels

Agents IA

Référence · Compte

Référence · Recherche

Référence · Équipements

Référence · Relevés

Référence · Contrats

Référence · Import

Référence · Webhooks

Référence · Référentiels

Référence · Affaires

Référence · Appels

Référence · Visites

Référence · Techniciens

Référence · Pièces

Référence · Devis

Référence · Notes

Référence · Écarts et réserves

Référence · Factures

Référence · Clients

Référence · Immeubles

Référence · Contacts

Référence · Secteurs

Référence · Campagnes

Référence · Contrôles techniques

Référence · Sollicitations

Lire un équipement et ses données techniques

Endpoint & Authentification

Paramètres de la requête

Réponse (`200`)

Les erreurs

​Endpoint & Authentification

​Paramètres de la requête

​Réponse (200)

​Les erreurs

Endpoint & Authentification

Paramètres de la requête

Réponse (`200`)

Les erreurs