ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

Metadata

Gestión completa del módulo de fidelización

API	Description
POST api/Metadata/VentaInfo	DEvuelve los distintos tipos de metadata con sus valores según una forma de pago
POST api/Metadata/VentaInfoDeuda	DEvuelve los distintos pares para operaciones Deuda
POST api/Metadata/VentaInfoDeudaSaldo	DEvuelve el saldo de un par CNI y CNO
POST api/Metadata/InsertarMovimiento	Inserta un movimiento de cobro

Ping

API	Description
POST api/Ping/Ping	Devuelve un ping a la API

Estacion

Gestión de estación

API	Description
GET api/Estacion/GetAllEstaciones?Email={Email}	Obtiene todos los dataset para el cuadro de mando

CuadroMando

Gestión de cuadro de mano

API	Description
GET api/CuadroMando/GetAll?IdEmpresa={IdEmpresa}&FechaTrabajo={FechaTrabajo}&IdEstacion={IdEstacion}	Obtiene todos los dataset para el cuadro de mando
POST api/CuadroMando/GetPostAll	No documentation available.

Exportacion

Gestión de Exportaciones de compra

API	Description
POST api/exportacion/GetAll	Obtiene todos los Exportaciones que hayan sido creados con marca PDA
POST api/exportacion/ContabilizarFacturasVenta	Obtiene todos los Exportaciones que hayan sido creados con marca PDA
POST api/exportacion/ContabilizarFacturasCompra	Obtiene todos los Exportaciones que hayan sido creados con marca PDA
POST api/exportacion/ContabilizarInformes	Obtiene todos los Exportaciones que hayan sido creados con marca PDA

Cliente

Gestión de clientes

API	Description
POST api/Cliente/Registrar	Crea un cliente nuevo de tipo externo
POST api/Cliente/CrearCliente	Crea un cliente nuevo de tipo externo
GET api/Cliente/BajaEmail?pan={pan}	Borra el email de un cliente dado previamente de alta
POST api/Cliente/CambiarPassword	Cambia el password de un cliente dentro de la API
POST api/Cliente/Saldo	Muestra el saldo de una tarjeta
GET api/Cliente/GetMovimientos	Muestra el saldo de una tarjeta

Fidelizacion

Gestión completa del módulo de fidelización

API	Description
POST api/Fidelizacion/Acumulacion	Operación de acumulación de puntos o monedero
POST api/Fidelizacion/ConsultarRedencion	Consulta el importe posible de redención
POST api/Fidelizacion/ReservarRedencion	Pide reserva de operación para redención
POST api/Fidelizacion/ConfirmarRedencion	Confirma una operación de redención
GET api/Fidelizacion/GetSaldo?pan={pan}	Obtiene el saldo total de una tarjeta
GET api/Fidelizacion/GetCampanas?pan={pan}	Obtiene todas las campañas de fidelización configuradas en Magon
GET api/Fidelizacion/AnularOperacion?NumeroTransaccion={NumeroTransaccion}&IdTpv={IdTpv}&Fecha={Fecha}	Anula una operación de fidelización

Personal

Gestión de personal

API	Description
POST api/Personal/ChangePassword	Cambia el password del personal. Esta petición llegará desde la APP, cuando se cambie el password de un usuario que esté relacionado un la ficha de personal.

Articulo

Gestión de artículos

