Skip to main content

Endpoint & Authentification

En-têtes (Headers) :
  • Authorization: Bearer [VOTRE_JETON_D_API]
  • X-Arquos-Agency: [IDENTIFIANT_D_AGENCE] (facultatif, voir Agence)
  • Content-Type: application/json

Paramètres de la requête

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).
string[]
required
Les identifiants des équipements.
string
required
Le code du motif du relevé (_tat_des_lieux, relev__contrat, relev__r_paration…).

Réponse (201)

boolean
Toujours true : un refus rend un code d’erreur et sa raison.
integer
Le nombre de relevés créés (un par équipement).
string[]
Les numéros des relevés créés.
Le chemin de la fiche dans Arquos.
string
L’adresse complète de la fiche, à ouvrir dans un navigateur.

Les erreurs

Le corps d’une erreur porte error, sa raison en français. Voir Les erreurs.