Les API Export Data Service (EDS) v1 et v2 sont utilisées pour exporter des données via une interface HTTP standard. Ces services sont principalement utilisés pour interagir avec un système de fournisseur de facturation pour extraire les lectures les plus récentes du système. L’API d’importation d’échange de données BEACON offre l’option à l’appelant d’importer les données de lecture de facturation dans BEACON. EDS est l’équivalent de ce service pour l’exportation.
Lorsqu’une exportation est terminée, les données peuvent être téléchargées au format CSV conformément à l’exportation de lecture de facturation et à la spécification d’échange de données ou comme fichiers à colonnes de largeur fixe.
Pour des instructions sur la configuration des fichiers à colonnes de largeur fixe, voir Exporter des fichiers à colonnes de largeur fixe.
La pagination, les options de sortie et l’authentification – décrites ci-dessous – sont identiques pour EDS v1 et EDS v2.
Pagination
Les méthodes de consommation, de débit, de plage et de lecture d’EDS exportent les résultats pour un maximum de 150 000 mètres par appel. Pour exporter plus d’enregistrements, vous devez effectuer des appels supplémentaires pour :
- Analyser le fichier de résultats initial pour trouver le dernier ID de compteur renvoyé
- Utilisez le paramètre lastMeterID (EDS v1) ou Last_Meter_ID (EDS v2) pour transmettre ce dernier ID de compteur à BEACON
- Répétez l’étape 1 et l’étape 2 jusqu’à ce qu’aucun résultat ne soit renvoyé.
Les résultats de pagination diffèrent selon le type d’exportation effectuée et plusieurs variables. Par exemple, les exportations Latest Read (Lecture la plus récente) et Billing Read (Lecture de facturation) produisent une lecture par compteur; par conséquent, le résultat sera généralement égal au nombre de compteurs, jusqu’à la limite de 150 000 par appel.
D’autres variables, comme la plage de dates, la résolution et le fait que les compteurs aient des registres simples ou combinés affectera le nombre d’enregistrements par page. Par exemple, l’obtention d’une année de données horaires pour un seul compteur produit une exportation de 8 760 enregistrements (24 * 365 = 8 760). L’obtention d’une année de données horaires pour un compteur combiné produit une exportation de 17 520 enregistrements (2 * 8760 = 17 520).
Une opération d’exportation unique peut exporter un maximum de 1 048 576 enregistrements (1 024 * 1 024).
JSON traite la pagination en affichant des résultats par lots qui s’étendent du compteur x (« from ») au compteur y (« to »). L’exemple de code ci-dessous montre une exportation de 10 000 compteurs pour un service d’eau avec un total de 62 762 compteurs. La ligne 2 affiche le nombre total de compteurs du portefeuille du service d’eau. La ligne 3 montre que l’exportation commence à partir du compteur n (« from ») et est incrémentée d’un compteur à la fois jusqu’au compteur 10 000 (« to »), comme indiqué à la ligne 4.
{\n'
"total": 62762,\n'
"from": 1,\n'
"to": 10000,\n'
"results": [\n'
{\n'
"Account_ID": "7689934000",\n'
"Location_ID": "04307700000430777607",\n'
"Meter_ID": "19501966",\n'
"Endpoint_SN": "36223176",\n'
"Register_Number": "single",\n'
"Service_Point_ID": "1",\n'
"Flow": 7021.20000,\n'
"Flow_Time": "2015-07",\n'
"Flow_Unit": "Gallons"\n'
},\n'
Les exportations au format CSV ne paginent pas les résultats.
Authentification
L’authentification est une authentification de base, pour laquelle l’appelant a besoin d’un nom d’utilisateur et d’un mot de passe BEACON valides.
Voir API Export Data Service v1 pour de la documentation sur les méthodes et les fonctionnalités d’exportation prises en charge par EDS v1.
Voir API Export Data Service v2 pour de la documentation sur les méthodes et les fonctionnalités d’exportation prises en charge par EDS v2.