API	Description
GET api/Articulo/GetAll?nombre={nombre}&codigo={codigo}&idEstacion={idEstacion}&idProveedor={idProveedor}&carburante={carburante}&compra={compra}&venta={venta}&inventario={inventario}&codigoBarras={codigoBarras}&proveedor={proveedor}&refProveedor={refProveedor}	Obtiene todos los artículos del catálogo
GET api/Articulo/GetByEan?codigoBarras={codigoBarras}	Obtiene un artículo por código de barras
GET api/Articulo/GetByIdArticulo?idArticulo={idArticulo}	Obtiene un artículo por su Id
GET api/Articulo/GetByIdArticuloDatosExtendidos?idArticulo={idArticulo}&idEstacion={idEstacion}	Obtiene lodatos extendidos stock, coste, pvp, stock en transito por su Id
GET api/Articulo/GetStockByIdArticulo?idArticulo={idArticulo}&idEstacion={idEstacion}	Obtiene lodatos extendidos stock por su Id
POST api/Articulo/CambiaPvp	Cambia el precio de venta de un artículo
GET api/Articulo/GetAllFamilias	Obtiene una lista de Familias.
GET api/Articulo/GetAllSubFamilias	Obtiene una lista de SubFamilias.
GET api/Articulo/GetAllGruposArticulos	Obtiene una lista de Grupos.
GET api/Articulo/GetAllImpuesto	Obtiene una lista de Impuestos.
GET api/Articulo/GetAllMedida	Obtiene una lista de Medidas.
GET api/Articulo/GetArticuloCodigoMax	Obtiene el código mayor de artículo por su Id
POST api/Articulo/CrearArticulo	Crea artículo nuevo
POST api/Articulo/CrearArticulo2	Crea artículo nuevo
POST api/Articulo/VincularArticuloEAN	Crea artículo nuevo
POST api/Articulo/VincularArticuloNuevoEAN	Crea artículo nuevo
GET api/Articulo/GetAllPrecioCarburantes?idEstacion={idEstacion}	Obtiene una lista de Precio de carburantes (asignados a tanques)
POST api/Articulo/CrearPrecioCarburante	Crea precio carburante nuevo
GET api/Articulo/GetAllTanque?idEstacion={idEstacion}	Obtiene una lista de Tanques.
GET api/Articulo/GetAllListaEtiquetas?nombre={nombre}&fechaCreacionMax={fechaCreacionMax}&fechaUltimaImpresionMax={fechaUltimaImpresionMax}&fechaCreacionMin={fechaCreacionMin}&fechaUltimaImpresionMin={fechaUltimaImpresionMin}	Obtiene todas las lista de etiquetas
POST api/Articulo/CrearCabecera	Crea la cabecera de una lista de etiqueta
POST api/Articulo/CrearLinea?idArticulo={idArticulo}	Crea una linea de una lista de etiqueta dentro de lista ya creado
POST api/Articulo/EliminarLinea	Elimina una linea de etiqueta
POST api/Articulo/EliminarListaEtiqueta	Elimina una lista de etiquetas
POST api/Articulo/VincularArticuloEstacionEAN	Crea artículo nuevo

Proveedor

Gestión de proveedores

API	Description
GET api/Proveedor/GetAll?nombre={nombre}&referencia={referencia}&idEstacion={idEstacion}&idProveedor={idProveedor}&carburante={carburante}	Obtiene todos los proveedores del catálogo
GET api/Proveedor/GetByReferencia?referencia={referencia}	Obtiene un proveedor por su referencia
GET api/Proveedor/GetByIdProveedor?idProveedor={idProveedor}	Obtiene un proveedor por su Id

TicketBAI

Gestión completa del módulo de fidelización

API	Description
POST api/TicketBAI/PostTicket	Envío fiscal de operación identificada por el objeto TicketEnvioFiscal y la operacíón = A alta, B Baja. En la respuesta: si hay errores en las validaciones antes del envío ver ReasonPhrase si hay errores en el envío ver objeto Ticket del Content y el campo MensajeServidor

Importacion

Gestión de Exportaciones de compra

API	Description
POST api/importacion/InsertaVenta	Crea una venta que se guardará en Magón
POST api/importacion/EnvioTicketInmediatoByObject	Envía un email con el ticket inmediato, EL ticket pasado en el cuerpo puede no estar guardado en MAgon por lo que en tal caso se crea en una tabla de tickets temporales, solo a efectos de la impresión, después se eliminará
POST api/importacion/EnvioTicketInmediatoByIdticket	Envía un email con el ticket inmediato ya guardado en Magon

Pedido

Gestión de pedidos de compra

API	Description
GET api/Pedido/GetAll?fechaMax={fechaMax}&fechaMin={fechaMin}&idEstacion={idEstacion}&idProveedor={idProveedor}&numeroProveedor={numeroProveedor}&nombreProveedor={nombreProveedor}&idPedidoEstado={idPedidoEstado}&esAlbaranPedido={esAlbaranPedido}	Obtiene todos los pedidos de compra guardados
GET api/Pedido/GetByIdArticulo?IdArticulo={IdArticulo}&IdPedido={IdPedido}	Obtiene una linea de pedido según un artículo y pedido ya creado
GET api/Pedido/GetLineasByIdPedido?idPedido={idPedido}	Obtiene todas las lineas de un Pedido
GET api/Pedido/GetArticulosByIdPedido?idPedido={idPedido}	Obtiene todos los artículos de lineas de un pedido
POST api/Pedido/CrearCabecera	Crea la cabecera de una pedido nuevo
POST api/Pedido/CrearLinea	Crea una línea de pedido
POST api/Pedido/ModificarLinea	Modifica una línea de pedido
POST api/Pedido/EliminarLinea	Elimina una linea de pedido
POST api/Pedido/FinalizarPedido	Finaliza un Pedido. Sube el Pedido completo y guarda todos los cambios.
GET api/Pedido/GetAllPedidoEstado	Obtiene una lista de Estados de pedido.

