Fonctions Pointages (par le superviseur)
Ajout d'un pointage (Attn: réservé uniquement pour certains comptes)
| Fonction | Variables | Types | Commentaires |
|---|---|---|---|
| setPointage | 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. | |
| matricule | string(9) | Est le matricule ou le code d'identification unique de l'employé. | |
| identifiant | string(32) | Est l'identifiant unique du pointage. | |
| jsonField | string | Tableau au format json des données de pointage à créer. |
Valeur de retour
Retourne 0 si la création s'est bien effectuée.
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 pointage (TLP signifie TéléPointage)
| Noms | Types | Obligatoire | Commentaires |
|---|---|---|---|
| TLP_code_interv | varchar(32) | O | Identifiant unique de l'intervention. |
| TLP_statut | int(1) | O | 1=début, 2=fin, 3=retard, 4=absence. |
| TLP_motif | int(3) | N | Code motif retard ou absence |
| TLP_tspDevice | datetime | O | Date et heure d'enregistrement dans le logiciel métier. (aaaa-mm-jj hh:mm:ss). |
NB: Le champ TLP_tspDevice représente l'horodatage des pointages effectués par téléphone, application Badgelio, ou application métier via le superviseur/responsable.
Récupération du pointage d'un agent
| Fonction | Variables | Types | Commentaires |
|---|---|---|---|
| getPointageAgent | 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'identification unique de l'employé. | |
| datePointage | date | 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.
"code_interv":"40FAC-D1D-9BF-948-A8DA7",
"matricule":"10810",
"code_client":"12345",
"id_pointage":"54321",
"tspServeur":"2012-08-13 10:56:14",
"tspDevice":"2012-08-13 10:56:10",
"coord_x":"",
"coord_y":"",
"mode":"S",
"statut":"2",
"commentaire":"Depot tapis au pressing",
"min_cplt":"17",
"km":"",
"tsp_synchro":"0000:00:00 00:00:00"
}
Sinon renvoi une chaîne au format json contenant la cause de l'échec. Cf. Structure json message d'erreur
Tableau des valeurs récupérables pour un pointage
| Noms | Types | Obligatoire | Commentaires |
|---|---|---|---|
| TLP_code_interv | varchar(32) | O | Identifiant unique de l'intervention reçue lors de la création d'une fiche intervention (setFichePlanning). |
| TLP_matricule | string(9) | N | Identifiant de l'employé reçu lors de la création d'une fiche employé (setFicheEmploye). |
| TLP_code_client | varchar(32) | N | identifiant unique du client/bénéficiaire reçu lors de la création d'une fiche client (setFicheClient) |
| TLP_id_pointage | int(11) | N | identifiant unique du pointage Badgelio |
| TLP_tspServeur | datetime | N | Horodatage du pointage arrivée sur les serveurs Badgelio. |
| TLP_tspDevice | datetime | N | Horodatage du pointage enregistré sur les serveurs Badgelio. |
| TLP_coord_x | string(20) | N | Coordonnées latitude GPS. |
| TLP_coord_y | string(20) | N | Coordonnées longitude GPS. |
| TLP_mode | string(1) | N | S=Smartphone, T=Téléphone, B=Boitier, A=Administratif. |
| TLP_statut | int(1) | N | 1=début, 2=fin. |
| TLP_motif | int(1) | N | Code de motif de retard. |
| TLP_commentaire | string(1000) | N | Commentaires saisies par l'agent. |
| TLP_min_cplt | int(6) | N | Minutes complémentaires a ajouter à l'heure d'arrivée. |
| TLP_km | string(10) | N | Nombre de kilomètre associé à l'intervention. |
| TLP_tsp_synchro | datetime | N | Horodatage de la première synchronisation des données avec le serveur(1). |
| TLP_legal_token | varchar(64) | N | Token attestant de la validité du pointage. Si option de valeur légale souscrite |
(1) Le paramètre 'TLP_tsp_synchro' contient la date à laquelle l'envoi du pointage a été éffectué et stocké dans nos serveurs. Renvoi '0000-00-00 00:00:00' la première fois, et une date heure les fois suivantes
NB: Les flux sont envoyés en une fois. Ainsi une même requête ayant un succès la première fois renverra t'il 4040 la deuxième fois. Si vous souhaitez les récupérer à nouveau, il suffit de renseigner le paramètre 'TLP_tsp_synchro' avec une date antérieur à celle de la première requête.
Récupération pointage d'une journée
| Fonction | Variables | Types | Commentaires |
|---|---|---|---|
| getPointageJour | keyAccount | string(32) | Représente la clé du compte client. |
| token | string(32) | Token renvoyé par la fonction getToken(). | |
| datePointage | date | Jour de l'intervention au format aaaa-mm-jj. | |
| jsonField | string | Tableau au format json des données de pointage à récupérer. |
Valeur de retour
Retourne un tableau JSON avec les données demandées. Les valeurs ne sont envoyées qu'une seule fois. Elles sont horodatées du jour et heure de la demande. 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 d'un pointage (par le superviseur). Astuce: Il est possible de récuperer de nouveau les données de pointage en mettant un horodatage antérieur d'au moins une seconde avant celle de la précédente demande. Pour ce faire il faut renseigner la valeur datePointage.