API Export Data Service v2

(Dernière mise à jour 21 avril 2020)

REMARQUE POUR LES UTILISATEURS D’API BEACON AU CANADA

Les données de votre service sont en cours de transfert ou ont déjà été transférées au Canada conformément à la réglementation canadienne sur les données transfrontalières. Par conséquent, si vous vous connectez à BEACON via beaconama.ca, vous devez modifier tous vos appels DE L’API » pour gérer des points de terminaison sur api.beaconama.ca.

Par exemple, remplacez

https://api.beaconama.net/v1/eds/read/

par

https://api.beaconama.ca/v1/eds/read/

Cette modification affecte l’ensemble des appels DE L’API » de point de terminaison pour les services se connectant à beaconama.ca.

EDS v2 offre plus d’options d’exportation des données aux services d’eau. Cela inclut plus d’en-têtes de colonnes, plus de paramètres et de nouveaux points de terminaison qui vous permettent d’exporter la consommation (y compris le nombre total de compteurs rapportant un débit > 0) et les données de fuites actuelles au niveau du programme.

Ce que vous devez savoir concernant EDS v2 :

• Les noms de paramètres et de colonnes sont différents de ceux utilisés dans EDS v1.
• Les colonnes sont dans un ordre différent par rapport à EDS v1.
• EDS v1 et EDS v2 sont tous deux actifs. (Si vous utilisez les deux, assurez-vous que les noms de vos paramètres et colonnes correspondent au point de terminaison d’API que vous appelez.)
• Si vous utilisez déjà EDS v1, aucune modification n’est nécessaire.
• La pagination, les options d’exportation et l’authentification sont identiques pour EDS v1 et EDS v2. (Reportez-vous à cette page pour les détails de pagination et d’authentification. Voir cette page pour la description des formats d’exportation.)
• Récupérez les résultats d’exportation à l’aide de GET /v1/eds/status/{edsUUID}.

Présentation d’EDS API v2

BEACON EDS API v2 fournit les méthodes suivantes pour prendre en charge la fonctionnalité d’exportation des données

/v2/eds/consumption

/v2/eds/range

/v2/eds/flow

/v2/eds/formatC

/v2/eds/leak

/v2/eds/read

/v2/eds/exception_range

eds/v1/status/{edsUUID}

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. En outre, l’accès à l’API doit être activé pour le service d’eau.

API du service d’exportation de données v2 BEACON

POST /v2/eds/consumption

Soumet une requête pour récupérer des données de consommation agrégées à une date de début et à une date de fin.

Remarque : l’en-tête Content-Type doit être défini sur application/x-www-form-urlencoded dans la requête.

Paramètres :

Nom du paramètre	Requis	Type	Description
End_Date		Date	Date de la requête;chaîne entre guillemets ISO 8601, par exemple « 2015-08-23T22:06:09Z ». La valeur par défaut du code est 23:59:59 dans le fuseau horaire du compteur si l’heure n’est pas fournie.
Has_Endpoint		Booléen	true pour limiter les résultats aux compteurs qui ont un point de terminaison, false pour les compteurs qui n’ont pas de point de terminaison, ou omettent d’inclure les deux.
Header_Columns		Texte	Liste des noms de colonnes à inclure dans la sortie : Day_of_Week Flow Flow_Time Flow_Unit Num_Meters Num_Meters compte le nombre total de compteurs avec un débit > 0.
Limit		Nombre	Limitent le nombre de compteurs pour lesquels des données sont renvoyées, utilisés pour la pagination. La valeur par défaut est de 25 000. Doit être comprise entre 1 et 25 000.
Location_Building_Type		Texte	Étiquette (par exemple, « commerce », « restaurant », « appartements ») utilisée pour filtrer dans BEACON Monitor.
Location_DHS_Code		Texte	Code du département des services de santé utilisé pour identifier les sources d’eau.
Location_District		Texte	Un identifiant unique pour le district.
Location_Funding		Texte	Étiquette pour le filtrage sur la page Monitor (Surveillance) de BEACON.
Location_Main_Use		Texte	Étiquette pour le filtrage sur la page Monitor (Surveillance) de BEACON.
Location_Site		Texte	Étiquette (par exemple « Campus nord », « Centre-ville ») pour filtrer dans BEACON Monitor.
Location_Water_Type		Texte	Étiquette (par exemple, « chaude », « froide », « potable », « recyclée ») pour filtrer dans BEACON Monitor.
Meter_Continuous_Flow		Texte	Yes/No.
Meter_ID		Texte	Un identifiant pour le compteur; peut être fourni plusieurs fois.
Meter_Size		Texte	Taille numérique du compteur. (5/8 = 0,625, 3/4 = 0,75, 1 1/2 = 1,5; etc.)
Last_Meter_ID		Texte	Identifiant facultatif utilisé pour la pagination des résultats de compteur.
Output_Format		Texte	Format de sortie à utiliser : • csv : produit des fichiers CSV simples avec des chaînes entre guillemets si nécessaire (format par défaut). • json : produit un JSON pour une utilisation par d’autres programmes.
CSV_Separator		Texte	Séparateur de colonnes à utiliser. Saisissez l’une des options suivantes : , ; : | ~ Par ex., un caractère unique pour la virgule (,), le point-virgule (;), les deux-points (:), la barre verticale (|) ou le tilde (~).
CSV_Quoting_Option		Texte	Incluez ou excluez les guillemets autour de tous les champs exportés dans un fichier CSV : all : incluez des guillemets autour de tous les champs. none : excluez les guillemets. Pour plus d’informations sur l’utilisation des guillemets, cliquez ici.
Resolution		Texte	Niveau d’agrégation : Daily (par défaut) Quarter_hourly Hourly Monthly
Service_Point_Class_Code		Texte	L’identifiant pour la classification/catégorie de facturation de ce point de raccordement dans le système de facturation, comme résidentiel, commercial, irrigation, etc.
Service_Point_Cycle		Texte	Un identificateur utilisé pour désigner le nom du cycle de facturation.
Service_Point_Route		Texte	L’identificateur du tracé ou du journal auquel le service facturé appartient.
Start_Date		Date	Date de la requête;chaîne entre guillemets ISO 8601, par exemple « 2015-08-23T22:06:09Z ». La valeur par défaut du code est 23:59:59 dans le fuseau horaire du compteur si l’heure n’est pas fournie.
Tolerance		Nombre	Le nombre d’heures auxquelles revenir en arrière pour la dernière lecture. Doit être >= 24.
Unit		Texte	Unité utilisée pour présenter les données de débit : • acrefeet • ccf • cubicfeet • cubicmeter • gallons (par défaut) • liter

