API del Export Data Service v2

(Última actualización el 21 de abril de 2020)

NOTA PARA LOS USUARIOS DE LA API DE BEACON EN CANADÁ

De acuerdo con las regulaciones canadienses sobre datos transfronterizos, sus datos de servicios públicos se trasladan o ya se trasladaron a Canadá. Como resultado, si inicia sesión en BEACON a través de beaconama.ca, deberá ajustar todas sus llamadas a la interfaz de programación de aplicaciones (application programming interface, API) para abordar las terminales en api.beaconama.ca.

Por ejemplo, cambie
https://api.beaconama.net/v1/eds/read/
a
https://api.beaconama.ca/v1/eds/read/

Este cambio afecta a todas las llamadas a la terminal de la API para las empresas de servicios públicos que inician sesión en beaconama.ca.

El EDS v2 ofrece a las empresas de servicios públicos más opciones para exportar datos. Se incluyen más columnas de encabezado, más parámetros y nuevas terminales que le permiten exportar de manera programática los datos de consumo (incluida la cantidad total de medidores que informan un flujo >0) y los datos de fugas actuales.

Lo que necesita saber sobre el EDS v2:

• Los nombres de los parámetros y las columnas son diferentes a los del EDS v1.
• Las columnas están en un orden diferente al del EDS v1.
• Tanto el EDS v1 como el EDS v2 están activos. (Si usa ambos, asegúrese de que los nombres de sus parámetros y columnas se alineen con la terminal de la API a la que se llama).
• Si ya está usando el EDS v1, no es necesario que realice ningún cambio.
• La paginación, las opciones de exportación y la autenticación son idénticas para el EDS v1 y el EDS v2. (Consulte esta página para obtener detalles sobre la paginación y la autenticación. Consulte esta página para obtener descripciones de los formatos de exportación).
• Recupere los resultados de la exportación al usar el método GET /v1/eds/status/{edsUUID}.

Descripción general de la API del EDS v2

La API del EDS v2 de BEACON proporciona los siguientes métodos para admitir la funcionalidad de exportación de datos.

/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}

Autenticación

La autenticación es una autenticación básica, en la que la persona que llama necesita un nombre de usuario y una contraseña de BEACON válidos. Además, el acceso a la API debe estar habilitado para la empresa de servicios públicos.

API de Export Data Services de BEACON v2

POST /v2/eds/consumption

Esto envía una solicitud para recuperar los datos de consumo agregados en una fecha inicial y final.

Nota: El encabezado Content-Type debe asignarse como application/x-www-form-urlencoded en la solicitud.

Parámetros:

