Las interfaces de programación de aplicaciones (Application Programming Interfaces, API) del Export Data Service, (EDS) v1 y v2 son para exportar datos a través de una interfaz HTTP estándar. Estos servicios se utilizan principalmente para interoperar con un sistema de proveedor de facturación para extraer las últimas lecturas del sistema. La API de importación de Data Exchange de BEACON proporciona la opción para que la persona que llama importe los datos de lectura de facturación a BEACON. El EDS es el análogo de exportación de ese servicio.
Una vez que se completa una exportación, los datos se pueden descargar en formato CSV, de acuerdo con la Exportación de lectura de facturación y la Especificación de Data Exchange, o como archivos de formato de columna de ancho fijo.
Para obtener instrucciones sobre cómo configurar archivos de formato de columna de ancho fijo, vea Consulte Exportar archivos de formato de columna de ancho fijo.
La paginación, las opciones de salida y la autenticación, que se describen a continuación, son idénticas para el EDS v1 y el EDS v2.
Paginación
Los métodos de consumo, flujo, rango y lectura del EDS exportan resultados de hasta 150,000 medidores por llamada. Para exportar más registros, debe realizar llamadas adicionales para:
- Analizar el archivo de resultados inicial para encontrar el último identificador (ID) de medidor devuelto.
- Use el parámetro lastMeterID (EDS v1) o Last_Meter_ID (EDS v2) para pasar ese último ID de medidor a BEACON.
- Repita el paso 1 y el paso 2 hasta que no se obtengan resultados.
Los resultados de la paginación difieren según el tipo de exportación que se realiza y una serie de variables. Por ejemplo, las exportaciones de última lectura y lectura de facturación producen una lectura por medidor, por lo que el resultado normalmente será igual al número de medidores hasta el límite de 150,000 por llamada.
Otras variables, como el rango de fechas, la resolución y si los medidores tienen registros compuestos o únicos, afectarán la cantidad de registros por página. Por ejemplo, obtener un año de datos por hora para un solo medidor da como resultado una exportación de 8,760 registros (24*365=8,760). Obtener un año de datos por hora para un medidor compuesto da como resultado una exportación de 17,520 registros (2*8760=17,520).
Una sola operación de exportación puede generar un máximo de 1.048.576 registros (1,024*1,024).
JSON maneja la paginación mostrando los resultados en lotes que abarcan «desde» el medidor x «hasta» el medidor y. El siguiente ejemplo de código muestra una exportación de 10,000 medidores para una empresa de servicios públicos con un total de 62762 medidores. La línea 2 muestra el número total de medidores en la cartera de la empresa de servicios públicos. La línea 3 muestra que la exportación comienza «desde» el medidor n y se incrementa un medidor a la vez «hasta» el medidor 10000, como se muestra en la línea 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'
Las exportaciones en formato CSV no paginan los resultados.
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.
Consulte API del Export Data Service v1 para obtener documentación sobre los métodos compatibles con el EDS v1 y la funcionalidad de exportación.
Consulte API del Export Data Service v2 para obtener documentación sobre los métodos compatibles con el EDS v2 y la funcionalidad de exportación.