POST EDS::Request

POST /v2/eds/consumption

# Utilisez ces paramètres pour publier une requête pour exporter
# la consommation agrégée pour une date de début et une date de fin avec une tolérance spécifique.
#
Service_Point_Cycle=11111
Start_Date=2016-02-01T00:00:00Z
End_Date=2016-02-29T23:59:59Z
Tolerance=72
Header_Columns=Flow,Flow_Time,Flow_Unit 
#

curl

# Utilisez cette déclaration cURL pour publier une requête pour exporter
# les données de consommation agrégée à une date de début et à une date de fin avec une tolérance spécifique.
#
curl -X POST -uusername:password \
-H "Content-Type: application/x-www-form-urlencoded" \
-d Service_Point_Cyce=11111 \
-d Start_Date=2016-02-01T00:00:00Z \
-d End_Date=2016-02-29T23:59:59Z \
-d Tolerance=72 \
-d Header_Columns=Flow,Flow_Time,Flow_Unit \
https://api.beaconama.net/v2/eds/consumption
#

POST EDS::Response

{
    "edsUUID": "70FC1B71-F0C3-4950-885C-A635E7C4E034",
    "statusUrl": "/v1/eds/status/70FC1B71-F0C3-4950-885C-A635E7C4E034"
}

Response

Returns EDSNew object.

202 Accepté – La requête EDS a été soumise correctement et il est possible de suivre l’état sur l’emplacement statusUrl.

• l’en-tête d’emplacement renvoie vers statusUrl

POST /v2/eds/range

Soumet une requête pour exporter les données de débit sur une plage de dates.

Remarque : l’en-tête Content-Type doit être défini sur application/x-www-form-urlencoded dans la requête.

Paramètres :