Nombre del parámetro	Requerido	Tipo	Descripción
End_Date		Fecha	Fecha solicitada; cadena entre comillas ISO 8601, p. ej. “2015-08-23T22:06:09Z”. El código predeterminado será 23:59:59 en la zona horaria del medidor si no se proporciona el componente de hora.
Has_Endpoint		Booleano	Es verdadero para limitar los resultados de los medidores que tienen una terminal, es falso para los medidores que no tienen una terminal, o se omite para incluir ambos.
Header_Columns		Texto	Lista de nombres de columna para incluir en la salida: Day_of_Week Flow Flow_Time Flow_Unit Num_Meters Num_Meters cuenta el número total de medidores con un flujo >0.
Limit		Número	Limita el número de medidores para los que se recuperan los datos; se utiliza para la paginación. El valor predeterminado es 25000. Debe estar entre 1 y 25000.
Location_Building_Type		Texto	La etiqueta (p. ej. «tienda», «restaurante», «apartamentos») se usa para filtrar en el Monitor de BEACON.
Location_DHS_Code		Texto	El código del Departamento de Servicios de Salud se usa para identificar fuentes de agua.
Location_District		Texto	Un identificador único para el distrito.
Location_Funding		Texto	La etiqueta se usa para filtrar en el Monitor de BEACON.
Location_Main_Use		Texto	La etiqueta se usa para filtrar en el Monitor de BEACON.
Location_Site		Texto	La etiqueta (p. ej. «Campus Norte», «Norte de la ciudad») se usa para filtrar en el Monitor de BEACON.
Location_Water_Type		Texto	La etiqueta (p. ej. «caliente», «fría», «potable», «regenerada») se usa para filtrar en el Monitor de BEACON.
Meter_Continuous_Flow		Texto	Sí/No.
Meter_ID		Texto	Es un identificador del medidor; se puede proporcionar varias veces.
Meter_Size		Texto	Tamaño numérico del medidor. (5/8 = .625, 3/4 = .75, 1 1/2 = 1.5, etc.)
Last_Meter_ID		Texto	Identificador opcional utilizado para la paginación de los resultados del medidor.
Output_Format		Texto	Formato de salida a utilizar: • csv: produce archivos CSV simples con cadenas entre comillas cuando es necesario (predeterminado). • json: produce JSON para su uso en otros programas.
CSV_Separator		Texto	Separador de columnas a utilizar. Ingrese alguna opción, ya sea: , ; : | ~ p. ej. un solo carácter para coma (,), punto y coma (;), dos puntos (:), barra (|) o virgulilla (~).
CSV_Quoting_Option		Texto	Incluya o excluya las comillas alrededor de todos los campos exportados en un archivo CSV: todos: comillas en todos los campos. ninguno: excluir comillas. Para obtener más información sobre el uso de comillas, haga clic aquí.
Resolution		Texto	Nivel de agregación: Daily (predeterminado) Quarter_Hourly Hourly Monthly
Service_Point_Class_Code		Texto	Identificador de la clasificación/categoría de facturación de este punto de servicio en el sistema de facturación, p. ej. residencial, comercial, riego, etc.
Service_Point_Cycle		Texto	Un identificador que se usa para indicar el nombre del ciclo de facturación.
Service_Point_Route		Texto	Identificador de la ruta o cartera a la que pertenece el servicio de medidor.
Start_Date		Fecha	Fecha solicitada; cadena entre comillas ISO 8601, p. ej. “2015-08-23T22:06:09Z”. El código predeterminado será 23:59:59 en la zona horaria del medidor si no se proporciona el componente de hora.
Tolerance		Número	Cuántas horas debe buscar hacia atrás para ver la última lectura. Debe ser >= 24.
Unit		Texto	Unidad en la cual se presentarán los datos de flujo: • acres pies • ccf • pies cúbicos • metros cúbicos • galones (predeterminado) • litros

Método POST en el EDS::Solicitud

POST /v2/eds/consumption

# Use estos parámetros a fin de publicar una solicitud para exportar el consumo
# agregado para una fecha inicial y final con una tolerancia determinada.
#
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

# Use este enunciado cURL a fin de publicar una solicitud para exportar el consumo
# agregado para una fecha inicial y final con una tolerancia determinada.
#
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
#

Método POST en el EDS::Respuesta

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

Respuesta

Recupera el objeto EDSNew.

202 Accepted: La solicitud del EDS se envió correctamente y se puede seguir el estado en la ubicación statusUrl.

• el encabezado de ubicación dirige hacia statusUrl

POST /v2/eds/range

Envía una solicitud para exportar los datos de flujo dentro de un rango de fechas.

Nota: El encabezado Content-Type debe asignarse como application/x-www-form-urlencoded en la solicitud.

Parámetros:

