Services disponibles sur l'API Congé
L’API FitnetCongé fournit 4 services :
- Test d'activation : Test permettant de savoir si l'api est active sur un environnement.
- Exemple de congé format JSON: Permet de retourner un exemple de congé sous format JSON.
- Création d'un congé : Permet de créer un congé.
- Suppression d'un congé : Permet la supprimer un congé.
Test d'activation
Pour tester si l’API est active sur un environnement on effectue un GET sur l'url :
sousDomaine.fitnetmanager.com/FitnetManager/seam/resource/rest/congeApi/ tenantId/activeApi
- sousDomaine est le sous domaine de votre environnement (ex. : prod, demo ... ).
- tenantId : correspond à l’identifiant de votre environnement client sur la plateforme mutualisée.
Cette fonction retourne un boolean : true si l'API est active / false si l'API est désactivée
Exemple de congé au format JSON
Pour avoir un exemple de congé sous format JSON on effectue un GET sur l'url "sousDomaine.fitnetmanager.com/FitnetManager/seam/resource/rest/congeApi/formatJsonExample"
Exemple de retour :
{"conge":
{"congeId":1,"designation":"Congé Api Test", "email":"support@fitnetapplication.com", "tenantId":"tenantId",
"typesAbsences":[
{"dateDebut":"22\/08\/2012","dateFin":"23\/08\/2012","debutMidi":1,"finiMidi":0,"typeId":1},
{"dateDebut":"24\/08\/2012","dateFin":"24\/08\/2012","debutMidi":0,"finiMidi":0,"typeId":2},
{"dateDebut":"25\/08\/2012","dateFin":"25\/08\/2012","debutMidi":0,"finiMidi":1,"typeId":3}
]}}
Création d'un congé
Pour la création d'un congé on utilise une méthode POST via l'url "sousDomaine.fitnetmanager.com/FitnetManager/seam/resource/rest/congeApi/creeConge" , en passant en paramètre un objet Congé sous format JSON .
Exemple de congé au format JSON à passer en paramètre :
{"conge":
{ "congeId":1,
"designation":"Congé Api Test",
"email":"support@fitnetapplication.com",
"tenantId":"tenantId",
"typesAbsences":[
{"dateDebut":"22/08/2012","dateFin":"23/08/2012","debutMidi":1,"finiMidi":0,"typeId":1},
{"dateDebut":"24/08/2012","dateFin":"24/08/2012","debutMidi":0,"finiMidi":0,"typeId":2},
{"dateDebut":"25/08/2012","dateFin":"25/08/2012","debutMidi":0,"finiMidi":1,"typeId":3}
]
}}
congeId : Valeur numérique : permet d'identifier le congé sur le système tiers.
designation : Chaine de caractères.
email : Chaine de caractères : permet d'identifier le collaborateur dans fitnetmanager, le congé sera crée pour tous les collaborateurs qui ont cette adresse mail.
tenantId : Chaine de caractères : identifiant unique d'une l'application qui permet à l'API de crée le congé sur le bon environnement.
typesAbsences : un tableau, contenant les propriétés suivantes :
dateDebut : Chaine de caractères sou la forme jj/MM/AAAA.
dateFin : Chaine de caractères sou la forme jj/MM/AAAA.
finiMidi : Valeur numérique : 1 si vrais 0 si faux.
debutMidi : Valeur numérique : 1 si vrais 0 si faux.
typeId : Valeur numérique : Id du type d’absence sur le système tiers qui doit être renseigné sur le type d’absence correspondant dans FitnetManager (voir 3.3 Synchronisation des type de congés).
Suppression d'un congé
Pour la suppression d'un congé on utilise une méthode POST via l'url "sousDomaine.fitnetmanager.com/FitnetManager/seam/resource/rest/congeApi/supprimerConge" et en passant deux paramètres.
tenantId : correspond au nom du tenant.
congeId : Id du congé sur le système tiers à supprimer sur Fitnet Manager.
Modification d'un congé
La modification d’un congé passe par une suppression puis une recréation.
L’API Congé ne propose pas de fonction Update d’un congé.
Si un Congé est transmis 2 fois en création avec le même identifiant congeId, il sera rejeté : cf. codes retour.