Nom du paramètre	Requis	Type	Description
End_Date		Date	Date de la requête;chaîne entre guillemets ISO 8601, par exemple « 2015-08-23T22:06:09Z ». La valeur par défaut du code est 23:59:59 dans le fuseau horaire du compteur si l’heure n’est pas fournie.
Has_Endpoint		Boolean	true pour limiter les résultats aux compteurs qui ont un point de terminaison, false pour les compteurs qui n’ont pas de point de terminaison, ou omettent d’inclure les deux.
Header_Columns		Texte	Liste des noms de colonnes à inclure dans la sortie : Account_Billing_Cycle Account_Email Account_First_Name Account_Full_Name Account_ID Account_Last_Name Account_Phone Account_Portal_Status Account_Status Alert_Code Backflow_Gallons Battery_Level Billing_Address_Line1 Billing_Address_Line2 Billing_Address_Line3 Billing_City Billing_Country Billing_State Billing_Zip Connector_Type Current_Leak_Rate Current_Leak_Start_Date Demand_Zone_ID Dials Endpoint_Install_Date Endpoint_SN Endpoint_Status Endpoint_Type Estimated_Flag Flow Flow_Time Flow_Unit High_Read_Limit Last_Comm_Time Location_Address_Line1 Location_Address_Line2 Location_Address_Line3 Location_Address_Parity Location_Area Location_Bathrooms Location_Building_Number Location_Building_Type Location_City Location_Continuous_Flow Location_Country Location_County_Name Location_DHS_Code Location_District Location_Funding Location_ID Location_Irrigated_Area Location_Irrigation Location_Latitude Location_Longitude Location_Main_Use Location_Name Location_Pool Location_Population Location_Site Location_State Location_Water_Type Location_Year_Built Location_Zip Low_Read_Limit Meter_Continuous_Flow Meter_ID Meter_Install_Date Meter_Manufacturer Meter_Model Meter_Note Meter_Size Meter_Size_Desc Meter_Size_Unit Meter_SN Person_ID Portal_ID Raw_Read Read Read_Code_1 Read_Code_2 Read_Code_3 Read_Method Read_Note Read_Sequence Read_Time Read_Time Read_Unit Reader_Initials Register_Note Register_Number Register_Resolution Register_Unit_Of_Measure SA_Start_Date Service_Point_Class_Code Service_Point_Class_Code_Normalized Service_Point_Cycle Service_Point_ID Service_Point_Latitude Service_Point_Longitude Service_Point_Route Service_Point_Timezone Service_Point_Type Signal_Strength Supply_Zone_ID Trouble_Code Utility_Use_1 Utility_Use_2 Utilisez les Column_Headers suivants pour renvoyer les données de capteur des compteurs Badger Meter E-Series Ultrasonic à capacité de détection de la pression et de la température de l’eau qui sont connectés à des points de terminaison ORION Cellular LTE ou LTE-M. Meter_Temp_Max Meter_Temp_Min Meter_Temp_Average Water_Pressure_Max Water_Pressure_Min Water_Pressure_Average Water_Temp_Max Water_Temp_Min Water_Temp_Average Endpoint_Temp_Max Endpoint_Temp_Min Endpoint_Temp_Average
Limit		Nombre	Limitent le nombre de compteurs pour lesquels des données sont renvoyées, utilisés pour la pagination. La valeur par défaut est de 25 000. Doit être comprise entre 1 et 25 000.
Location_Building_Type		Texte	Étiquette (par exemple, « commerce », « restaurant », « appartements ») utilisée pour filtrer dans BEACON Monitor.
Location_DHS_Code		Texte	Code du département des services de santé utilisé pour identifier les sources d’eau.
Location_District		Texte	Un identifiant unique pour le district.
Location_Funding		Texte	Étiquette pour le filtrage sur la page Monitor (Surveillance) de BEACON.
Location_Main_Use		Texte	Étiquette pour le filtrage sur la page Monitor (Surveillance) de BEACON.
Location_Site		Texte	Étiquette (par exemple « Campus nord », « Centre-ville ») pour filtrer dans BEACON Monitor.
Location_Water_Type		Texte	Étiquette (par exemple, « chaude », « froide », « potable », « recyclée ») pour filtrer dans BEACON Monitor.
Meter_Continuous_Flow		Texte	Yes/No.
Meter_ID		Texte	Un identifiant pour le compteur; peut être fourni plusieurs fois.
Meter_Size		Texte	Taille numérique du compteur. (5/8 = 0,625, 3/4 = 0,75, 1 1/2 = 1,5; etc.)
Last_Meter_ID		Texte	Identifiant facultatif utilisé pour la pagination des résultats de compteur.
Output_Format		Texte	Format de sortie à utiliser : • csv : produit des fichiers CSV simples avec des chaînes entre guillemets si nécessaire (format par défaut). • json : produit un JSON pour une utilisation par d’autres programmes.
CSV_Separator		Texte	Séparateur de colonnes à utiliser. Saisissez l’une des options suivantes : , ; : | ~ Par ex., un caractère unique pour la virgule (,), le point-virgule (;), les deux-points (:), la barre verticale (|) ou le tilde (~).
CSV_Quoting_Option		Texte	Incluez ou excluez les guillemets autour de tous les champs exportés dans un fichier CSV : all : incluez des guillemets autour de tous les champs. none : excluez les guillemets. Pour plus d’informations sur l’utilisation des guillemets, cliquez ici.
Resolution		Texte	Niveau d’agrégation : Daily (par défaut) Quarter_hourly Hourly Monthly
Service_Point_Class_Code		Texte	L’identifiant pour la classification/catégorie de facturation de ce point de raccordement dans le système de facturation, comme résidentiel, commercial, irrigation, etc.
Service_Point_Cycle		Texte	Un identificateur utilisé pour désigner le nom du cycle de facturation.
Service_Point_Route		Texte	L’identificateur du tracé ou du journal auquel le service facturé appartient.
Start_Date		Date	Date de la requête;chaîne entre guillemets ISO 8601, par exemple « 2015-08-23T22:06:09Z »,. La valeur par défaut du code est 23:59:59 dans le fuseau horaire du compteur si l’heure n’est pas fournie.
Tolerance		Nombre	Le nombre d’heures auxquelles revenir en arrière pour la dernière lecture. Doit être >= 24.
Unit		Texte	Unité utilisée pour présenter les données de débit : • acrefeet • ccf • cubicfeet • cubicmeter • gallons (par défaut) • liter

POST EDS::Request

POST /v2/eds/range

# Utilisez ces paramètres pour soumettre une requête pour exporter# les données de débit sur une plage de dates.
Service_Point_Cycle=11111 \Start_Date=2015-08-23T22:06:09Z \End_Date=2015-12-31T22:06:09Z \Tolerance=72 \Header_Columns=Account_ID,Meter_ID,Read \#

curl

 # Utilisez cette déclaration cURL pour publier une requête # pour exporter les données de débit sur une plage de dates.
# curl -uusername:password \
-H "Content-Type: application/x-www-form-urlencoded" \
-d Service_Point_Cycle=11111 \
-d Location_District=las \
-d Start_Date=2015-08-23 \
-d End_Date=2015-12-31T22:06:09Z \
-d Tolerance=72 \
-d Header_Columns=Account_ID,Meter_ID,Read \
https://api.beaconama.net/v2/eds/range
#

Response

{
    "edsUUID": "70FC1B71-F0C3-4950-885C-A635E7C4E034",
    "statusUrl": "/v1/eds/status/70FC1B71-F0C3-4950-885C-A635E7C4E034"
}

Returns EDSNew object.

202 Accepté – La requête EDS a été soumise correctement et il est possible de suivre l’état sur l’emplacement statusUrl.

• l’en-tête d’emplacement renvoie vers statusUrl

POST /v2/eds/flow

