Ver el código de «API Datawarehouse»

= API DataWarehouse de Lazarvs =

Esta documentación describe los endpoints disponibles en la API de Lazarvs para acceder a datos del DataWarehouse, los parámetros necesarios y las respuestas.

== Índice ==
* [[#Información General|Información General]]
* [[#Autenticación|Autenticación]]
* [[#Endpoints de la API|Endpoints de la API]]
* [[#Esquemas de Respuesta|Esquemas de Respuesta]]

== Información General ==

* '''Título''': API_DataWarehouse
* '''Descripción''': DataWarehouse de Lazarvs.
* '''URL Base del Servidor''': <nowiki>{{URL Lazarvs}}/datawarehouse</nowiki>

== Autenticación ==

Para acceder a los endpoints, se requiere un token JWT que debe incluirse en el encabezado '''Authorization''' con el prefijo "Bearer".

'''Ejemplo de Encabezado:'''
 <nowiki>
 Authorization: Bearer <tu_token_jwt>
 </nowiki>

== Endpoints de la API ==

=== 1. /ConsultaFlat ===

; Descripción
: Endpoint para realizar consultas detalladas en el DataWarehouse sobre ventas.

; Método
: GET

; Parámetros de Consulta
* '''Periodoinicial''' (integer, opcional): Período inicial en formato de entero (int64).
* '''Periodofinal''' (integer, opcional): Período final en formato de entero (int64).

; Respuesta
La respuesta exitosa tendrá el código '''200''' y devuelve un JSON con la estructura de '''API_DataWarehouse_Respuesta'''.

'''Ejemplo de Solicitud:'''
 <nowiki>
 GET /ConsultaFlat?Periodoinicial=202301&Periodofinal=202312
 Authorization: Bearer <tu_token_jwt>
 </nowiki>

'''Ejemplo de Respuesta:'''
 <nowiki>
 {
   "DatosVentas": [
     {
       "Compania": "Compañía ejemplo",
       "Fecha": "2023-10-01",
       "Dia": 1,
       "DiaSemana": "Lunes",
       "AnoMes": "202310",
       "Periodo": 202310,
       "PeriodoNombre": "Octubre 2023",
       "PeriodoMes": 10,
       "PeriodoAno": 2023,
       "PeriodoMesAno": "10/2023",
       "Ejercicio": "Ejercicio ejemplo",
       "Trimestre": "Q4",
       ...
     }
   ],
   "Mensajes": [
     {
       "Id": "msg01",
       "Type": 1,
       "Description": "Operación realizada con éxito."
     }
   ],
   "CodigoRespuesta": "200",
   "Respuesta": "Consulta ejecutada correctamente."
 }
 </nowiki>

== Esquemas de Respuesta ==

=== Esquema API_DataWarehouse_Respuesta ===

* '''DatosVentas''' (array): Información sobre las ventas.
  * '''Compania''' (string): Compañía involucrada.
  * '''Fecha''' (date): Fecha de la venta.
  * '''Dia''' (integer): Día del mes.
  * '''DiaSemana''' (string): Día de la semana.
  * '''AnoMes''' (string): Período en formato "AñoMes".
  * '''Periodo''' (integer): Período en formato de entero.
  * '''PeriodoNombre''' (string): Nombre del período.
  * '''PeriodoMes''' (integer): Mes del período.
  * '''PeriodoAno''' (integer): Año del período.
  * '''PeriodoMesAno''' (string): Mes y año del período.
  * '''Ejercicio''' (string): Ejercicio de la operación.
  * '''Trimestre''' (string): Trimestre en el año.
  * '''...''' y otros campos específicos de la venta (ver detalles en el esquema '''SDTDWVentas1_Item''').

* '''Mensajes''' (array): Mensajes de operación.
  * '''Id''' (string): ID del mensaje.
  * '''Type''' (integer): Tipo del mensaje.
  * '''Description''' (string): Descripción del mensaje.

* '''CodigoRespuesta''' (string): Código de respuesta de la operación.
* '''Respuesta''' (string): Mensaje descriptivo de la operación.

=== Esquema SDTDWVentas1_Item ===

* '''SDTDWVentas1_Item''' (object): Información detallada del ítem de ventas.
  * '''Compania''' (string): Compañía.
  * '''Fecha''' (string, format: date): Fecha.
  * '''Dia''' (integer, format: int32): Día.
  * '''DiaSemana''' (string): Día de la Semana.
  * '''AnoMes''' (string): Período Ordenado.
  * '''Periodo''' (integer, format: int64): Período.
  * '''PeriodoNombre''' (string): Nombre de Período.
  * '''PeriodoMes''' (integer, format: int32): Mes.
  * '''PeriodoAno''' (integer, format: int32): Año.
  * '''PeriodoMesAno''' (string): Mes Año.
  * '''Ejercicio''' (string): Ejercicio.
  * '''Trimestre''' (string): Trimestre.
  * '''Documento''' (string): Número Legal.
  * '''TipoDeProducto''' (string): Tipo de Producto.
  * '''Articulo''' (string): Artículo.
  * '''ArticuloNombre''' (string): Nombre de Artículo.
  * '''Familia''' (string): Familia.
  * '''Modelo''' (string): Modelo.
  * '''Atributo1''' (string): Atributo 1.
  * '''Atributo2''' (string): Atributo 2.
  * '''Atributo3''' (string): Atributo 3.
  * '''UnidadCorto''' (string): Unidad Corto.
  * '''Unidad''' (string): Unidad.
  * '''Servicio''' (string): Servicio.
  * '''Segmento''' (string): Segmento.
  * '''Local''' (string): Local.
  * '''Jurisdiccion''' (string): Jurisdicción.
  * '''Territorio''' (string): Territorio.
  * '''Cliente''' (string): Cliente.
  * '''TerritorioCliente''' (string): Territorio Cliente.
  * '''TipoCliente''' (string): Tipo Cliente.
  * '''DireccionEntrega''' (string): Dirección Entrega.
  * '''TipoFormaPago''' (string): Tipo de Forma de Pago.
  * '''TipoVenta''' (string): Tipo de Venta.
  * '''Proyecto''' (string): Proyecto.
  * '''Precio''' (number, format: double): Precio.
  * '''Cantidad''' (number, format: double): Cantidad.
  * '''Moneda''' (string): Moneda.
  * '''IngresoMonedaLocal''' (number, format: double): Ingreso Moneda Local.
  * '''IngresoMonedaGrupo''' (number, format: double): Ingreso Moneda Grupo.
  * '''CostoMonedaLocal''' (number, format: double): Costo Moneda Local.
  * '''CostoMonedaGrupo''' (number, format: double): Costo Moneda Grupo.
  * '''MargenMonedaLocal''' (number, format: double): Margen Moneda Local.
  * '''MargenMonedaGrupo''' (number, format: double): Margen Moneda Grupo.