Albaran

Gestión de albaranes de compra

API	Description
GET api/Albaran/GetAll?fechaMax={fechaMax}&fechaMin={fechaMin}&idEstacion={idEstacion}&idProveedor={idProveedor}&numeroProveedor={numeroProveedor}	Obtiene todos los albaranes que hayan sido creados con marca PDA
GET api/Albaran/GetLineasByIdAlbaran?idAlbaran={idAlbaran}	Obtiene todas las lineas de un Albaran
GET api/Albaran/GetByIdArticulo?IdArticulo={IdArticulo}&IdAlbaran={IdAlbaran}	Obtiene una línea de albaran a partir de un Artículo y un albarán ya creado
GET api/Albaran/GetArticulosByIdAlbaran?idAlbaran={idAlbaran}	Obtiene todos los artículos de lineas de un albaran
POST api/Albaran/CrearCabecera	Crea la cabecera de un albarán nuevo
POST api/Albaran/CrearLinea	Crea una linea en un albarán ya creado
POST api/Albaran/ModificarLinea	Modifica una linea dentro de una labrán
POST api/Albaran/EliminarLinea	Elimina una línea de albarán
POST api/Albaran/FinalizarAlbaran	Finaliza un Albaran. Sube el Albaran completo y guarda todos los cambios.

Integracion

Gestión de estación

API	Description
POST api/interfaces/articulo	Crea una colección de artículos nuevos en el sistema, si el artículo está creado, lo modifica [ { "Nombre": "Articulo prueba 6", "Codigo": "950006", "CodigoBarras": "2134567891326", "Carburante": false, "Compra": true, "Venta": true, "Inventario": true, "CambioPrecio": true, "PedirPrecio": true, "VentaAlPeso": true, "Pvp": 1.0, "FamiliaRef": "03", "SubfamiliaRef": "31", "GrupoRef": "316", "ImpuestoPorcentaje": 10.0, "Medida": "Unidades", "Unidades": 1.0, "EstacionConcesion": "0002" } ]
GET api/interfaces/articulo?nombre={nombre}&codigo={codigo}&estacionConcesion={estacionConcesion}&carburante={carburante}&envioTpv={envioTpv}&compra={compra}&venta={venta}&inventario={inventario}&codigoBarras={codigoBarras}&proveedor={proveedor}&refProveedor={refProveedor}&familiaRef={familiaRef}&subfamiliaRef={subfamiliaRef}&grupoRef={grupoRef}	No documentation available.
GET api/interfaces/cliente?nombre={nombre}&referencia={referencia}&nif={nif}&estacionConcesion={estacionConcesion}&telefono={telefono}&email={email}&direccion={direccion}&poblacion={poblacion}&pais={pais}&provincia={provincia}	No documentation available.
GET api/interfaces/promocion?fechaInicio={fechaInicio}&fechaFin={fechaFin}&nombre={nombre}&codigoArticulo={codigoArticulo}&estacionConcesion={estacionConcesion}	No documentation available.
GET api/interfaces/proveedor?nombre={nombre}&referencia={referencia}&nif={nif}&estacionConcesion={estacionConcesion}&telefono={telefono}&email={email}&direccion={direccion}&poblacion={poblacion}&pais={pais}&provincia={provincia}&codigoPostal={codigoPostal}	No documentation available.
POST api/interfaces/jerarquia	No documentation available.
GET api/interfaces/jerarquia?nombre={nombre}&referencia={referencia}&nivel={nivel}&refFamiliaPadre={refFamiliaPadre}&refSubamiliaPadre={refSubamiliaPadre}	No documentation available.
POST api/interfaces/ean	No documentation available.
GET api/interfaces/ean?codigoBarras={codigoBarras}&codigoArticulo={codigoArticulo}	No documentation available.
POST api/interfaces/pvp	No documentation available.
GET api/interfaces/pvp?fechaInicio={fechaInicio}&codigoArticulo={codigoArticulo}&estacionConcesion={estacionConcesion}	No documentation available.
POST api/interfaces/cliente	No documentation available.
DELETE api/interfaces/cliente	No documentation available.
POST api/interfaces/promocion	No documentation available.
DELETE api/interfaces/promocion	No documentation available.
POST api/interfaces/promocionNxm	No documentation available.
GET api/interfaces/promocionNxm?fechaInicio={fechaInicio}&fechaFin={fechaFin}&nombre={nombre}&codigoArticulo={codigoArticulo}	No documentation available.
POST api/interfaces/combinado	No documentation available.
DELETE api/interfaces/combinado	No documentation available.
GET api/interfaces/combinado?fechaInicio={fechaInicio}&fechaFin={fechaFin}&nombre={nombre}&codigoArticulo={codigoArticulo}&estacionConcesion={estacionConcesion}	No documentation available.
POST api/interfaces/proveedor	No documentation available.
POST api/interfaces/articulo-proveedor	No documentation available.
POST api/interfaces/albaran	No documentation available.
POST api/interfaces/inventario	No documentation available.
GET api/interfaces/series?serie={serie}&estacionConcesion={estacionConcesion}	No documentation available.
GET api/interfaces/formas-pago?nombre={nombre}&estacionConcesion={estacionConcesion}	No documentation available.
GET api/interfaces/tickets?fechaInicio={fechaInicio}&fechaFin={fechaFin}&codigoArticulo={codigoArticulo}&estacionConcesion={estacionConcesion}&referenciaCliente={referenciaCliente}&serie={serie}&numeroInicio={numeroInicio}&numeroFin={numeroFin}	No documentation available.
GET api/interfaces/turnos?fechaInicio={fechaInicio}&fechaFin={fechaFin}&estacionConcesion={estacionConcesion}	No documentation available.
GET api/interfaces/recaudacion?fechaInicio={fechaInicio}&fechaFin={fechaFin}&estacionConcesion={estacionConcesion}	No documentation available.