Nombre del parámetro	Requerido	Tipo	Descripción
End_Date		Fecha	Fecha solicitada; cadena entre comillas ISO 8601, p. ej. “2015-08-23T22:06:09Z”. El código predeterminado será 23:59:59 en la zona horaria del medidor si no se proporciona el componente de hora.
Has_Endpoint		Booleano	Es verdadero para limitar los resultados de los medidores que tienen una terminal, es falso para los medidores que no tienen una terminal, o se omite para incluir ambos.
Header_Columns		Texto	Lista de nombres de columna para incluir en la salida: 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 Utilice los siguientes Column_Headers para recuperar los datos del sensor de los medidores ultrasónicos de la serie E de Badger Meter con capacidad de detección de temperatura y presión de agua que están conectados a terminales ORION Cellular LTE o 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		Número	Limita el número de medidores para los que se recuperan los datos; se utiliza para la paginación. El valor predeterminado es 25000. Debe estar entre 1 y 25000.
Location_Building_Type		Texto	La etiqueta (p. ej. «tienda», «restaurante», «apartamentos») se usa para filtrar en el Monitor de BEACON.
Location_DHS_Code		Texto	El código del Departamento de Servicios de Salud se usa para identificar fuentes de agua.
Location_District		Texto	Un identificador único para el distrito.
Location_Funding		Texto	La etiqueta se usa para filtrar en el Monitor de BEACON.
Location_Main_Use		Texto	La etiqueta se usa para filtrar en el Monitor de BEACON.
Location_Site		Texto	La etiqueta (p. ej. «Campus Norte», «Norte de la ciudad») se usa para filtrar en el Monitor de BEACON.
Location_Water_Type		Texto	La etiqueta (p. ej. «caliente», «fría», «potable», «regenerada») se usa para filtrar en el Monitor de BEACON.
Meter_Continuous_Flow		Texto	Sí/No.
Meter_ID		Texto	Es un identificador del medidor; se puede proporcionar varias veces.
Meter_Size		Texto	Tamaño numérico del medidor. (5/8 = .625, 3/4 = .75, 1 1/2 = 1.5, etc.)
Last_Meter_ID		Texto	Identificador opcional utilizado para la paginación de los resultados del medidor.
Output_Format		Texto	Formato de salida a utilizar: • csv: produce archivos CSV simples con cadenas entre comillas cuando es necesario (predeterminado). • json: produce JSON para su uso en otros programas.
CSV_Separator		Texto	Separador de columnas a utilizar. Ingrese alguna opción, ya sea: , ; : | ~ p. ej. un solo carácter para coma (,), punto y coma (;), dos puntos (:), barra (|) o virgulilla (~).
CSV_Quoting_Option		Texto	Incluya o excluya las comillas alrededor de todos los campos exportados en un archivo CSV: todos: comillas en todos los campos. ninguno: excluir comillas. Para obtener más información sobre el uso de comillas, haga clic aquí.
Resolution		Texto	Nivel de agregación: Daily (predeterminado) Quarter_Hourly Hourly Monthly
Service_Point_Class_Code		Texto	Identificador de la clasificación/categoría de facturación de este punto de servicio en el sistema de facturación, p. ej. residencial, comercial, riego, etc.
Service_Point_Cycle		Texto	Un identificador que se usa para indicar el nombre del ciclo de facturación.
Service_Point_Route		Texto	Identificador de la ruta o cartera a la que pertenece el servicio de medidor.
Start_Date		Fecha	Fecha solicitada; cadena entre comillas ISO 8601, p. ej. “2015-08-23T22:06:09Z”,. El código predeterminado será 23:59:59 en la zona horaria del medidor si no se proporciona el componente de hora.
Tolerance		Número	Cuántas horas debe buscar hacia atrás para ver la última lectura. Debe ser >= 24.
Unit		Texto	Unidad en la cual se presentarán los datos de flujo: • acres pies • ccf • pies cúbicos • metros cúbicos • galones (predeterminado) • litros

Método POST en el EDS::Solicitud

POST /v2/eds/range

# Use estos parámetros a fin de enviar una solicitud para exportar
# datos de flujo dentro de un rango de fechas.
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

 
# Use este enunciado cURL a fin de publicar una solicitud
# para exportar datos de flujo dentro de un rango de fechas.
# 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
#

Respuesta

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

Da como respuesta el objeto EDSNew.

202 Accepted: La solicitud del EDS se envió correctamente y se puede seguir el estado en la ubicación statusUrl.

• el encabezado de ubicación dirige hacia statusUrl

POST /v2/eds/flow

Envía una solicitud para recuperar los datos de flujo agregados de exportación y las lecturas en una fecha y tolerancia determinadas. Consulte el Diagrama de procesos de la API del Export Data Service de BEACON.

Nota: El encabezado Content-Type debe asignarse como application/x-www-form-urlencoded en la solicitud.

Parámetros:

Nombre del parámetro	Requerido	Tipo	Descripción
End_Date		Fecha	Fecha solicitada; cadena entre comillas ISO 8601, p. ej. “2015-08-23T22:06:09Z”. El código predeterminado será 23:59:59 en la zona horaria del medidor si no se proporciona el componente de hora.
Has_Endpoint		Booleano	Es verdadero para limitar los resultados de los medidores que tienen una terminal, es falso para los medidores que no tienen una terminal, o se omite para incluir ambos.
Header_Columns		Texto	Lista de nombres de columna para incluir en la salida: 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 Utilice los siguientes Column_Headers para recuperar los datos del sensor de los medidores ultrasónicos de la serie E de Badger Meter con capacidad de detección de temperatura y presión de agua que están conectados a terminales ORION Cellular LTE o 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		Número	Limita el número de medidores para los que se recuperan los datos; se utiliza para la paginación. El valor predeterminado es 25000. Debe estar entre 1 y 25000.
Location_Building_Type		Texto	La etiqueta (p. ej. «tienda», «restaurante», «apartamentos») se usa para filtrar en el Monitor de BEACON.
Location_DHS_Code		Texto	El código del Departamento de Servicios de Salud se usa para identificar fuentes de agua.
Location_District		Texto	Un identificador único para el distrito.
Location_Funding		Texto	La etiqueta se usa para filtrar en el Monitor de BEACON.
Location_Main_Use		Texto	La etiqueta se usa para filtrar en el Monitor de BEACON.
Location_Site		Texto	La etiqueta (p. ej. «Campus Norte», «Norte de la ciudad») se usa para filtrar en el Monitor de BEACON.
Location_Water_Type		Texto	La etiqueta (p. ej. «caliente», «fría», «potable», «regenerada») se usa para filtrar en el Monitor de BEACON.
Meter_Continuous_Flow		Texto	Sí/No.
Meter_ID		Texto	Es un identificador del medidor; se puede proporcionar varias veces.
Meter_Size		Texto	Tamaño numérico del medidor. (5/8 = .625, 3/4 = .75, 1 1/2 = 1.5, etc.)
Last_Meter_ID		Texto	Identificador opcional utilizado para la paginación de los resultados del medidor.
Output_Format		Texto	Formato de salida a utilizar: • csv: produce archivos CSV simples con cadenas entre comillas cuando es necesario (predeterminado). • json: produce JSON para su uso en otros programas.
CSV_Separator		Texto	Separador de columnas a utilizar. Ingrese alguna opción, ya sea: , ; : | ~ p. ej. un solo carácter para coma (,), punto y coma (;), dos puntos (:), barra (|) o virgulilla (~).
CSV_Quoting_Option		Texto	Incluya o excluya las comillas alrededor de todos los campos exportados en un archivo CSV: todos: comillas en todos los campos. ninguno: excluir comillas. Para obtener más información sobre el uso de comillas, haga clic aquí.
Resolution		Texto	Nivel de agregación: Daily (predeterminado) Quarter_Hourly Hourly Monthly
Service_Point_Class_Code		Texto	Identificador de la clasificación/categoría de facturación de este punto de servicio en el sistema de facturación, p. ej. residencial, comercial, riego, etc.
Service_Point_Cycle		Texto	Un identificador que se usa para indicar el nombre del ciclo de facturación.
Service_Point_Route		Texto	Identificador de la ruta o cartera a la que pertenece el servicio de medidor.
Start_Date		Fecha	Fecha solicitada; cadena entre comillas ISO 8601, p. ej. “2015-08-23T22:06:09Z”. El código predeterminado será 23:59:59 en la zona horaria del medidor si no se proporciona el componente de hora.
Tolerance		Número	Cuántas horas debe buscar hacia atrás para ver la última lectura. Debe ser >= 24.
Unit		Texto	Unidad en la cual se presentarán los datos de flujo: • acres pies • ccf • pies cúbicos • metros cúbicos • galones (predeterminado) • litros

POST /eds/v2/flow

# Use estos parámetros a fin de publicar una solicitud para exportar los datos de flujo
# agregados y las lecturas para una fecha inicial y final.
#
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

# Use este enunciado cURL a fin de publicar una solicitud para exportar los datos de flujo
# agregados y las lecturas para una fecha inicial y final.
#
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

Publique una solicitud para exportar los datos de lectura de facturación más recientes utilizando un archivo de entrada de formato C dentro de la tolerancia determinada. Esta terminal de la API utiliza la información del medidor y de la cuenta del archivo determinado como sus filtros. Los datos recuperados estarán en formato C, de acuerdo con el archivo original, en lugar de un formato CSV.