Soumet une requête pour récupérer les données et lectures de débit agrégées d’exportation à une date et à une tolérance données. Voir le schéma des processus de l’API BEACON Export Data Services (en anglais).

Remarque : l’en-tête Content-Type doit être défini sur application/x-www-form-urlencoded dans la requête.

Paramètres :

Nom du paramètre	Requis	Type	Description
End_Date		Date	Date de la requête;chaîne entre guillemets ISO 8601, par exemple « 2015-08-23T22:06:09Z ». La valeur par défaut du code est 23:59:59 dans le fuseau horaire du compteur si l’heure n’est pas fournie.
Has_Endpoint		Boolean	true pour limiter les résultats aux compteurs qui ont un point de terminaison, false pour les compteurs qui n’ont pas de point de terminaison, ou omettent d’inclure les deux.
Header_Columns		Texte	Liste des noms de colonnes à inclure dans la sortie : Account_Billing_Cycle Account_Email Account_First_Name Account_Full_Name Account_ID Account_Last_Name Account_Phone Account_Portal_Status Account_Status Alert_Code Backflow_Gallons Battery_Level Billing_Address_Line1 Billing_Address_Line2 Billing_Address_Line3 Billing_City Billing_Country Billing_State Billing_Zip Connector_Type Current_Leak_Rate Current_Leak_Start_Date Dials Endpoint_Install_Date Endpoint_SN Endpoint_Status Endpoint_Type Flow Flow_Unit High_Read_Limit Last_Comm_Time Location_Address_Line1 Location_Address_Line2 Location_Address_Line3 Location_Address_Parity Location_Area Location_Bathrooms Location_Building_Number Location_Building_Type Location_City Location_Continuous_Flow Location_Country Location_County_Name Location_DHS_Code Location_District Location_Funding Location_ID Location_Irrigated_Area Location_Irrigation Location_Latitude Location_Longitude Location_Main_Use Location_Name Location_Pool Location_Population Location_Site Location_State Location_Water_Type Location_Year_Built Location_Zip Low_Read_Limit Meter_Continuous_Flow Meter_ID Meter_Install_Date Meter_Manufacturer Meter_Model Meter_Note Meter_Size Meter_Size_Desc Meter_Size_Unit Meter_SN Person_ID Point_1_Read Point_1_Read_Time Point_2_Read Point_2_Read_Time Portal_ID Read_Unit Register_Number Register_Resolution Register_Unit_Of_Measure SA_Start_Date Service_Point_Class_Code Service_Point_Class_Code_Normalized Service_Point_Cycle Service_Point_ID Service_Point_Latitude Service_Point_Longitude Service_Point_Route Service_Point_Timezone Service_Point_Type Signal_Strength Utility_Use_1 Utility_Use_2 Utilisez les Column_Headers suivants pour renvoyer les données de capteur des compteurs Badger Meter E-Series Ultrasonic à capacité de détection de la pression et de la température de l’eau qui sont connectés à des points de terminaison ORION Cellular LTE ou LTE-M. Meter_Temp_Max Meter_Temp_Min Meter_Temp_Average Water_Pressure_Max Water_Pressure_Min Water_Pressure_Average Water_Temp_Max Water_Temp_Min Water_Temp_Average Endpoint_Temp_Max Endpoint_Temp_Min Endpoint_Temp_Average
Limit		Nombre	Limitent le nombre de compteurs pour lesquels des données sont renvoyées, utilisés pour la pagination. La valeur par défaut est de 25 000. Doit être comprise entre 1 et 25 000.
Location_Building_Type		Texte	Étiquette (par exemple, « commerce », « restaurant », « appartements ») utilisée pour filtrer dans BEACON Monitor.
Location_DHS_Code		Texte	Code du département des services de santé utilisé pour identifier les sources d’eau.
Location_District		Texte	Un identifiant unique pour le district.
Location_Funding		Texte	Étiquette pour le filtrage sur la page Monitor (Surveillance) de BEACON.
Location_Main_Use		Texte	Étiquette pour le filtrage sur la page Monitor (Surveillance) de BEACON.
Location_Site		Texte	Étiquette (par exemple « Campus nord », « Centre-ville ») pour filtrer dans BEACON Monitor.
Location_Water_Type		Texte	Étiquette (par exemple, « chaude », « froide », « potable », « recyclée ») pour filtrer dans BEACON Monitor.
Meter_Continuous_Flow		Texte	Yes/No.
Meter_ID		Texte	Un identifiant pour le compteur; peut être fourni plusieurs fois.
Meter_Size		Texte	Taille numérique du compteur. (5/8 = 0,625, 3/4 = 0,75, 1 1/2 = 1,5; etc.)
Last_Meter_ID		Texte	Identifiant facultatif utilisé pour la pagination des résultats de compteur.
Output_Format		Texte	Format de sortie à utiliser : • csv : produit des fichiers CSV simples avec des chaînes entre guillemets si nécessaire (format par défaut). • json : produit un JSON pour une utilisation par d’autres programmes.
CSV_Separator		Texte	Séparateur de colonnes à utiliser. Enter one of: , ; : | ~ Par ex., un caractère unique pour la virgule (,), le point-virgule (;), les deux-points (:), la barre verticale (|) ou le tilde (~).
CSV_Quoting_Option		Texte	Incluez ou excluez les guillemets autour de tous les champs exportés dans un fichier CSV : all : incluez des guillemets autour de tous les champs. none : excluez les guillemets. Pour plus d’informations sur l’utilisation des guillemets, cliquez ici.
Resolution		Texte	Niveau d’agrégation : Daily (par défaut) Quarter_hourly Hourly Monthly
Service_Point_Class_Code		Texte	L’identifiant pour la classification/catégorie de facturation de ce point de raccordement dans le système de facturation, comme résidentiel, commercial, irrigation, etc.
Service_Point_Cycle		Texte	Un identificateur utilisé pour désigner le nom du cycle de facturation.
Service_Point_Route		Texte	L’identificateur du tracé ou du journal auquel le service facturé appartient.
Start_Date		Date	Date de la requête;chaîne entre guillemets ISO 8601, par exemple « 2015-08-23T22:06:09Z ». La valeur par défaut du code est 23:59:59 dans le fuseau horaire du compteur si l’heure n’est pas fournie.
Tolerance		Nombre	Le nombre d’heures auxquelles revenir en arrière pour la dernière lecture. Doit être >= 24.
Unit		Texte	Unité utilisée pour présenter les données de débit : • acrefeet • ccf • cubicfeet • cubicmeter • gallons (par défaut) • liter

