Fiche API

Un objet « Fiche » représente un contact client, créé en notant un RDV lui étant associé sur l'Interface Pro ou lorsqu'un utilisateur prend un RDV sur l'Interface de prise de RDV par Internet.

En mode Account, on retourne toutes les fiches (supprimées ou pas).
Les fiches supprimées auront un "$" en début de "lastname".

Récupération de la liste des fiches du groupe

GET /api/v1/groups/:group_id/fiches

Récupération d'une fiche

GET /api/v1/groups/:group_id/fiches/:id

Création d'une fiche

POST /api/v1/groups/:group_id/fiches?apikey=xxxxxx
{
  "fiche": {
    "group_id": 4,
    "firstname": "John",
    "lastname": "Doe",
    "firstphone": "01 23 45 67 89"
  }
}

Modification d'une fiche

PUT /api/v1/groups/:group_id/fiches/:id?apikey=xxxxxx
{
  "fiche": {
     "secondphone": "06 12 34 56 78",
     "str0": "Lorem ipsum"
  }
}

Suppression d'une fiche

Non disponible pour l'instant

Attributs

Champ	Type	Description
group_id	integer	ID de l'objet de type « Group » auquel il est lié
lastname	string(64)	Nom de famille
firstname	string(64)	Prénom
firstphone	string(25)	Numéro de téléphone
secondphone	string(25)	Deuxième numéro de téléphone
email	string(255)	Adresse email
birthdate	datetime	Date de naissance
comments	text	Commentaires sur la fiche (non visible par l’utilisateur)
from_web	boolean	Indique si cette fiche à été crée via l'Interface de prise de RDV par Internet (Cela signifie aussi que l'utilisateur représenté par cette fiche à déjà pris RDV au moins une fois par Internet)
rappel_email	boolean	Indiquant si l’utilisateur souhaite recevoir des rappels e-mail (les utilisateurs peuvent changer cette option via l'Interface de prise de RDV par Internet) (1 par défaut)
rappel_sms	boolean	Indiquant si l’utilisateur souhaite recevoir des rappels SMS (les utilisateurs peuvent changer cette option via l'Interface de prise de RDV par Internet) (1 par défaut)
externid	integer	Identifiant externe (utilisé pour synchroniser les fiches clients)
deleted	boolean	Indiquant si cette fiche est supprimée (0 par défaut)

Attributs personnalisés

Voir page : Customfields API