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
L’identifiant de l’équipement.
string
required
personne_bloquee = Personne bloquée ; panne = Panne ; vandalisme = Vandalisme ; bruit = Bruit ou gêne ; arret_client = Arrêt demandé ; telealarme = Téléalarme en défaut Valeurs possibles : personne_bloquee, panne, vandalisme, bruit, arret_client, telealarme.
string
required
Qui appelle (nom, ou « gardien », « syndic »…).
string
required
Ce que l’appelant signale, en une phrase.
string
L’identifiant du technicien, si l’utilisateur en désigne un.

Réponse (201)

string
L’identifiant de l’appel ouvert.
boolean
Toujours true : un refus rend un code d’erreur et sa raison.
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.