POST /eds/v2/flow

# Utilisez ces paramètres pour publier une requête pour exporter# des données et des lectures de débit agrégés à une date de début et à une date de fin.
#
Service_Point_Cycle=11111
Start_Date=2016-02-01T00:00:00Z
End_Date=2016-02-29T23:59:59Z
Header_Columns=Account_ID,Meter_ID,Flow
#

curl

# Utilisez cette déclaration cURL pour publier une requête pour exporter les données et lectures de débit agrégées 
# à une date de début et à une date de fin.
#
curl -X POST -uusername:password \
-H "Content-Type: application/x-www-form-urlencoded" \
-d Service_Point_Cycle=11111 \
-d Location_District=las \
-d Start_Date=2016-02-01T00:00:00Z \
-d End_Date=2016-02-29T23:59:59Z \
-d Header_Columns=Account_ID,Meter_ID,Flow \ 
https://api.beaconama.net/v2/eds/flow
#

POST EDS::Response

{
    "edsUUID": "70FC1B71-F0C3-4950-885C-A635E7C4E034",
    "statusUrl": "/v1/eds/status/70FC1B71-F0C3-4950-885C-A635E7C4E034"
}

POST /v2/eds/formatc

Publiez une requête pour exporter les données de lecture de facturation les plus récentes à l’aide d’un fichier d’entrée au Format C dans la tolérance indiquée. Ce point de terminaison de l’API utilise les informations du compteur et du compte du fichier fourni comme filtres. Les données renvoyées seront au Format C, conformément au fichier d’origine, plutôt qu’au format CSV.

Remarque : l’en-tête Content-Type doit être défini sur multipart/form-data dans la requête.

Paramètres :

Nom du paramètre	Requis	Type	Description
Data		File	Le fichier d’entrée au Format C à partir duquel extraire les informations du compteur et du compte.
Date		Date	Date de la requête;chaîne entre guillemets ISO 8601, par exemple « 2015-08-23T22:06:09Z ». La valeur par défaut du code est 23:59:59 dans le fuseau horaire du compteur si l’heure n’est pas fournie.
Tolerance		Nombre	Le nombre d’heures auxquelles revenir en arrière pour la dernière lecture. Doit être >= 24.

POST /v2/eds/formatc

# Utilisez ces paramètres pour publier une requête pour exporter 
# les données de lecture de facturation les plus récentes à l’aide d’un fichier au Format C, 
# dans la tolérance indiquée.
#
Data=$HOME/Desktop/my-format-c-data.txt
Date=2015-08-23T22:06:09Z
Tolerance=72
#

curl

# Utilisez cette déclaration cURL pour publier une requête pour exporter
# les données de lecture de facturation les plus récentes à l’aide d’un fichier d’entrée au Format C, 
# à l’intérieur de la tolérance indiquée.
#
curl -uusername:password \
-H "Content-Type: multipart/form-data" \
-F Data=@$HOME/Desktop/my-format-c-data.txt \
-F Date=2015-08-23T22:06:09Z \
-F Tolerance=72 \https://api.beaconama.net/v2/eds/formatc
#

POST EDS::Response

{    
"edsUUID": 
"70FC1B71-F0C3-4950-885C-A635E7C4E034",    
"statusUrl": 
"/v1/eds/status/70FC1B71-F0C3-4950-885C-A635E7C4E034"}

Response

Returns EDSNew object.

202 Accepté – La requête EDS a été soumise correctement et il est possible de suivre l’état sur l’emplacement statusUrl.

• l’en-tête d’emplacement renvoie vers statusUrl

POST /v2/eds/leak

Publiez une requête pour exporter une liste des compteurs présentant une fuite, la date de début de la fuite et le taux de fuite actuel.

Remarque : l’en-tête Content-Type doit être défini sur application/x-www-form-urlencoded dans la requête.

POST EDS::RequestPOST /v2/eds/leak

# Utilisez ces paramètres pour publier une requête pour exporter les données# pour les compteurs avec des fuites à une date de début et une date de fin.
#Service_Point_Cycle=11111Header_Columns=Account_ID,Meter_ID,Current_Leak_Start_Date,Current_Leak_Rate#

curl

