Intervention API

Une intervention est un « Type de RDV », exemples: « Consultation », « Visite mensuelle », « Révision chaudière », etc ... Tous les RDV doivent être liés à une intervention.

Liste des interventions pour le groupe

GET /api/v1/groups/:group_id/interventions?apikey=xxxxxxx

Liste des interventions dans un groupe d’intervention

GET /api/v1/interventionsets/:interventionset_id/interventions?apikey=xxxxxx

Liste des interventions disponibles sur un calendrier

GET /api/v1/calendars/:calendar_id/interventions?apikey=xxxxxx

Création d'une intervention

POST /api/v1/interventions
{
  "apikey": "xxxxxxxxx",
  "intervention": {
     "group_id": 4,
     "name": "Prestation de test",
     "length": 30
  }
}

Modification d'une intervention

PUT /api/v1/interventions/:id
{
  "apikey": "xxxxxxxxx",
  "intervention": {
     "publicname": "Prestation ouverte à Internet"
  }
}

Suppression d'une intervention

DELETE /api/v1/interventions/:id?apikey=xxxxxxxx

Cette opération ne supprime pas complètement l'intervention ! Elle passe l'attribut deleted à true. L'intervention peut ainsi être restaurée plus tard :

PUT /api/v1/calendars/:id
{
   "apikey": "xxxxxxxxx",
   "calendar": {
      "deleted": false
   }
}

Champs standards:

group_id

integer - ID de l'objet de type « Group » auquel il est lié

interventionset_id

integer - ID de l'objet de type «InterventionSet» auquel il est lié (si il y a des groupes d'Intervention, optionnel)

name

string(255) - Nom de l’intervention

abbr

string(255) - Abréviation de l’intervention (visible sur les RDV dans l'Interface Pro)

length

integer - Durée de l’intervention (valeur en minutes) (15 par défaut)

colorref

string(7) - Couleur de l’intervention telle qu’affichée sur l'Interface Pro, au format hexadécimal #RRGGBB (exemple: #FF6600) (#dddddd par défaut)

sort

integer - Entier permettant de gérer l'ordre des Interventions (ordre d'affichage dans l'Interface Pro et dans l'Interface de prise de RDV par Internet)

price

integer - Prix de l’intervention en centimes (optionnel) - ex : mettre 3000 pour une prestation à 30€

deleted

boolean - Indique si une intervention est supprimée (0 par défaut)

Champs liés à la prise de RDV par Internet :

publicname

string(255) - Nom de l’intervention tel que visible sur l'Interface de prise de RDV par Internet. Important : Si ce champ est vide, l’intervention ne sera pas disponible à la prise de RDV par Internet.