Description
Chaque personne a une collection de valeurs hebdomadaires ou périodiques d'un compteur de reporting. Pour les valeurs uniques d'un compteur de reporting, il est nécessaire d'utiliser un autre Web Service.
| URI | <uri_compteurs>/valeurs |
|---|---|
| Catégorie | http://schemas.holydis.com/tsq/2010#valeur_compteur_importe_hebdo_personne |
| Disponible en écriture | Oui |
Eléments
| Elément | Description | En écriture |
|---|---|---|
|
title |
La mention "Valeurs hebdomadaires d'un compteur importé" | |
| dateImport | La date de l’import du compteur | Par défaut, c'est la date du jour. |
| dateDebut | La date de début du cycle du compteur. Cette date permet notamment de savoir dans quelle semaine d'annualisation cette valeur doit s'alimenter. Elle a la même valeur que dateValeur. | |
| dateValeur | La date de valeur du compteur (le début de la semaine). Elle correspond à la date de valeur qui s'affiche dans le détail du compteur de reporting. | Obligatoire |
| valeur | La valeur du compteur. | Obligatoire |
| dateFin | La date de fin du compteur. Elle correspond à la date de fin d'un compteur à valeur périodique. Elle peut également servir à déterminer la date de fin dans le cas d'un compteur hebdomadaire se rapportant à une semaine partielle. Exemple : une valeur de DHR partielle. |
En écriture, la valeur du compteur (XXXXXYY) renseignée pour un compteur doit être entière. Elle est interprétée comme un nombre d'heures, un entier ou un réel selon la nature du compteur :
- Entier : YY sont deux chiffres exclus dans la lecture du nombre. 12300 correspond à une valeur de compteur de 123.
- Réel : YY sont les deux décimales de la valeur du compteur. 52698 correspond à une valeur de compteur de 526,98.
- Heure : YY représente les minutes et XXXXX les heures. 12238 correspond à une valeur de compteur de 122h38. En lecture, je récupère la valeur du compteur en minutes.
Exemples de requêtes
Lecture
Lire la valeur d’un compteur à valeur hebdomadaire dont l’identifiant en base est 32000, pour une personne dont l’identifiant en base est 16000
GET /[URI_de_base]/api/feed/personnes/16000/compteurs/32000/valeurs
Exemple de résultat XML de la requête
Exemple de résultat JSON de la requête
Lire la valeur d’un compteur à valeur périodique dont l’identifiant en base est 31000, pour une personne dont l’identifiant en base est 16000
GET /[URI_de_base]/api/feed/personnes/16000/compteurs/31000/valeurs
Exemple de résultat XML de la requête
Exemple de résultat JSON de la requête
Lire la valeur d’un compteur à valeur hebdomadaire dont l’identifiant en base est 32000, pour une personne dont l’identifiant en base est 16000 pour une date de début donnée (08/08/2022)
GET /[URI_de_base]/api/feed/personnes/16000/compteurs/32000/valeurs/2022-08-08
Lire la valeur d’un compteur à valeur périodique dont l’identifiant en base est 31000, pour une personne dont l’identifiant en base est 16000 pour une période donnée (du 01/07/2025 au 31/07/2025)
GET /[URI_de_base]/api/feed/personnes/16000/compteurs/31000/valeurs/2025-07-01
Ecriture
Ajouter une valeur pour la personne dont l’identifiant est 16008, pour le compteur à valeur hebdomadaire dont l’identifiant en base est 32000
POST /[URI_de_base]/api/feed/personnes/16008/compteurs/32000/valeurs
Exemple de résultat XML de la requête
Exemple de résultat JSON de la requête
Ajouter une valeur pour la personne dont l’identifiant est 16008, pour le compteur à valeur hebdomadaire pour une semaine partielle (du 07/07/2025 au 09/07/2025) dont l’identifiant en base est 32000
POST /[URI_de_base]/api/feed/personnes/16008/compteurs/32000/valeurs
Exemple de résultat XML de la requête
Exemple de résultat JSON de la requête
Ajouter une valeur pour la personne dont l’identifiant est 31000, pour le compteur à valeur périodique dont l’identifiant en base est 16000
POST /[URI_de_base]/api/feed/personnes/16000/compteurs/31000/valeurs
Exemple de résultat XML de la requête
Exemple de résultat JSON de la requête
Modifier une valeur pour la personne dont l’identifiant est 16008, pour le compteur à valeur hebdomadaire dont l’identifiant en base est 32000 pour une date de début donnée (08/08/2022)
PUT /[URI_de_base]/api/feed/personnes/16008/compteurs/32000/valeurs/2022-08-08
Modifier une valeur pour la personne dont l’identifiant est 31000, pour le compteur à valeur périodique dont l’identifiant en base est 16000 pour une période donnée (du 01/07/2025 au 31/07/2025)
PUT /[URI_de_base]/api/feed/personnes/16000/compteurs/31000/valeurs/2025-07-01
Supprimer une valeur pour la personne dont l’identifiant est 16008, pour le compteur à valeur hebdomadaire dont l’identifiant en base est 32000 pour une date de début donnée (08/08/2022)
DELETE /[URI_de_base]/api/feed/personnes/16008/compteurs/32000/valeurs/2022-08-08
Supprimer une valeur pour la personne dont l’identifiant est 31000, pour le compteur à valeur périodique dont l’identifiant en base est 16000 pour une période donnée (du 01/07/2025 au 31/07/2025)
DELETE /[URI_de_base]/api/feed/personnes/16000/compteurs/31000/valeurs/2025-07-01
Messages d'erreur fonctionnels
- Erreur 400 L'entry doit contenir une référence à une personne existante
- Erreur 400 Date renseignée non valide
- Erreur 400 La personne [NOM PRENOM] ne possède pas de compteur importé de type HEBDO
- Erreur 400 Le compteur à alimenter doit être externe
- Erreur 400 Le compteur à alimenter doit être de type valeur : HEBDO
- Erreur 400 La valeur [VALEUR] est incorrecte. Le compteur est de type "Heure" donc le nombre correspondant aux deux derniers chiffres de la valeur ne doit pas être supérieur ou égal à 60
- Erreur 404 Introuvable : [URI]
Commentaires
0 commentaire
Vous devez vous connecter pour laisser un commentaire.