GetAvailableSlots
Cette méthode retourne les créneaux disponibles pour une ou plusieurs délégations au plus tôt possible.
Pour récupérer les créneaux de la semaine suivante (ou autre semaine), vous devez envoyer la date de début.
Pour récupérer les créneaux de plusieurs délégations, il faut passer dans le paramétre pros les identifiants des délégations séparés par des points-virgules.
Exemple : pros=7590;7530
Pour récupérer les créneaux de la semaine suivante (ou autre semaine), vous devez envoyer la date de début.
Exemple :
Pour récuperer les créneaux du matin : envoyer firstHour="" et lastHour = "12:00"
Pour récuperer les créneaux d'après-midi : envoyer firstHour="14:00" et lastHour = ""
Pour récuperer les créneaux sur une période personnalisée de la journée : envoyer firstHour="11:00" et lastHour = "16:00"
Pour récupérer les créneaux du prochain Lundi : il faut envoyer dayOfWeek = 2 et dayCount=1
Pour récupérer les créneaux des 5 prochains Lundi : il faut envoyer dayOfWeek = 2 et dayCount=5
dayOfWeek représente l'index du jour dans la semaine :
- Dimanche : 1
- Lundi : 2
- Mardi : 3
- Mercredi : 4
- Jeudi : 5
- Vendredi : 6
- Samedi : 7
Pour récupérer les créneaux d'un conseiller, il faut envoyer le code MAIF de l'employé dans le paramétre employee.
Exemple : employee=85500M
Resource URL (GET) : https://maif.rdv-04.ovea.com/espaceRdvServer/ws/GetAvailableSlots
Argument | Type | Example | Required | Description |
---|---|---|---|---|
wlName |
String |
maif (fixed value) |
Required | id de la marque blanche |
pros |
String |
7590;7530 |
Required | identifiant de la délégation ou liste des identifiants des délégations (séparés par des points virgules si plusieurs délégations) |
motif |
String |
103 |
Required | code motif |
canal |
String |
1 |
Required | code canal |
employee |
String |
M00000 |
Optional | Code d'employé chez MAIF (null ou -1 pour récupérer les créneaux de toute la délégation , "selon disponibilités des employés" ) |
date |
String |
2019-01-29 |
Optional | date depuis laquelle l'application retourne les disponibilités ( null ou vide pour récupérer les créaneaux disponible au plus tôt) |
dayOfWeek |
Integer |
2 |
Optional | Jour de la semaine (entre 1 et 7) |
dayCount |
Integer |
3 |
Optional | Nombre de jour à récupérer depuis une date (entre 1 et 7) |
firstHour |
String |
08:00 |
Optional | Heure de début (HH:mm) |
lastHour |
String |
16:00 |
Optional | Heure de fin (HH:mm) |
duration |
Integer |
15 |
Optional | minutes (5 à 240) |
Exceptions :
Code status | Message |
---|---|
400 Bad Request | wrong parameters format : pros |
400 Bad Request | wrong parameters format : wlName |
400 Bad Request | wrong parameters format : motif |
400 Bad Request | wrong parameters format : canal |
400 Bad Request | wwrong parameters format : date . format yyyy-MM-dd |
400 Bad Request | wrong parameters format : dayCount must be integer |
400 Bad Request | wlName not found |
400 Bad Request | template or service not found |
400 Bad Request | no employees available for service or template |
500 Bad Internal Server Error | Internal Server Error |