Especificación de Web Services del Siretrac GLP Registros de Ventas a Usuario Final

Transcripción

1 Especificación de Web Services del Siretrac GLP Registros de Ventas a Usuario Final

2 Especificación de Web Services del Siretrac GLP Registros de Compra 1. Objetivo del documento Definición del Servicio Web Definición de los métodos Ventas a usuario final Requerimientos de Aplicación... 5 Control de versiones del documento Versión Fecha Descripción de la actualización /09/2018 Versión inicial 2

3 Server Vendedor 1. Objetivo del documento En este documento se describe la especificación de los servicios web del Siretrac Gas LP, correspondientes al registro de ventas a usuario final. Para mayor referencia acerca del funcionamiento del sistema, consultar el Acuerdo por el que la Comisión Reguladora de Energía emite las Disposiciones administrativas de carácter general que establecen el alcance y procedimiento general para el registro estadístico de las transacciones comerciales de gas licuado de petróleo publicado el 27 de julio de 2018 en el Diario Oficial de la Federación. 2. Definición del Servicio Web Servicios que permiten realizar el proceso para bloques de registros de ventas a usuarios finales. Descripción del Servicio Sistema que Inicia la Comunicación Sistema del Registro Estadístico de Transacciones Comerciales Módulo Gas LP Protocolo de comunicación HTTPS Tipo de servicio REST Verbo HTTP POST Método 1.- Ventas a usuario final Descripción Registros de venta al usuario final. Sistema que inicia la comunicación Siretrac 3. Definición de los métodos 3.1 Ventas a usuario final Registros de venta al usuario final. Venta a usuario final Fase Vender No Responder venta Inicio Fin Revisar Venta Venta válida? si Guardar el Registro Generar el Acuse 3

4 Datos de entrada La siguiente tabla describe los elementos necesarios para consumir el servicio web, la obligatoriedad de cada uno se describirá más adelante. Elemento Tipo de dato Descripción FechaVenta Datetime Fecha en la que se realizó la venta, formato dd/mm/aaaa Permiso Varchar(50) Título de permiso con el que se realizó la venta al usuario final IdSector Identificador del sector al que se realizó la venta Volumen IdEstado IdMunicipio ValorVenta Decimal(18,2) Volumen vendido a usuario final, el cual deberá expresarse en kilogramos cuando se vende mediante recipiente transportable o portátil y en litros cuando la venta se realiza mediante ducto, auto-tanque o a vehículos automotores Identificador de la entidad federativa donde se realizó la venta al usuario final Identificador del municipio donde se realizó la venta al usuario final Decimal (18,2) Monto en pesos mexicanos generado de la venta realizada CantidadAutoconsumo Kilogramos de gas LP utilizado para autoconsumo Auto Recipiente IdBodega Bit Bit Varchar(100) Indicador con valores 1 o 0. El 1 indicará que la venta se realizó mediante auto-tanque, en el caso de planta de distribución, o a vehículo automotor en el caso de estación de servicio con fin específico. El indicador de Recipiente deberá ser 0. Indicador con valores 1 o 0. El 1 indicará que la venta se realizó mediante recipiente transportable o portátil, en el caso de planta de distribución y estaciones de servicio con fin específico. El indicador de Auto deberá ser 0. Identificador de la bodega de expendio donde se realizó la venta Referencia utilizada por el permisionario para identificar la venta. Este campo no será almacenado en la Base de Datos del Siretrac, únicamente se utilizará en la respuesta La siguiente tabla muestra la obligatoriedad de los elementos, marcando con el símbolo aquellos que son obligatorios conforme al tipo de permisionario. 4

5 Elemento Actividad Distribución por medio de ducto Distribución mediante planta de distribuidor Distribución mediante auto-tanque Expendio al público mediante estación de servicio con fin específico Expendio al público mediante Bodega de Expendio Comercialización FechaVenta Permiso IdSector Volumen kilogramos litros IdEstado IdMunicipio ValorVenta CantidadAutoconsumo Autotanque Recipiente IdBodega Datos de salida Elemento Tipo de dato Descripción idventa Identificador para el registro de la venta FechaVenta Datetime Fecha generada por el sistema IdVendedor Identificador del permisionario que realizó la venta 4. Requerimientos de Aplicación Periodicidad Métrica de Disponibilidad Registro de Errores Varchar(100) Referencia utilizada por el permisionario para identificar la venta. Este campo no será almacenado en la Base de Datos del Siretrac, únicamente se utilizará en la respuesta Diario y en línea 24x7 Requerimientos Ante cualquier error de validación, se enviará un mensaje de error y se rechazará el registro. 5