Nota: El encabezado Content-Type debe asignarse como multipart/form-data en la solicitud.

Parámetros:

Nombre del parámetro	Requerido	Tipo	Descripción
Data		Archivo	El archivo de entrada en formato C del cual se extraerá la información del medidor y de la cuenta.
Date		Fecha	Fecha solicitada; cadena entre comillas ISO 8601, p. ej. “2015-08-23T22:06:09Z”. El código predeterminado será 23:59:59 en la zona horaria del medidor si no se proporciona el componente de hora.
Tolerance		Número	Cuántas horas debe buscar hacia atrás para ver la última lectura. Debe ser >= 24.

POST /v2/eds/formatc

# Use estos parámetros a fin de publicar una solicitud para exportar
# los datos de lectura de facturación más recientes utilizando un archivo de entrada de formato C, 
# dentro de la tolerancia determinada.
#
Data=$HOME/Desktop/my-format-c-data.txt
Date=2015-08-23T22:06:09Z
Tolerance=72
#

curl

# Use este enunciado cURL a fin de publicar una solicitud para exportar
# los datos de lectura de facturación más recientes utilizando un archivo de entrada de formato C, 
# dentro de la tolerancia determinada.
#
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
#

Método POST del EDS::Respuesta

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

Respuesta

Da como respuesta el objeto EDSNew.

202 Accepted: La solicitud del EDS se envió correctamente y se puede seguir el estado en la ubicación statusUrl.

• el encabezado de ubicación dirige hacia statusUrl

POST /v2/eds/leak

Publique una solicitud para exportar una lista de medidores con fugas, la fecha inicial de la fuga y la tasa de fuga actual.

Nota: El encabezado Content-Type debe asignarse como application/x-www-form-urlencoded en la solicitud.

POST EDS::Request

POST /v2/eds/leak

# Use estos parámetros a fin de publicar una solicitud para exportar los datos
# de los medidores con fugas en una fecha inicial y final.
#
Service_Point_Cycle=11111
Header_Columns=Account_ID,Meter_ID,Current_Leak_Start_Date,Current_Leak_Rate
#

curl

# Use este enunciado cURL a fin de publicar una solicitud para exportar una lista de medidores
# con fugas con la fecha inicial de la fuga y la tasa de fuga actual.
#
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
#

Método POST del EDS::Respuesta

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

Respuesta

Da como respuesta el objeto EDSNew.

202 Accepted: La solicitud del EDS se envió correctamente y se puede seguir el estado en la ubicación statusUrl.

• • el encabezado de ubicación dirige hacia statusUrl

POST /v2/eds/read

Envía una solicitud a fin de recuperar los datos de lectura de facturación más recientes para los filtros y la tolerancia proporcionados.

Nota: El encabezado Content-Type debe asignarse como application/x-www-form-urlencoded en la solicitud.
Parámetros:

