Web Services - Reporting counters

Voir la version française.

Description

Each resource is a reporting counter.

URI	<url_de_base>/api/feed/compteurs
Category	http://schemas.holydis.com/tsq/2010#compteur
Available for writing	No

Specific settings

Setting

Description

typeCompteur

Filters only counters of the selected type: EXTERNE (external), CALCULE (calculated), CALCULE_HEURE (calculated hours), TEMPS_TRAVAIL (attendance - work time), ABSENCES_HEURES (balance of absences - in hours), ABSENCES_JOURS (absence in days), ABSENCES_JOUR_REEL (absences in real days), SOLDE_ABSENCE_HEURE (balance of absences in hours), TEMPS_PAUSE (breaks), TEMPS_SPECIFIQUES (specific times), DUREE_TACHES(attendance - task duration).

Elements

Element	Description
title	Label.
code	Counter code.
sourceC	Counter source.
unite	Counter unit.
nature	Counter type.
seuilMin	Minimum threshold of the counter.
seuilMax	Maximum threshold of the counter.
dateDebut	Start date of the counter.
dateFin	End date of the counter.
typeValeurs	The type of counter value (unique / weekly), for imported counters.
valeurInitiale	Initial value of the counter.
aIncrementer	Counter incrementation (true) or not (false).
type	Type of the counter (INTERNAL, EXTERNAL, CALCULATED).
origine	Structure on which the counter is created.

Examples of requests

Reading

Read all reporting counters

GET /[URI_de_base]/api/feed/compteurs

Read the counter whose database identifier is 31000
 

GET /[URI_de_base]/api/feed/compteurs/31000

Example of request XML results

Example of request JSON results

Read external counters

GET /[URI_de_base]/api/feed/compteurs?typeCompteur=EXTERNE

Read calculated counters

GET /[URI_de_base]/api/feed/compteurs?typeCompteur=CALCULE

Read attendance counters (work time)

GET /[URI_de_base]/api/feed/compteurs?typeCompteur=TEMPS_TRAVAIL

Read attendance counters (task duration)
 

GET /[URI_de_base]/api/feed/compteurs?typeCompteur=DUREE_TACHES

Read absence counters

GET /[URI_de_base]/api/feed/compteurs?typeCompteur=ABSENCES_JOURS

Read balance of absence counters (in hours)
 

GET /[URI_de_base]/api/feed/compteurs?typeCompteur=ABSENCES_HEURES

Read break counters

GET /[URI_de_base]/api/feed/compteurs?typeCompteur=TEMPS_PAUSE

Read specific times counters

GET /[URI_de_base]/api/feed/compteurs?typeCompteur=TEMPS_SPECIFIQUES