API

Création d'un rdv

Cette méthode permet de sauvegarder le sociétaire et le rdv.
Cette methode doit être appelée aprés la récupération des disponibilités et le choix du créneau.

Resource URL (POST) : https://maif.rdv-04.ovea.com/espaceRdvServer/ws/SaveCustomerAppointment

Argument Type Example Required Description
wlName String maif Required

id de la marque blanche

proName String parismagenta Required

identifiant de la délégation

locale String fr Required

langue

motif String 103 Required

code motif

canal String 1 Required

code canal

employee String M00000 Optional

Code d'employé chez MAIF (null ou -1 si affectation aléatoire du rdv à l'employé)

date String 2019-01-29 Required

date du rdv (yyyy-mm-dd)

hour Integer 15 Required

heure du rdv (0 à 23)

minutes Integer 15 Required

minutes (0 à 60)

duration Integer 15 Optional

minutes (5 à 240)

origin String api_erdv (fixed value) Required

l'origine d'accès aux services de ERDV

id_technique String 555555 Required

Id technique du sociétaire.

lastname String test Required

Nom sociétaire

firstname String test Required

Prénom sociétaire

mobile String Optionnal

téléphone sociétaire

reference String 555555 Required

référence du sociétaire

matricule_conseiller String 555555 (selfcare si pas de conseiller) Required

matricule du conseiller à l'origine de la réservation ou "selfcare"

documents String doc1-doc2 Optional

Liste des documents (séparés par des tirets)

comment String test Optional

Commentaire RDV

matricule_conseiller_modificateur String 0001 Optional

matricule conseiller modificateur

nameAC String nom Optional

Nom de l'A&C

role String rôle Optional

Fonction de l'interlocuteur A&C

id_techniqueAC String id Optional

Id technique A&C

extra_data Json Object { "univers": "test", "motif": "test motif", "projet": "tes projett", "montant_versement": "test montant_versement", "montant_epargne": "test montant_epargne", "epargne_handicap": "test epargne_handicap", "appointment_comment": "test appointment_comment", "appointment_phone": "test appointment_phone", "appointment_email": "appointment.email@test.fr", "appointment_address1": "Complément adresse", "appointment_address2": "Adresse", "appointment_address3": "Cp", "appointment_address4": "Commune" } Optional

informations supplémentaires

Structure de l'objet extra_data :
{
"univers": "test",
"motif": "test motif",
"projet": "tes projett",
"montant_versement": "test montant_versement",
"montant_epargne": "test montant_epargne",
"epargne_handicap": "test epargne_handicap",
"appointment_comment": "test appointment_comment",
"appointment_phone": "test appointment_phone"
"appointment_email": "appointment.email@test.fr"
"appointment_address1": "Complément adresse"
"appointment_address2": "Adresse"
"appointment_address3": "Cp"
"appointment_address4": "Commune"
}

Response
Si la sauvegarde est réussie, vous recevrez la référence de rendez-vous et l'id du sociétaire crée ou mis à jour.

Errors

Code Description Explication
2 Customer appointments limit matched Le client a atteint le nombre maximum de rendez-vous à venir.
5 not Enough Credit For ProService Le client a épuisé son crédit de rendez-vous concernant la famille de rdv.
7 not Enough Credit For Employee OR Appointment overlap exception Le créneau n’est plus disponible ou bien l'employé a atteint le nombre maximum de rdv
4 Invalid data Paramètres incorrects, Erreur BDD
10 slot not available le créneau choisi n'est pas valide ou déja réservé
14 no employees available for service or template aucun employé n'est associé pour le type de rdv

Modification d'un rdv

Cette méthode permet de modifier les informations du sociétaire et du rdv.
Vous pouvez envoyer sulement les informations que vous souhaitez mettre à jour.

Resource URL (PUT) : https://maif.rdv-04.ovea.com/espaceRdvServer/ws/SaveCustomerAppointment

Argument Type Example Required Description
id Integer 1 Required

id technique du rdv

wlName String maif Required

id de la marque blanche

proName String parismagenta Required

identifiant de la délégation

locale String fr Optional

langue

motif String 103 Optional

code motif

canal String 1 Optional

code canal

employee String M00000 Optional

Code d'employé chez MAIF ( -1 si affectation aléatoire du rdv à l'employé)

date String 2019-01-29 Optional

date du rdv (yyyy-mm-dd)

hour Integer 15 Optional

heure du rdv (0 à 23)

minutes Integer 15 Optional

minutes (0 à 60)

duration Integer 15 Optional

minutes (5 à 240)

origin String api_erdv (fixed value) Required

l'origine d'accès aux services de ERDV

id_technique String 555555 Optional

Id technique du sociétaire.

lastname String test Optional

Nom sociétaire

firstname String test Optional

Prénom sociétaire

mobile String Optionnal

téléphone sociétaire

reference String 555555 Optional

référence du sociétaire

matricule_conseiller String 555555 (selfcare si pas de conseiller) Optional

matricule du conseiller à l'origine de la réservation ou "selfcare"

documents String doc1-doc2 Optional

Liste des documents (séparés par des tirets)

comment String test Optional

Commentaire RDV

matricule_conseiller_modificateur String 0001 Optional

matricule conseiller modificateur

nameAC String nom Optional

Nom de l'A&C

role String rôle Optional

Fonction de l'interlocuteur A&C

id_techniqueAC String id Optional

Id technique A&C

extra_data Json Object { "univers": "test", "motif": "test motif", "projet": "tes projett", "montant_versement": "test montant_versement", "montant_epargne": "test montant_epargne", "epargne_handicap": "test epargne_handicap", "appointment_comment": "test appointment_comment", "appointment_phone": "test appointment_phone", "appointment_email": "appointment.email@test.fr", "appointment_address1": "Complément adresse", "appointment_address2": "Adresse", "appointment_address3": "Cp", "appointment_address4": "Commune" } Optional

informations supplémentaires

Structure de l'objet extra_data :
{
"univers": "test",
"motif": "test motif",
"projet": "tes projett",
"montant_versement": "test montant_versement",
"montant_epargne": "test montant_epargne",
"epargne_handicap": "test epargne_handicap",
"appointment_comment": "test appointment_comment",
"appointment_phone": "test appointment_phone"
"appointment_email": "appointment.email@test.fr"
"appointment_address1": "Complément adresse"
"appointment_address2": "Adresse"
"appointment_address3": "Cp"
"appointment_address4": "Commune"
}

Response
Si la sauvegarde est réussie, vous recevrez la référence de rendez-vous et l'id du sociétaire crée ou mis à jour.

Errors

Code Description Explication
12 appointment not found l'id du rdv n'est pas correcte
13 Invalid data Paramètres incorrects, Erreur BDD
14 no employees available for service or template aucun employé n'est associé pour le type de rdv

Récupération d'un rdv

Cette méthode permet de récupérer les informations du sociétaire et du rdv.

Resource URL (GET) : https://maif.rdv-04.ovea.com/espaceRdvServer/ws/GetAppointmentById

Argument Type Example Required Description
id Integer 1 Required

id technique du rdv

wlName String maif Required

id de la marque blanche

Response
Si la sauvegarde est réussie, vous recevrez la référence de rendez-vous et l'id du sociétaire crée ou mis à jour.

Errors

Code Description Explication
500 appointment not found l'id du rdv n'est pas correcte

Postman



Télécharger les requêtes postman Télécharger





Création du rdv






Modification du rdv






Récupération du rdv