# Utilisez cette déclaration cURL pour publier une requête pour exporter une liste des compteurs # présentant une fuite, la date de début de la fuite et le taux de fuite actuel.
#
curl -X POST -uusername:password \
-H "Content-Type: application/x-www-form-urlencoded" \
-d Service_Point_Cyce=11111 \
-d Header_Columns=Account_ID,Meter_ID,Current_Leak_Start_Date,Current_Leak_Rate \
https://api.beaconama.net/v2/eds/leak
#

POST EDS::Response

{
    "edsUUID": "70FC1B71-F0C3-4950-885C-A635E7C4E034",
    "statusUrl": "/v2/eds/status/70FC1B71-F0C3-4950-885C-A635E7C4E034"
}

Response

Returns EDSNew object.

202 Accepté – La requête EDS a été soumise correctement et il est possible de suivre l’état sur l’emplacement statusUrl.

• • l’en-tête d’emplacement renvoie vers statusUrl

POST /v2/eds/read

Soumet une requête pour récupérer les données de lecture de facturation les plus récentes pour les filtres et la tolérance indiqués.

Remarque : l’en-tête Content-Type doit être défini sur application/x-www-form-urlencoded dans la requête.

Paramètres :

Nom du paramètre	Requis	Type	Description
Date		Date	Date de la requête;chaîne entre guillemets ISO 8601, par exemple « 2015-08-23T22:06:09Z ». La valeur par défaut du code est 23:59:59 dans le fuseau horaire du compteur si l’heure n’est pas fournie.
Has_Endpoint		Boolean	true pour limiter les résultats aux compteurs qui ont un point de terminaison, false pour les compteurs qui n’ont pas de point de terminaison, ou omettent d’inclure les deux.
Header_Columns		Texte	Liste des noms de colonnes à inclure dans la sortie : Account_Billing_Cycle Account_Email Account_First_Name Account_Full_Name Account_ID Account_Last_Name Account_Phone Account_Portal_Status Account_Status Alert_Code Backflow_Gallons Battery_Level Billing_Address_Line1 Billing_Address_Line2 Billing_Address_Line3 Billing_City Billing_Country Billing_Read Billing_Read_Unit Billing_State Billing_Zip Connector_Type Current_Leak_Rate Current_Leak_Start_Date Demand_Zone_ID Dials Encoder_Read Endpoint_Install_Date Endpoint_SN Endpoint_Status Endpoint_Type High_Read_Limit Last_Comm_Time Location_Address_Line1 Location_Address_Line2 Location_Address_Line3 Location_Address_Parity Location_Area Location_Bathrooms Location_Building_Number Location_Building_Type Location_City Location_Continuous_Flow Location_Country Location_County_Name Location_DHS_Code Location_District Location_Funding Location_ID Location_Irrigated_Area Location_Irrigation Location_Latitude Location_Longitude Location_Main_Use Location_Name Location_Pool Location_Population Location_Site Location_State Location_Water_Type Location_Year_Built Location_Zip Low_Read_Limit Meter_Continuous_Flow Meter_ID Meter_Install_Date Meter_Manufacturer Meter_Model Meter_Note Meter_Size Meter_Size_Desc Meter_Size_Unit Meter_SN Person_ID Portal_ID Raw_Read Read Read_Code_1 Read_Code_2 Read_Code_3 Read_Method Read_Note Read_Sequence Read_Time Read_Unit Reader_Initials Register_Note Register_Number Register_Resolution Register_Unit_Of_Measure SA_Start_Date Service_Point_Class_Code Service_Point_Class_Code_Normalized Service_Point_Cycle Service_Point_ID Service_Point_Latitude Service_Point_Longitude Service_Point_Route Service_Point_Timezone Service_Point_Type Signal_Strength Tamper_Code Trouble_Code Utility_Use_1 Utility_Use_2 Utilisez les Column_Headers suivants pour renvoyer les données de capteur des compteurs Badger Meter E-Series Ultrasonic à capacité de détection de la pression et de la température de l’eau qui sont connectés à des points de terminaison ORION Cellular LTE ou LTE-M. Meter_Temp_Max Meter_Temp_Min Meter_Temp_Average Water_Pressure_Max Water_Pressure_Min Water_Pressure_Average Water_Temp_Max Water_Temp_Min Water_Temp_Average Endpoint_Temp_Max Endpoint_Temp_Min Endpoint_Temp_Average
Limit		Nombre	Limitent le nombre de compteurs pour lesquels des données sont renvoyées, utilisés pour la pagination. La valeur par défaut est de 25 000. Doit être comprise entre 1 et 25 000.
Location_Building_Type		Texte	Étiquette (par exemple, « commerce », « restaurant », « appartements ») utilisée pour filtrer dans BEACON Monitor.
Location_DHS_Code		Texte	Code du département des services de santé utilisé pour identifier les sources d’eau.
Location_District		Texte	Un identifiant unique pour le district.
Location_Funding		Texte	Étiquette pour le filtrage sur la page Monitor (Surveillance) de BEACON.
Location_Main_Use		Texte	Étiquette pour le filtrage sur la page Monitor (Surveillance) de BEACON.
Location_Site		Texte	Étiquette (par exemple « Campus nord », « Centre-ville ») pour filtrer dans BEACON Monitor.
Location_Water_Type		Texte	Étiquette (par exemple, « chaude », « froide », « potable », « recyclée ») pour filtrer dans BEACON Monitor.
Meter_Continuous_Flow		Texte	Yes/No.
Meter_ID		Texte	Un identifiant pour le compteur; peut être fourni plusieurs fois.
Meter_Size		Texte	Taille numérique du compteur. (5/8 = 0,625, 3/4 = 0,75, 1 1/2 = 1,5; etc.)
Last_Meter_ID		Texte	Identifiant facultatif utilisé pour la pagination des résultats de compteur.
Output_Format		Texte	Format de sortie à utiliser : • csv : produit des fichiers CSV simples avec des chaînes entre guillemets si nécessaire (format par défaut). • json : produit un JSON pour une utilisation par d’autres programmes.
CSV_Separator		Texte	Séparateur de colonnes à utiliser. Saisissez l’une des options suivantes : , ; : | ~ Par ex., un caractère unique pour la virgule (,), le point-virgule (;), les deux-points (:), la barre verticale (|) ou le tilde (~).
CSV_Quoting_Option		Texte	Incluez ou excluez les guillemets autour de tous les champs exportés dans un fichier CSV : all : incluez des guillemets autour de tous les champs. none : excluez les guillemets. Pour plus d’informations sur l’utilisation des guillemets, cliquez ici.
Resolution		Texte	Niveau d’agrégation : Daily (par défaut) Quarter_hourly Hourly Monthly
Service_Point_Class_Code		Texte	L’identifiant pour la classification/catégorie de facturation de ce point de raccordement dans le système de facturation, comme résidentiel, commercial, irrigation, etc.
Service_Point_Cycle		Texte	Un identificateur utilisé pour désigner le nom du cycle de facturation.
Service_Point_Route		Texte	L’identificateur du tracé ou du journal auquel le service facturé appartient.
Tolerance		Nombre	Le nombre d’heures auxquelles revenir en arrière pour la dernière lecture. Doit être >= 24. S’ils ne sont pas indiqués, EDS renvoie la dernière lecture disponible pour chaque compteur.
Unit		Texte	Unité utilisée pour présenter les données de débit : • acrefeet • ccf • cubicfeet • cubicmeter • gallons (par défaut) • liter