Nombre del parámetro	Requerido	Tipo	Descripción
Date		Fecha	Fecha solicitada; cadena entre comillas ISO 8601, p. ej. “2015-08-23T22:06:09Z”. El código predeterminado será 23:59:59 en la zona horaria del medidor si no se proporciona el componente de hora.
Has_Endpoint		Booleano	Es verdadero para limitar los resultados de los medidores que tienen una terminal, es falso para los medidores que no tienen una terminal, o se omite para incluir ambos.
Header_Columns		Texto	Lista de nombres de columna para incluir en la salida: 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 Utilice los siguientes Column_Headers para recuperar los datos del sensor de los medidores ultrasónicos de la serie E de Badger Meter con capacidad de detección de temperatura y presión de agua que están conectados a terminales ORION Cellular LTE o 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		Número	Limita el número de medidores para los que se recuperan los datos; se utiliza para la paginación. El valor predeterminado es 25000. Debe estar entre 1 y 25000.
Location_Building_Type		Texto	La etiqueta (p. ej. «tienda», «restaurante», «apartamentos») se usa para filtrar en el Monitor de BEACON.
Location_DHS_Code		Texto	El código del Departamento de Servicios de Salud se usa para identificar fuentes de agua.
Location_District		Texto	Un identificador único para el distrito.
Location_Funding		Texto	La etiqueta se usa para filtrar en el Monitor de BEACON.
Location_Main_Use		Texto	La etiqueta se usa para filtrar en el Monitor de BEACON.
Location_Site		Texto	La etiqueta (p. ej. «Campus Norte», «Norte de la ciudad») se usa para filtrar en el Monitor de BEACON.
Location_Water_Type		Texto	La etiqueta (p. ej. «caliente», «fría», «potable», «regenerada») se usa para filtrar en el Monitor de BEACON.
Meter_Continuous_Flow		Texto	Sí/No.
Meter_ID		Texto	Es un identificador del medidor; se puede proporcionar varias veces.
Meter_Size		Texto	Tamaño numérico del medidor. (5/8 = .625, 3/4 = .75, 1 1/2 = 1.5, etc.)
Last_Meter_ID		Texto	Identificador opcional utilizado para la paginación de los resultados del medidor.
Output_Format		Texto	Formato de salida a utilizar: • csv: produce archivos CSV simples con cadenas entre comillas cuando es necesario (predeterminado). • json: produce JSON para su uso en otros programas.
CSV_Separator		Texto	Separador de columnas a utilizar. Ingrese alguna opción, ya sea: , ; : | ~ p. ej. un solo carácter para coma (,), punto y coma (;), dos puntos (:), barra (|) o virgulilla (~).
CSV_Quoting_Option		Texto	Incluya o excluya las comillas alrededor de todos los campos exportados en un archivo CSV: todos: comillas en todos los campos. ninguno: excluir comillas. Para obtener más información sobre el uso de comillas, haga clic aquí.
Resolution		Texto	Nivel de agregación: Daily (predeterminado) Quarter_Hourly Hourly Monthly
Service_Point_Class_Code		Texto	Identificador de la clasificación/categoría de facturación de este punto de servicio en el sistema de facturación, p. ej. residencial, comercial, riego, etc.
Service_Point_Cycle		Texto	Un identificador que se usa para indicar el nombre del ciclo de facturación.
Service_Point_Route		Texto	Identificador de la ruta o cartera a la que pertenece el servicio de medidor.
Tolerance		Número	Cuántas horas debe buscar hacia atrás para ver la última lectura. Debe ser >= 24. Si no se proporciona, el EDS da como respuesta la última lectura disponible para cada medidor.
Unit		Texto	Unidad en la cual se presentarán los datos de flujo: • acres pies • ccf • pies cúbicos • metros cúbicos • galones (predeterminado) • litros

Método POST del EDS::Solicitud

POST /v2/eds/read

# Use estos parámetros a fin de enviar una solicitud para recuperar
# los datos de lectura de facturación más recientes para los filtros
# y la tolerancia proporcionados.
#
Meter_Id=abc123
Meter_Id=xyz789
Date=2015-08-23T22:06:09Z
Tolerance=72
Header_Columns=Account_ID,Meter_ID,Read
#

curl

# Use este enunciado cURL a fin de enviar una solicitud para recuperar
# los datos de lectura de facturación más recientes para
# los filtros y la tolerancia proporcionados.
#
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"
}

Respuesta

Da como respuesta el objeto EDSNew.

202 Accepted: La solicitud del EDS se envió correctamente y se puede seguir el estado en la ubicación statusUrl.

• el encabezado de ubicación dirige hacia statusUrl

POST /v2/eds/exception_range

Envía una solicitud para recuperar un informe de excepciones históricas.

Nota: El encabezado Content-Type debe asignarse como application/x-www-form-urlencoded en la solicitud.

Parámetros:

