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
contrat = Contrat d’entretien ; reparation = Réparation ; modernisation = Modernisation ; remplacement = Remplacement complet Valeurs possibles :
contrat, reparation, modernisation, remplacement.string
Pour une modernisation ou un remplacement complet : chiffrer (devis) ou commander les travaux. Valeurs possibles :
chiffrer, commander.boolean
Le second document : un devis en plus d’un contrat d’entretien, ou un contrat en plus d’un devis.
string[]
required
Les identifiants des équipements, tous dans la même agence.
string
Relevé sur site (par défaut), données existantes, ou entrée directe. Valeurs possibles :
sur_site, donnees_existantes, entree_directe.string
Date limite du relevé, AAAA-MM-JJ.
string
Les consignes pour le releveur (accès, clés, contact).
string
Le nom de l’affaire ; à défaut, la rue de l’immeuble.
Réponse (201)
string
L’identifiant de l’affaire créée.
boolean
Toujours
true : un refus rend un code d’erreur et sa raison.string
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.