Endpoint & Authentification
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
Deux caractères au moins.
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)
Les objets de vos agences qui répondent au terme, les plus pertinents d’abord.
string
La clé du type d’objet, à passer aux routes génériques (
equipment, buildings, clients, deals…).string
Le type d’objet, au singulier, tel qu’il se lit (« Équipement », « Client »).
string
L’identifiant Arquos.
string
Ce qui nomme l’objet (numéro, nom, adresse). Peut valoir
null.string
Une précision : l’immeuble d’un équipement, la ville d’un client… Peut valoir
null.string
Quand l’objet a été trouvé par un autre (le client d’un immeuble cherché), ce qui l’a fait trouver. Peut valoir
null.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.