Nombre del parámetro	Requerido	Tipo	Descripción
Location_Building_Type		Texto	Etiqueta del tipo de edificio (p. ej. «tienda», «restaurante», «apartamentos») opcional
Continuous_Flow_Expected		Texto	Sí/No
Location_DHS_Code		Texto	Código del Departamento de Servicios de Salud opcional
Location_District		Texto	Un identificador único para el distrito
End_Date		Fecha	Fecha solicitada; cadena entre comillas ISO 8601, p. ej. «2015-08-23T22:06:09Z«. El código predeterminado será 23:59:59 en la zona horaria del medidor si no se proporciona el componente de hora
Location_Funding		Texto	Etiqueta de financiamiento opcional
Has_Endpoint		Booleano	Es verdadero para limitar los resultados de los medidores que tienen una terminal, es falso para los medidores que no tienen una terminal, o se omite para incluir ambos
Header_Columns		Texto	Lista de nombres de columna para incluir en la salida: 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 Meter_Size_Desc Dials Service_Point_Latitude Service_Point_Longitude Endpoint_Type Connector_Type Endpoint_Status Supply_Zone_ID Demand_Zone_ID Utilice los siguientes Column_Headers para recuperar los datos del sensor de los medidores ultrasónicos de la serie E de Badger Meter con capacidad de detección de temperatura y presión de agua que están conectados a terminales ORION Cellular LTE o 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		Número	Limita el número de medidores para los que se recuperan los datos; se utiliza para la paginación. El valor predeterminado es 10000. Debe estar entre 1 y 10000.
Location_Main_Use		Texto	Etiqueta de uso principal opcional
Meter_ID		Texto	Es un identificador del medidor; se puede proporcionar varias veces
Meter_Size		Texto	Tamaño numérico del medidor (5/8 = .625, 3/4 = .75, 1 1/2 = 1.5, etc.)
Last_Meter_ID		Número	Identificador opcional utilizado para la paginación de los resultados del medidor.
Output_Format		Texto	Formato de salida a utilizar: csv: produce archivos CSV simples con cadenas entre comillas cuando es necesario (predeterminado) json: produce JSON para su uso en otros programas
Service_Point_Route		Texto	Identificador de la ruta o cartera a la que pertenece el servicio de medidor
Service_Point_Class_Code		Texto	Identificador de la clasificación/categoría de facturación de este punto de servicio en el sistema de facturación, p. ej. residencial, comercial, riego, etc.
Service_Point_Cycle		Texto	Un identificador que se usa para indicar el nombre del ciclo de facturación
Location_Site		Texto	Etiqueta de sitio opcional (p. ej. «Campus Norte», «Norte de la ciudad»)
Start_Date		Fecha	Fecha solicitada; cadena entre comillas ISO 8601, p. ej. «2015-08-23T22:06:09Z«. El código predeterminado será 23:59:59 en la zona horaria del medidor si no se proporciona el componente de hora
Location_Water_Type		Texto	Etiqueta del tipo de agua opcional (p. ej. «caliente», «fría», «potable», «regenerada»)

Método POST del EDS::Solicitud

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

Método POST del EDS::Respuesta

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

Respuesta

Da como respuesta el objeto EDSNew.

202 Accepted: La solicitud del EDS se envió correctamente y se puede seguir el estado en la ubicación statusUrl.

• el encabezado de ubicación dirige hacia statusUrl

GET /v1/eds/status/{edsUUID}

Recupera el estado de la solicitud de datos de exportación de lectura de facturación para el identificador único universal (Universally Unique Identifier, UUID) del EDS proporcionado.

Parámetros:

Nombre del parámetro	Requerido	Tipo	Descripción
edsUUID		UUID	Un identificador de la solicitud.

Método GET del EDS::Solicitud

# # Use este comando a fin de recuperar
# el estado de exportación de lectura de facturación más reciente.
#
GET /v1/eds/status/70FC1B71-F0C3-4950-885C-A635E7C4E034
#

curl

# Use este enunciado cURL a fin de recuperar
# el estado de exportación de lectura de facturación.
#
curl -uusername:password https://api.beaconama.net/v1/eds/status/70FC1B71-F0C3-4950-885C-A635E7C4E034
#

Método GET del EDS estado::Respuesta::En cola

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

Método GET del EDS estado::Respuesta::Ejecutando

{    
    "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"
}

Método GET del EDS estado::Respuesta::Excepción

{
    "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"
}

Método GET del EDS estado::Respuesta::Completado

{    
    "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/. . ."
}

Respuesta

Da como respuesta el objeto EDSStatus.

Consulte la documentación de la API del Export Data Service v1 para obtener detalles sobre las exportaciones CSV, los objetos JSON y los códigos de estado HTTP.