POST EDS::Request

POST /v2/eds/read

# Utilisez ces paramètres pour soumettre une requête pour récupérer # les données de lecture de facturation les plus récentes pour les filtres# et la tolérance indiqués.
#
Meter_Id=abc123
Meter_Id=xyz789
Date=2015-08-23T22:06:09Z
Tolerance=72
Header_Columns=Account_ID,Meter_ID,Read
#

curl

# Utilisez cette déclaration cURL pour publier une requête
# pour récupérer les données de lecture de facturation les plus récentes pour
# les filtres et la tolérance indiqués.
#
curl -uusername:password \
-H "Content-Type: application/x-www-form-urlencoded" \
-d Meter_Id=abc123 \
-d Meter_Id=xyz789 \
-d Date=2015-12-31T22:06:09Z \
-d Tolerance=72 \
-d Header_Columns=Account_ID,Meter_ID,Read \
https://api.beaconama.net/v2/eds/read
#

POST EDS::Response

{
    "edsUUID": "70FC1B71-F0C3-4950-885C-A635E7C4E034",
    "statusUrl": "/v1/eds/status/70FC1B71-F0C3-4950-885C-A635E7C4E034"
}

Response

Returns EDSNew object.

202 Accepté – La requête EDS a été soumise correctement et il est possible de suivre l’état sur l’emplacement statusUrl.

• l’en-tête d’emplacement renvoie vers statusUrl

POST /v2/eds/exception_range

Soumet une requête pour récupérer un rapport des exceptions historiques

Remarque : l’en-tête Content-Type doit être défini sur application/x-www-form-urlencoded dans la requête.

Paramètres :

Nom du paramètre	Requis	Type	Description
Location_Building_Type		Texte	Étiquette facultative indiquant le type de bâtiment (par exemple, « commerce », « restaurant », « appartements »)
Continuous_Flow_Expected		Texte	Yes/No
Location_DHS_Code		Texte	Code du Département des services de santé facultatif
Location_District		Texte	Un identifiant unique pour le district
End_Date		Date	Date de la requête;chaîne entre guillemets ISO 8601, par exemple "2015-08-23T22:06:09Z". La valeur par défaut du code est 23:59:59 dans le fuseau horaire du compteur si l’heure n’est pas fournie
Location_Funding		Texte	Étiquette de budget facultative
Has_Endpoint		Boolean	true pour limiter les résultats aux compteurs qui ont un point de terminaison, false pour les compteurs qui n’ont pas de point de terminaison, ou omettent d’inclure les deux
Header_Columns		Texte	Liste des noms de colonnes à inclure dans la sortie : Location_Name Register_Number Endpoint_SN Meter_ID Meter_SN Service_Point_Timezone Exception_Start_Date Exception_End_Date Exception Account_ID Location_ID Account_Full_Name Billing_Address_Line1 Billing_Address_Line2 Billing_Address_Line3 Billing_City Billing_State Billing_Zip Service_Point_ID Service_Point_Class_Code Service_Point_Route Service_Point_Cycle Meter_Manufacturer Meter_Model Register_Resolution Register_Unit_Of_Measure Meter_Size M eter_Size_Desc Dials Service_Point_Latitude Service_Point_Longitude Endpoint_Type Connector_Type Endpoint_Status Supply_Zone_ID Demand_Zone_ID

Utilisez les Column_Headers suivants pour renvoyer les données de capteur des compteurs Badger Meter E-Series Ultrasonic à capacité de détection de la pression et de la température de l’eau qui sont connectés à des points de terminaison ORION Cellular LTE ou LTE-M.

