Fonctions Plannings

Ajout / Modification / Suppression d'un planning

Fonction Variables Types Commentaires
setFichePlanning keyAccount string(32) Représente la clé du compte client.
token string(32) Token renvoyé par la fonction getToken().
codeInterv string(32) Est le code d'identification unique de l'intervention.
action string(1) "I" pour un ajout, "U" pour une modification, "D" pour supprimer.
jsonField string Tableau au format json des données de planning à créer.


Valeur de retour

Retourne un tableau JSON avec les données demandées.
Sinon renvoi une chaîne au format json contenant la cause de l'échec. Cf. Structure json message d'erreur




Tableau des valeurs pour un Planning

Noms Types Obligatoire Commentaires
TLP_matricule varchar(20) O Matricule de l'intervenant.
TLP_code_client varchar(32) O Identifiant unique du client.
TLP_code_contrat varchar(32) O Identifiant unique du contrat.
TLP_code_interv varchar(32) N Identifiant unique de l'intervention. (déprécié)
TLP_type_intervention varchar(50) O Nature de l'intervention(ménage, repassage, etc).
TLP_id_type_interv int(11) O Identifiant unique de la nature d'intervention(ménage, repassage, etc).
TLP_detail text N Détail de l'intervention.
TLP_commentaire text N Commentaires saisies par l'agent.
TLP_importance int(1) N Niveau d'importance de l'intervention.
TLP_checklist text N Retour des informations checklist saisies par l'agent.
TLP_tspDebut datetime O Format aaaa-mm-jj hh:mm:ss.
TLP_tspFin datetime O Format aaaa-mm-jj hh:mm:ss.
TLP_cout_std varchar(9) N Coût de l'intervention.
TLP_statut int(1) N 0=pas de pointage, 1=arrivée, 2=départ.
TLP_motif int(2) N Motif du retard.
TLP_tsp_synchro datetime O Horodatage de création de l'intervention.
TLP_id_intervention varchar(11) N Identifiant unique de l'intervention. Correspond à la variable 'codeInterv'.

Récupération d'information d'une intervention

Fonction Variables Types Commentaires
getPlanningIntervention keyAccount string(32) Représente la clé du compte client.
token string(32) Token renvoyé par la fonction getToken().
codeInterv string(32) Est le jour de l'intervention au format aaaa-mm-jj.
jsonField string Tableau au format json des données de planning à récupérer.

Même mécanique que pour la récupération des informations Clients ou Employés. Il suffit de préciser dans la variable "jsonField" les valeurs que vous souhaitez en retour.



Valeur de retour

Retourne un tableau JSON avec les données demandées.
Sinon renvoi une chaîne au format json contenant la cause de l'échec. Cf. Structure json message d'erreur

NB: La liste des valeurs se trouve dans le tableau de la section Ajout / Modification / Suppression d’un planning



Récupération d'information d'une journée

Fonction Variables Types Commentaires
getPlanningJour keyAccount string(32) Représente la clé du compte client.
token string(32) Token renvoyé par la fonction getToken().
dateInterv string(32) Est le jour de l'intervention au format aaaa-mm-jj.
jsonField string Tableau au format json des données de planning à récupérer.


Valeur de retour

Retourne un tableau JSON avec les données demandées.
Sinon renvoi une chaîne au format json contenant la cause de l'échec. Cf. Structure json message d'erreur

NB: La liste des valeurs se trouve dans le tableau de la section Ajout / Modification / Suppression d’un planning



Récupération du planning d'un agent

Fonction Variables Types Commentaires
getPlanningAgent keyAccount string(32) Représente la clé du compte client.
token string(32) Token renvoyé par la fonction getToken().
matricule string(9) Est le matricule ou le code d'indentification unique de l'employé.
dateInterv string(32) Est le jour de l'intervention au format aaaa-mm-jj.
jsonField string Tableau au format json des données de planning à récupérer.


Valeur de retour

Retourne un tableau JSON avec les données demandées.
Sinon renvoi une chaîne au format json contenant la cause de l'échec. Cf. Structure json message d'erreur

NB: La liste des valeurs se trouve dans le tableau de la section Ajout / Modification / Suppression d’un planning