Je souhaite récupérer les données de température d’un des foyers anonymes.
Quelle requête utiliser avec quels paramètres ?
Pour récupérer les données de consommation globale d’un foyer, il faut récupérer l’identifiant du foyer.
Il s’agit du placeId => voir la discussion « https://forum.etalab.gouv.fr/t/api-ijenko-donnees-de-comptage-comment-acceder-aux-donnees-dun-foyer » pour récupérer le placeId.
=> Faire l’appel suivant pour récupérer l’identifiant de la fonctionnalité de température.
GET <URL>/places/<placeId>/functionalities?functionalities=Temperature&token=<token>
// <URL> à remplacer par l’URL de l’API
// <placeId> à remplacer par l’identifiant du foyer tel indique ci-dessus
// <token> à remplacer par le token fourni par IJENKO à l’équipe.
La réponse a le format suivant:
[{
"id": "54Aay9XPYMQFQJ6cA7m4yA", // il s'agit du functionalityId qu'il faut utiliser dans les appels suivants
"device": "4CJKy9XPYOZXQL6cA4m4tQ",
"class": "Temperature",
"endpoint": 1,
"tags": []
}]
1. Récupération historiques température mesurée (en °C)
GET <URL>/functionalities/><functionalityId>/attributes?names=MeasuredValue&from=2016-05-15T22:59:59Z&to=2016-05-16T21:59:59Z&token=<token>
// <URL> à remplacer par l’URL de l’API
// <functionalityId> à remplacer par l’identifiant de la fonctionnalité de température récupérée avec l’appel décrit ci-haut
// <token> à remplacer par le token fourni par IJENKO à l’équipe.
// le filtre from indique la date à partir de laquelle on veut récupérer l’historique (optionnel), au format AAAA-MM-DDT00:00:59Z
// le filtre to indique la date à la fin de laquelle on veut récupérer l’historique (optionnel), au format AAAA-MM-DDT00:00:59Z
// Si les filtres ne sont pas fournis alors on récupère tout l’historique jusqu’à la date courante. L’exemple fournit les données du 16 Mai.
La réponse a le format suivant - Données factices fournies en exemple :
ATTENTION : LE TIMESTAMP EST AU FORMAT UTA => DECALAGE POUR PARIS EN GMT+1 ou GMT+2
Les données de température sont remontées lorsqu’elles changent => cela signifie qu’entre 2 timestamp, la T° n’a pas changé
Les données sont en °C
{
"MeasuredValue": [
{
"value": 22.7,
"when": "2016-05-16T04:49:23Z"
},
{
"value": 22.4,
"when": "2016-05-16T10:18:54Z"
},
{
"value": 22.2,
"when": "2016-05-16T10:39:52Z"
},
{
"value": 22,
"when": "2016-05-16T11:00:50Z"
},
{
"value": 21.8,
"when": "2016-05-16T11:36:46Z"
},
{
"value": 22,
"when": "2016-05-16T12:48:37Z"
},
{
"value": 22.2,
"when": "2016-05-16T13:51:30Z"
}
]
}
2. Récupération historiques Moyenne, max et min journalièrs (en °C)
GET <URL>/functionalities/<functionalityId>/attributes?names=DayAverage,DayMax,DayMin&from=2016-05-10T22:59:59Z&to=2016-05-11T21:59:59Z&token=<token>
// <URL> à remplacer par l’URL de l’API
// functionalityId à remplacer par l’identifiant de la fonctionnalité de température récupérée avec l’appel décrit ci-haut
// <token> à remplacer par le token fourni par IJENKO à l’équipe.
// le filtre from indique la date à partir de laquelle on veut récupérer l’historique (optionnel), au format AAAA-MM-DDT00:00:59Z
// le filtre to indique la date à la fin de laquelle on veut récupérer l’historique (optionnel), au format AAAA-MM-DDT00:00:59Z
// Si les filtres ne sont pas fournis alors on récupère tout l’historique jusqu’à la date courante. L’exemple fournit les données du 11 Mai.
La réponse a le format suivant - Données factices fournies en exemple :
Les données sont en °C
{
"DayAverage": [
{
"value": 24.1,
"when": "2016-05-11T21:59:59Z"
}
],
"DayMax": [
{
"value": 24.4,
"when": "2016-05-11T21:59:59Z"
}
],
"DayMin": [
{
"value": 23.6,
"when": "2016-05-11T21:59:59Z"
}
]
}