Meter_Temp_Max
Meter_Temp_Min
Meter_Temp_Average
Water_Pressure_Max
Water_Pressure_Min
Water_Pressure_Average
Water_Temp_Max
Water_Temp_Min
Water_Temp_Average
Endpoint_Temp_Max
Endpoint_Temp_Min
Endpoint_Temp_Average

Limit Nombre Limitent le nombre de compteurs pour lesquels des données sont renvoyées, utilisés pour la pagination. La valeur par défaut est de 10000. Doit être comprise entre 1 et 10 000

Location_Main_Use Texte Étiquette facultative d’utilisation principale

Meter_ID Texte Un identifiant pour le compteur; peut être fourni plusieurs fois

Meter_Size TexteTaille numérique du compteur (5/8 = 0,625, 3/4 = 0,75, 1 1/2 = 1,5, etc.)

Last_Meter_ID Nombre Identifiant facultatif utilisé pour la pagination des résultats de compteur.

Output_Format Texte Format de sortie à utiliser :

• csv : produit des fichiers CSV simples avec des chaînes entre guillemets si nécessaire (format par défaut)
• json : produit un JSON pour une utilisation par d’autres programmes

Service_Point_Route Texte L’identificateur du tracé ou du journal auquel le service facturé appartient

Service_Point_Class_Code Texte L’identifiant pour la classification/catégorie de facturation de ce point de raccordement dans le système de facturation, comme résidentiel, commercial, irrigation, etc.

Service_Point_Cycle Texte Un identificateur utilisé pour désigner le nom du cycle de facturation

Location_Site Texte Étiquette facultative de site (par exemple, « Campus nord », « Centre-ville »)

Start_DateDate Date de la requête;chaîne entre guillemets ISO 8601, par exemple "2015-08-23T22:06:09Z".

La valeur par défaut du code est 23:59:59 dans le fuseau horaire du compteur si l’heure n’est pas fournie

Location_Water_Type Texte Étiquette facultative de type d’eau (par exemple, « chaude », « froide », « potable », « recyclée »)

POST EDS::Request

POST /v2/eds/exception_range

Service_Point_Cycle=11111
Start_Date=2019-09-01T00:00:00Z
End_Date=2019-09-27T23:59:59Z
Header_Columns=Account_ID,Meter_ID,Exception_Start_Date,Exception_End_Date,Exception

curl

curl -X POST -uusername:password \
-H "Content-Type: application/x-www-form-urlencoded" \
-d Service_Point_Cycle=11111 \
-d Location_District=las \
-d Start_Date=2016-02-01T00:00:00Z \
-d End_Date=2016-02-29T23:59:59Z \
-d Header_Columns=Account_ID,Meter_ID,Exception_Start_Date,Exception_End_Date,Exception \
https://api.beaconama.net/v2/eds/exception_range

POST EDS::Response

{
    "edsUUID": "70FC1B71-F0C3-4950-885C-A635E7C4E034",
    "statusUrl": "/v2/eds/status/70FC1B71-F0C3-4950-885C-A635E7C4E034"
}

Response

Returns EDSNew object.

202 Accepté – La requête EDS a été soumise correctement et il est possible de suivre l’état sur l’emplacement statusUrl.

• l’en-tête d’emplacement renvoie vers statusUrl

GET /v1/eds/status/{edsUUID}

Récupère l’état de la requête d’exportation des données de lecture de facturation pour l’EDS UUID fourni.

Paramètres :

Nom du paramètre	Requis	Type	Description
edsUUID		UUID	Un identifiant pour la requête.

GET EDS::Request

# # Utilisez cette commande pour récupérer l’état# le plus récent de l’exportation de lecture de facturation.
#GET /v1/eds/status/70FC1B71-F0C3-4950-885C-A635E7C4E034#

curl

# Utilisez cette déclaration cURL pour récupérer# l’état d’exportation de la lecture de facturation.
#curl -uusername:password https://api.beaconama.net/v1/eds/status/70FC1B71-F0C3-4950-885C-A635E7C4E034#

GET EDS status::Response::Queued

{    
    "state": "queue",
    "message": "Export operation queued for processing.",
    "queueTime": "2015-01-14T23:50:59Z"
}

GET EDS status::Response::Running

{    
    "startTime": "2015-01-15T00:00:00Z",
    "state": "run",
    "progress": {
        "percentComplete": "12.0",
        "ETA": "2015-01-15T01:02:31Z",
        "message": "performing validation"
    },
    "message": "Export operation running.",
    "queueTime": "2015-01-14T23:50:59Z"
}

GET EDS status::Response::Exception

{
    "startTime": "2015-01-15T00:00:00Z",
    "state": "exception",
    "endTime": "2015-01-15T01:02:30Z",
    "message": "Export operation had problems.",
    "queueTime": "2015-01-14T23:50:59Z"
}

GET EDS status::Response::Complete

{    
    "startTime": "2015-01-15T00:00:00Z",
    "state": "done",
    "endTime": "2015-01-15T01:02:30Z",
    "message": "Export operation succeeded.",
    "queueTime": "2015-01-14T23:50:59Z",
    "reportUrl": "/v1/content/. . ."
}

Response

Returns EDSStatus object.

Voir la documentation Export Date Service API v1 pour les exportations CSV, les objets JSON et les codes d’état HTTP.