LimiteRiesgo

Gestión completa del módulo de fidelización

API	Description
GET api/LimiteRiesgo/ConsultarDisponible?idEstacion={idEstacion}&pan={pan}	Consulta el importe posible de redención Validaciones: existe pan, no caducada, no bloqueada, cliente no en lista negra.
POST api/LimiteRiesgo/ValidarPin	Valida el pin de la tarjeta. Validaciones:
POST api/LimiteRiesgo/AutorizarOperacion	Autoriza la operacion o no. Validaciones:
POST api/LimiteRiesgo/ConfirmarTicket	Confirmar ticket. Validaciones:
GET api/LimiteRiesgo/AnularOperacion?numeroOperacion={numeroOperacion}	Anula la operación. Validaciones:
POST api/LimiteRiesgo/ConsultarLimite	Consultar limite. Validaciones:

Inventario

Gestión de inventarios

API	Description
GET api/Inventario/GetAll?fechaMax={fechaMax}&fechaMin={fechaMin}&idEstacion={idEstacion}	Obtiene todos los inventarios creado con marca PDA
GET api/Inventario/GetLineasByIdInventario?idInventario={idInventario}	Obtiene todas las lineas de un inventario
GET api/Inventario/GetArticulosByIdInventario?idInventario={idInventario}	Obtiene todos los artículos de lineas de un inventario
GET api/Inventario/GetByIdArticulo?IdArticulo={IdArticulo}&IdInventario={IdInventario}	Obtiene una línea e inventario a partirde un artículo
POST api/Inventario/CrearCabecera	Crea la cabecera de un inventario
POST api/Inventario/CrearLinea?userName={userName}	Crea una linea de un inventario dentro de uinventario ya creado
POST api/Inventario/ModificarLinea	Modifica una linea de inventario
POST api/Inventario/EliminarLinea	Elimina una linea de inventario
POST api/Inventario/FinalizarInventario?userName={userName}	Finaliza un inventario. Sube el inventario completo y guarda todos los cambios.
GET api/Inventario/GetAllAlmacen?idEstacion={idEstacion}	Obtiene una lista de Almacenes.
GET api/Inventario/GetAllInventarioTipo	Obtiene una lista de tipos de inventarios.

Account

API	Description
GET api/Account	No documentation available.
GET api/Account?provider={provider}&error={error}	No documentation available.