Vue générale

GET /api/v1/channel_data

Renvoie la liste des relevés de l’unité de comptage, ventilée par type d’archive et par intervalle de temps du fournisseur de ressources.

Paramètres de requête

archive_type string

Type d’archive pour lequel les données sont exportées. La liste des types d’archive figure dans le tableau « Référentiel des types d’archive ».

equipment_id integer

Identifiant de l’appareil de comptage pour lequel les données sont exportées.

fp_start string

Intervalle de temps (début du segment), au format yyyy-mm-dd, pour lequel les données sont exportées.

fp_end string

Intervalle de temps (fin du segment), au format yyyy-mm-dd, pour lequel les données sont exportées.

page integer

Numéro de page.

Champs de la réponse

AttributDescription
event_timeDate et heure des relevés du compteur au format UTC
channel_dataDonnées de l’archive. Les données dépendent des paramètres type d’archive et type de correcteur de l’appareil de comptage. La description des canaux de paramètres figure dans le tableau « Référentiel des paramètres de canal d’une unité de comptage »
dataTableau des données renvoyées
total_pagesNombre total de pages dans le jeu renvoyé
current_pagePage en cours
next_pagePage suivante disponible au téléchargement, null si la page en cours est la dernière

Requête

bash
curl -i \
  --header "access-token: *********************" \
  --header "token-type: Bearer" \
  --header "client: **********************" \
  --header "uid: api-user@example.com" \
  --header "Content-Type: application/json" \
  --request GET \
  "https://api.vadsro.eu/api/v1/channel_data?archive_type=hourly&equipment_id=25&fp_end=2021-02-20&fp_start=2021-02-01&page=2"

Réponse

Dernière mise à jour le

Cette page vous a-t-elle été utile ?