Appointments API

Création d’un RDV

POST /api/v1/appointments

fiche

objet - Fiche

date

datetime - Date et heure de début ( ex: 2010-01-22 15:00:00 )

intervention_ids

array - Liste d’identifiants d’interventions

calendar_id

integer - (optionnel) Identifiant du calendrier

comments

text - Commentaires du RDV

websource

string (255) - Identifiant de la "source" du RDV. ( ex: "application iPhone" )

Important : l’objet fiche transmis peut soit contenir un attribut id indiquant une fiche existante. Les autres attributs transmis seront alors mis à jour.

Si il ne contient pas d’attribut id, une nouvelle fiche sera créée avec les attributs spécifiés.

En cas de succès, le code renvoyé est '201 Created'. En cas d'erreur, un code 400 est renvoyé, avec une liste d'erreurs en réponse:

Au delà des codes d’erreur REST classiques, la méthode de création de RDV peut retourner certains codes d’erreurs spécifiques à la prise de RDV :

Code	Message
SameTimeRdv	Vous avez déjà un rdv à cet horaire
MaxRdvNumber	Vous n'êtes pas autorisé à prendre plus de rendez-vous sur cet agenda
MintimeBetween	Vous avez déjà un rdv trop proche de celui-ci
MintimeRdv	Vous n'êtes pas autorisé à prendre rdv par internet pour cette date (trop proche)
MaxRdvPeriod	Vous n'êtes pas autorisé à prendre rdv autant à l'avance
NotAvailable	Ce créneau n'est plus disponible

Lister les RDV chez un groupe

GET /api/v1/groups/4/appointments?apikey=xxxxx

Suppression d’un RDV

DELETE /api/v1/appointments/4?apikey=xxxxx

Au delà des codes d’erreur REST classiques, la méthode de suppression de RDV peut retourner certains codes d’erreurs spécifiques à la prise de RDV :

Code	Message
MintimeAnnulation	Ce RDV est trop proche pour être annulé par Internet