- Introducción
- Archivos entregados al cliente
- Descripción de los métodos del servicio web TCC
- -AbonarSaldo
- Parámetros de entrada:
- Datos de salida:
- - ActualizarClienteTCC
- Parámetros de entrada:
- Datos de salida:
- -AplicarBeneficios
- Parámetros de entrada:
- Datos de salida:
- -AsignarLlaverín
- Parámetros de entrada:
- Datos de salida:
- -AsociarTCC
- Parámetros de entrada:
- Datos de salida:
- -ConfirmaClienteTCC
- Parámetros de entrada:
- Datos de salida:
- -ConfirmarTransaccion
- Parámetros de entrada:
- Datos de salida:
- Parámetros de entrada:
- Datos de salida:
- -ConsultaOfertasExclusivas
- Parámetros de entrada:
- Datos de salida:
- -ConsultarBeneficiosLocales
- Parámetros de entrada:
- Datos de salida:
- -ConsultarBeneficiosReducido
- Parámetros de entrada:
- Datos de salida:
- -ConsultarBeneficiosTCC
- Parámetros de entrada:
- Datos de salida:
- -ConsultarClienteTCC
- Parámetros de entrada:
- Datos de salida:
- -ConsultarCompueje
- Parámetros de entrada:
- Datos de salida:
- -ConsultaReferencias
- Parámetros de entrada:
- Datos de salida:
- -ConsultarIntereses
- Parámetros de entrada:
- Datos de salida:
- -ConsultarLlaverin
- Parámetros de entrada:
- Datos de salida:
- -ConsultarOcupaciones
- Parámetros de entrada:
- Datos de salida:
- -ConsultarUsuarioWeb
- Parámetros de entrada:
- Datos de salida:
- -ConsultaValeElectronico
- Parámetros de entrada:
- Datos de salida:
- -RecuperaContrasena
- Parámetros de entrada:
- Datos de salida:
- -RegistroClienteTCC
- Parámetros de entrada:
- Datos de salida:
- -ValidaTCC
- Parámetros de entrada:
- Datos de salida:
- Tipos de datos TCC
- Descripción de los métodos del servicio web TCC
Introducción #
Este documento tiene como objetivo describir los métodos usados en los servicios web del sistema TCC (Tarjeta de Cliente Consentido) para su integración con un punto de venta al cual se tenga acceso al desarrollo del Punto de Venta y así hacer uso de los Servicios Web.
Archivos entregados al cliente #
La carpeta “TCCWS” contiene los archivos que se entregan al cliente para su instalación en el servidor IIS son los siguientes:
Archivo/Carpeta | Descripción |
Web.config | Archivo de configuración de los servicios web, dentro del cual se definen parámetros como la cadena de conexión a la base de datos. |
WSTCC.asmx | Archivo de definición de los servicios web. |
bin | Carpeta con las dlls necesarias para el funcionamiento de los servicios web. |
#
Instalación de los servicios web #
Para la instalación de los servicios web es necesaria la previa instalación del Framework 4.0 de .NET y contar con un servidor IIS (Internet Information Services). Una vez instalado el Framework. Cumplidos esos requisitos, el siguiente paso es copiar la carpeta TCCWS a la carpeta wwwroot que proporciona IIS para la instalación de aplicaciones web, y la ruta es: C:\inetpub\wwwroot.
El siguiente paso es acceder al Administrador de IIS: Sitios – Default Web Site, y buscar la carpeta TCCWS en el árbol que se muestra del lado izquierdo de la pantalla principal:
Una vez encontrada dar clic con el botón derecho del ratón y seleccionar convertir en aplicación:
Al aparecer la ventana siguiente, dar clic en el botón seleccionar el grupo de aplicaciones:
Del desplegado de opciones seleccionar Framework 4 o versión superior como 4.5:
Dar clic en Aceptar y se habrá creado nuestros servicios web listos para hacer uso de los mismos. Para probar se puede acceder a ellos mediante la siguiente liga: http://localhost/TCCWS/wstcc.asmx
#
Definición de los parámetros del archivo de configuración #
El archivo Web.config contiene los parámetros a configurar para nuestros servicios web, los cuales se describen a continuación:
Parámetro | Descripción |
ValidarIPs | Este parámetro nos indica con un valor booleano si el sistema TCC hará uso de las validaciones de las IPs de cada petición web. Si es valor es verdadero, TCC valida que la IP de una petición este dentro de la lista permitida de IPs. |
UsuarioSMTP | Usuario del servidor SMTP a utilizar para enviar los correos electrónicos a las cuentas de los clientes que usen la página web. |
ContrasenaSMTP | Contraseña del servidor SMTP. |
HostSMTP | Nombre o dirección del servidor SMTP a utilizar. |
PortSMTP | Puerto del servidor SMTP a utilizar. |
sslEnabled | Indica si el servidor SMTP tiene habilitada la seguridad SSL. |
TCC | Cadena de conexión a la base de datos TCC. |
#
Descripción de los métodos del servicio web TCC #
-AbonarSaldo #
Este método web tiene que objetivo hacer el abono de monedero electrónico a una tarjeta de cliente consentido (TCC).
public ComputacionXXI.TCC.TCCWS.ResultadoWS<bool> AbonarSaldo(long pCodigoTarjeta, ComputacionXXI.TCC.Blcs.CompuejeBeneficioTMPTCCInfo pCompuejeBeneficioTMP, string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pCodigoTarjeta | long | Código de la tarjeta TCC a la cual se hará el abono de monedero. |
pCompuejeBeneficioTMP | CompuejeBeneficioTMPTCCInfo | Objeto el cual contiene el saldo a abonar. |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<bool> | Objeto resultado, el cual indica si el abono se realizó con éxito. |
– ActualizarClienteTCC #
Este método tiene como objetivo actualizar los datos de un cliente dentro del sistema TCC.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<bool> ActualizarClienteTCC(ComputacionXXI.TCC.Blcs.ClienteConsentidoTCCInfo pCliente, string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pCLiente | ClienteConsentidoTCCInfo | Objeto cliente consentido a ser actualizado. |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<bool> | Objeto resultado, el cual indica si el actualizo el cliente con éxito. |
#
-AplicarBeneficios #
Este método se encarga de hacer la aplicación de los beneficios a una determinada tarjeta TCC, se manda la lista de todos los CompuejeBeneficiosTMPTCCInfo que se desean aplicar a la tarjeta TCC dejándolos en un estado de por confirmar. Después de llamar este método y recibir respuesta del servicio web se procede a llamar al método ConfirmarTransaccion.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<bool> AplicarBeneficios(long pCodigoTarjeta, System.Collections.Generic.List<CompuejeBeneficioTMPTCCInfo> pCompuejesBeneficioTMP, string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pCodigoTarjeta | long | Código de la tarjeta TCC a la cual se le aplicarán los beneficios. |
pCompuejesBeneficiosTMP | List<CompuejeBeneficioTMPTCCInfo> | Lista de los beneficios a aplicar. |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<bool> | Objeto resultado, el cual indica di se aplicaron con éxito. |
#
-AsignarLlaverín #
Este método tiene como función asignar un código de llaverín a una tarjeta de cliente consentido.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<bool> AsignarLlaverin(long pCodigoTarjeta, string pCodigoLlaverin, string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pCodigoTarjeta | long | Código de la tarjeta TCC a la cual se le asignará el código del llaverín. |
pCodigoLlaverin | string | Código del llaverín a asignar. |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<bool> | Objeto resultado, el cual indica si se asignó con éxito el llaverin a la tarjeta. |
#
-AsociarTCC #
Este método asocia una nueva tarjeta de cliente consentido a un cliente, cancelando la anterior y pasando los puntos y monedero a la nueva tarjeta.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<bool> AsociarTCC(long pCodigoCliente, long pCodigoTarjeta, string pUsuarioTCC, string pContrasenaTCC) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pCodigoCliente | long | Código del cliente registrado en el sistema TCC. |
pCodigoTarjeta | long | Código de la tarjeta nueva a asociar al cliente. |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<bool> | Objeto resultado, el cual indica si se asoció con éxito la tarjeta al cliente. |
-ConfirmaClienteTCC #
Este método confirma el registro de un cliente, después de que el cliente hace clic en el link que le llega a su correo, como paso posterior al registro.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<bool> ConfirmaClienteTCC(long pCodigoCliente, string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pCodigoCliente | long | Código del cliente registrado en el sistema TCC. |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<bool> | Objeto resultado, el cual indica si confirmo el registro del cliente. |
-ConfirmarTransaccion #
Este método confirma la aplicación de los beneficios posteriormente a la llamada del método AplicarBeneficios, es en este método donde se hacen las modificaciones a la tarjeta si es que las hay y se insertan todos los movimientos en el Compueje de la tarjeta.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<ResultadoTransaccion> ConfirmarTransaccion(long pCodigoTransaccion, long pCodigoTarjeta, long pCodigoEstablecimiento, string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pCodigoTransaccion | long | Código de la transacción utilizado en cada una de los compuejes durante la llamada del método AplicarBeneficios. |
pCodigoTarjeta | long | Código de la tarjeta en la cual se confirmaran los beneficios. |
pCodigoEstablecimiento | long | Id del establecimiento donde se origina el llamado. |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<ResultadoTransaccion> | Objeto resultado, el cual devuelve un objeto ResultadoTransaccion con información de la tarjeta antes y después de la confirmación. |
-ConsultaBeneficios #
Este método consulta un beneficio del tipo Cupón Perforado, Cupón Timbrado y Descuento por Meta.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<BeneficioTCCInfo> ConsultaBeneficios(long pCodigoBeneficio, short pTipoBeneficio, string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción | |||||||
pCodigoBeneficio | long | Código del beneficio a consultar. | |||||||
pTipoBeneficio | short | Tipo de beneficio a consultar.
|
|||||||
pUsuario | string | Usuario a utilizar para el consumo del método. | |||||||
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<BeneficioTCCInfo> | Objeto resultado, el cual devuelve un objeto del tipo BeneficioTCCInfo con la información correspondiente al beneficio requerido. |
-ConsultaOfertasExclusivas #
Este método consulta una oferta exclusiva en el sistema TCC.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<OfertaExclusivaTCCInfo> ConsultaOfertasExclusivas(long pCodigoOferta, string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pCodigoOferta | long | Código de la oferta exclusiva a obtener. |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<OfertaExclusivaTCCInfo> | Objeto resultado, el cual trae el objeto OfertaExclusivaTCCInfo con la información de la oferta. |
-ConsultarBeneficiosLocales #
Devuelve los beneficios completos basados en una lista que se le paso como parámetro. Normalmente este método se manda a llamar después de llamar al método ConsultarBeneficiosReducido.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<BeneficioResultado> ConsultarBeneficiosLocales(System.Collections.Generic.List<BeneficioReducido> Beneficios, string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
Beneficios | List<BeneficiosReducido> | Lista de los beneficios a consultar. |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<BeneficioResultado> | Objeto resultado, el cual trae el objeto BeneficioResultado con todos los beneficios consultados. |
-ConsultarBeneficiosReducido #
Este método devuelve la lista de los códigos de beneficios que son válidos en una tarjeta para un determinado establecimiento. Este es normalmente el método que se llama para obtener los beneficios de una tarjeta después de que se escaneo el código de barras.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<ConsultaBeneficioReducido> ConsultarBeneficiosReducido(long pCodigoTarjeta, long pEstablecimiento, string UsuarioTCC, string ContrasenaTCC) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pCodigoTarjeta | long | Código de la tarjeta a obtener sus beneficios. |
pEstablecimiento | long | Id del establecimiento donde se está haciendo la petición. |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<ConsultaBeneficioReducido> | Objeto resultado, el cual devuelve un objeto del tipo ConsultaBeneficioReducido que contiene datos de la tarjeta así como la lista de beneficios válidos y no válidos para ese establecimiento. |
-ConsultarBeneficiosTCC #
Consulta todo el beneficio asociado a una tarjeta, no hace validaciones de establecimientos, fechas de vencimientos, simplemente se trae todo lo asociado a una tarjeta TCC.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<TarjetaClienteConsentidoInfo> ConsultarBeneficiosTCC(long pCodigoTarjeta, string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pCodigoTarjeta | long | Código de la tarjeta a obtener sus beneficios. |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<TarjetaClienteConsentidoInfo> | Objeto resultado, el cual trae el objeto TarjetaClienteConsentido con la información de la tarjeta TCC. |
-ConsultarClienteTCC #
Consulta un cliente consentido registrado en el sistema TCC, se trae todos los datos del mismo.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<ClienteConsentidoTCCInfo> ConsultarClienteTCC(long pCodigoCliente, string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pCodigoCliente | long | Código del cliente consentido a obtener . |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<ClienteConsentidoTCCInfo> | Objeto resultado, el cual trae el objeto ClienteConsentidoTCCInfo con toda la información relacionada al cliente registrado. |
-ConsultarCompueje #
Nos regresa los últimos n movimientos registrados para una tarjeta TCC.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<CompuejeResultado> ConsultarCompueje(long pCodigoTarjeta, int pMovimientos, string pUsuarioTCC, string pContrasenaTCC) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pCodigoTarjeta | long | Código de la tarjeta a obtener sus movimientos (compuejes). |
pMovimientos | int | Cantidad de movimientos a obtener. |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<CompuejeResultado> | Objeto resultado, el cual trae el objeto CompuejeResultado con la lista de los últimos n movimientos. |
-ConsultaReferencias #
Este método se trae la lista de referencias dentro del sistema TCC para mostrarse en la página web, estas referencias se configuran usando la aplicación Administración TCC y se utilizan para obtener más información del cliente consentido. Esas referencias aparecen en forma de etiquetas en el formulario de registro de cliente mediante la página web.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<List<string>> ConsultaReferencias(string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<List<string>> | Objeto resultado, se trae la lista de referencias registradas en el sistema TCC. |
-ConsultarIntereses #
Se trae todos los intereses registrados en el sistema TCC, se utilizan para mostrarlos en el formulario de registro de cliente mediante la página web.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<List<InteresTCCInfo>> ConsultarIntereses(string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<List<InteresTCCInfo> | Objeto resultado, contiene la lista de objetos InteresesTCCInfo registrados en el sistema TCC. |
-ConsultarLlaverin #
Consulta el llaverín asociado a una tarjeta de cliente consentido.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<string> ConsultarLlaverin(long pCodigoTarjeta, string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pCodigoTarjeta | long | Código de la tarjeta de la cual se quiere obtener el código de llaverin. |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<string> | Objeto resultado, el cual trae el código del llaverin de la tarjeta TCC. |
-ConsultarOcupaciones #
Consulta todas las ocupaciones que se hayan registrado en el sistema TCC, se utilizan para mostrarlos en el formulario de registro de cliente mediante la página web.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<List<OcupacionTCCInfo>> ConsultarOcupaciones(string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<List<OcupacionTCCInfo> | Objeto resultado, contiene la lista de objetos OcupacionTCCInfo registrados en el sistema TCC. |
-ConsultarUsuarioWeb #
Este método valida que exista un cliente por su correo y contraseña, se utiliza para el login de la página web.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<UsuarioWeb> ConsultarUsuarioWeb(string pCorreoElectronico, string pContrasena, string pUsuariotcc, string pContrasenatcc) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pCorreoElectronico | string | Correo electrónico del cliente registrado. |
pContrasena | string | Contraseña del cliente registrado. |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<UsuarioWeb> | Objeto resultado, el usuario para uso web si es que el correo y la contraseña se encontraron como parte de un cliente registrado en el sistema TCC. |
-ConsultaValeElectronico #
Consulta un beneficio del tipo vale electrónico dentro del sistema TCC.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<ValeElectronicoTCCInfo> ConsultaValeElectronico(long pCodigoVale, string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pCodigoVale | long | Código del vale electrónico a obtener. |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<ValeElectronicoTCCInfo> | Objeto resultado, el cual trae el objeto ValeElectronicoTCCInfo con la información del vale electrónico. |
-RecuperaContrasena #
Este método se utiliza para generar una nueva contraseña para el cliente que haya olvidado la suya.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<bool> RecuperaContrasena(string pCorreo, string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pCorreo | string | Correo electrónico del cliente. |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<bool> | Objeto resultado, regresa si la operación de generación de contraseña resulto valida. |
-RegistroClienteTCC #
Este método se encarga de hacer el registro de un cliente mediante el formulario de registro de la página web.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<long> RegistroClienteTCC(ComputacionXXI.TCC.Blcs.ClienteConsentidoTCCInfo pCliente, string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pCliente | ClienteConsentidoTCCInfo | Objeto ClienteConsentidoTCCInfo con la información del cliente para registrar. |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<long> | Objeto resultado, regresa el código del cliente registrado. |
#
-ValidaTCC #
Devuelve el estado en el cual se encuentra la tarjeta de cliente consentido.
public ComputacionXXI.TCC.TCCWS.ResultadoWS<EnumEstadoTarjetaClienteConsentido> ValidaTCC(long pCodigoTarjeta, string pUsuario, string pContrasena) |
Parámetros de entrada: #
Parámetro | Tipo de dato | Descripción |
pCodigoTarjeta | long | Código de la tarjeta TCC. |
pUsuario | string | Usuario a utilizar para el consumo del método. |
pContrasena | string | Contraseña a utilizar para el consumo del método. |
Datos de salida: #
Tipo de dato | Descripción |
ResultadoWS<EnumEstadoTarjetaClienteConsentido> | Objeto resultado, objeto enumerado con el estado de la tarjeta TCC. |
Tipos de datos TCC #
public class CompuejeBeneficioTMPTCCInfo
Esta clase representa un movimiento por hacer dentro del sistema TCC para una tarjeta TCC. |
Miembro | Tipo de dato | Descripción | |||||||
Abono | decimal | Abono que se aplicara en el movimiento. | |||||||
ArtCodigo | string | Código del artículo que participa en ese beneficio. | |||||||
BeCodigo | long | Código del beneficio que participa en el movimiento. | |||||||
Beneficio | EnumTipoBeneficio | Tipo de benefiico.
|
|||||||
Cargo | decimal | Cargo que se aplicara en el movimiento. | |||||||
Consecutivo | long | Consecutivo de los renglones del ticket. | |||||||
Fecha | DateTime | Fecha del movimiento. | |||||||
FolConsecutivo | long | Consecutivo de las ventas o tickets del establecimiento. | |||||||
FolDocCodigo | long | ID que identifica un ticket en el establecimiento. | |||||||
FolEstCodigo | long | ID de la estación (caja) en el establecimiento durante ese movimiento. | |||||||
FolTdaCodigo | long | ID de la tienda. | |||||||
Identificador | int | Llave primaria. Se autogenera. | |||||||
IdTransaccion | long | ID de la transacción, se tiene que generar un ID único por cada transacción. | |||||||
Importe | decimal? | Importe de la venta. Puede ir nulo si no aplica. | |||||||
Porcentaje | decimal? | Porcentaje de descuento, Puede ir nulo si no aplica. | |||||||
SaldoFinal | decimal | Saldo final después de hacer el movimiento. | |||||||
SaldoInicial | decimal | Saldo inicial antes de hacer el movimiento | |||||||
TCCCodigo | long | Código de la tarjeta a la cual se le aplicaran los movimientos. | |||||||
VEIdentificador | long? | Código del vale cuando se devengue un vale. | |||||||
public class ClienteConsentidoTCCInfo
Representa un cliente registrado en el sistema TCC. |
Miembro | Tipo de dato | Descripción | |||
Aniversario | DateTime | Fecha de cumpleaños del Cliente Consentido | |||
ApellidoMaterno | string | Apellido Materno del Cliente Consentido | |||
ApellidoPaterno | string | Apellido Paterno del Cliente Consentido | |||
Atributos | List<AtributoTCCInfo> | Listado de atributos del Cliente Consentido | |||
Codigo | long | Código del Cliente Consentido | |||
CodigoPostal | string | Código postal del Cliente Consentido | |||
Colonia | string | Colonia del domicilio del Cliente Consentido | |||
Contrasena | byte[] | Contraseña para el loggeo al sistema Web | |||
CreadoPor | long? | Código del usuario que ha creado el Cliente Consentido | |||
Domicilio | string | Domicilio del Cliente Consentido | |||
string | Correo electrónico del Cliente Consentido | ||||
Estado | EnumEstadosClienteConsentido | Estatus actual del Cliente Consentido
|
|||
EstadoCivil | EnumEstadoCivilClienteConsentido | Estado civil del Cliente Consentido
|
|||
EstadoU | string | Estado de la republica del Cliente Consentido | |||
FechaCreacion | DateTime | Fecha de creación del Cliente Consentido | |||
FechaModificacion | DateTime | Fecha de la última modificación al Cliente Consentido | |||
Genero | EnumGeneroClienteConsentido | Genero del Cliente Consentido.
|
|||
Intereses | List<InteresTCCInfo> | Listado de Intereses del Cliente Consentido | |||
Link | string | Este valor se utilizará cuando el sistema haga la captura de un intento de cliente en la página web, cuando es un «ClienteTmp» | |||
ModificadoPor | long? | Código del usuario que modifico por última vez el Cliente Consentido | |||
Municipio | string | Municipio del Cliente Consentido | |||
Nombre | string | Nombre del Cliente Consentido | |||
Notas | string | Notas sobre el Cliente Consentido | |||
NumeroExterior | string | Número Exterior del domicilio del Cliente Consentido | |||
NumeroInterior | string | Número Interior del domicilio del Cliente Consentido | |||
Ocupaciones | List<OcupacionTCCInfo> | Listado de ocupaciones del Cliente Consentido | |||
OrgCodigo | long | Código del Organizador de Cliente Consentido | |||
OrgCodigoAnterior | long | Código del organizador de clientes consentidos antes de una actualización | |||
Pais | string | País del Cliente Consentido | |||
RecibirActualizaciones | bool | Indica si el Cliente Consentido deberá recibir actualizaciones al correo electrónico | |||
Referencia1 | string | Referencia 1 del Cliente Consentido | |||
Referencia2 | string | Referencia 2 del Cliente Consentido | |||
TarjetaClienteConsentido | long | Código de la tarjeta actual del cliente. | |||
TarjetasClienteConsentido | List<TarjetaClienteConsentidoInfo> | Listado de tarjetas asignadas al Cliente Consentido | |||
TelefonoDomicilio | string | Teléfono del domicilio del Cliente Consentido | |||
TelefonoMovil | string | Teléfono celular del Cliente Consentido | |||
TelefonoOtro | string | Algún otro teléfono del Cliente Consentido |
public class AtributoTCCInfo
Es un atributo que se puede asignar a un beneficio, tarjeta o cliente. |
Miembro | Tipo de dato | Descripción |
Codigo | long | Código del atributo. |
Nombre | string | Nombre del atributo. |
public class InteresTCCInfo
Representa un interés para los clientes consentidos ejemplo: (Música, Literatura, Computación) |
Miembro | Tipo de dato | Descripción |
Codigo | long | Código del interés. |
Nombre | string | Nombre del interés. |
public class OcupacionTCCInfo
Representa una ocupación para los clientes consentidos ejemplo: (Maestro, Taxista, Ingeniero) |
Miembro | Tipo de dato | Descripción |
Codigo | long | Código de la ocupación. |
Nombre | string | Nombre de la ocupación. |
public class BeneficioReducido
Esta clase se usa para obtener los beneficios completos, en ella solo se contiene el código del beneficio, así como el tipo. |
Miembro | Tipo de dato | Descripción | |||||||
Acumulado | decimal | Acumulado del beneficio. | |||||||
CodigoBeneficio | long | Código del beneficio. | |||||||
TipoBeneficio | EnumTipoBeneficio | Tipo de beneficio.
|
public class ResultadoTransaccion
Representa el resultado después de hacer una confirmación de transacción. |
Miembro | Tipo de dato | Descripción |
SaldoActualMonedero | decimal | Saldo en monedero después de hacer una confirmación una aplicación de beneficios. |
SaldoActualPuntos | decimal | Saldo en puntos después de hacer una confirmación una aplicación de beneficios. |
SaldoAnteriorMonedero | EnumTipoBeneficio | Saldo en monedero antes de hacer una confirmación una aplicación de beneficios. |
SaldoAnteriorPuntos | decimal | Saldo en puntos antes de hacer una confirmación una aplicación de beneficios. |
ValesGanados | List<ValeElectronicoTCCInfo> | Vales ganados durante la aplicación de beneficios. |
public class BeneficioResultado
Trae todos los beneficios completos consultados. |
Miembro | Tipo de dato | Descripción |
Beneficios | List<BeneficioTCCInfo> | Lista de todos los cupones timbrados/perforados, descuentos por meta. |
Ofertas | List<OfertaExclusivaTCCInfo> | Lista de todas las ofertas exclusivas. |
Vales | List<ValeElectronicoTCCInfo> | Lista de todos los vales electrónicos. |
public class ConsultaBeneficioReducido
Contenedor con los beneficios válidos y los no válidos para un determinado establecimiento. |
Miembro | Tipo de dato | Descripción |
Beneficios | List<BeneficioReducido> | Lista de los beneficios válidos. |
CodigoTarjeta | long | Código de la tarjeta. |
MonederoLimiteAsignacionIndividual | decimal | Límite de asignación individual en monedero. |
MonederoLimiteSaldo | decimal | Límite de un monedero. |
MonederoMinCompra | decimal | Mínimo de compra para utilizar el monedero. |
NoValidos | List<BeneficioReducido> | Lista con los beneficios no válidos. |
PuntosLImite | decimal | Puntos limite por tarjeta. |
PuntosMinCompra | decimal | Se usa para validar el mínimo de compra en el punto de venta para poder generar puntos |
SaldoMonedero | decimal | Saldo en monedero. |
SaldoPuntos | decimal | Saldo en puntos. |
public class TarjetaClienteConsentidoInfo
Clase que contiene la tarjeta del cliente consentido TCC. |
Miembro | Tipo de dato | Descripción | |||||
Atributos | List<AtributoTCCInfo> | Lista de los atributos de la tarjeta. | |||||
Beneficios | List<TarjetaCCBeneficioInfo> | Lista de los beneficios en la tarjeta. | |||||
CCCodigo | long? | Código del cliente consentido si es que lo hay. | |||||
Codigo | long | Código de la tarjeta. | |||||
CodigoLlaverin | string | Código del llaverin. | |||||
List<BeneficioReducido> | Lista con los beneficios no válidos. | ||||||
Estado | EnumEstadoTarjetaClienteConsentido | Estados de la tarjeta.
|
|||||
NombreCliente | string | Nombre del cliente si es que lo hay. | |||||
OfertasExclusivas | List<TarjetaCCOfertaExclusivaInfo> | Lista de las ofertas exclusivas de la tarjeta. | |||||
OrgCodigo | long | Código del organizador de TCC. | |||||
SaldoMonedero | decimal | Saldo en monedero. | |||||
SaldoPuntos | decimal | Saldo en puntos. | |||||
UltimoMovimiento | DateTime? | Fecha último movimiento si es que lo hay. | |||||
Vales | List<TarjetaCCValeElectronicoInfo> | Listado de los vales electrónicos de la tarjeta. |
public class CompuejeResultado
Resultado con un listado de movimientos en el compueje de una tarjeta. |
Miembro | Tipo de dato | Descripción |
ListaCompuejes | List<CompuejeBeneficioTCCInfo> | Lista de los movimientos compueje. |
NombreCliente | string | Nombre del cliente asociado a la tarjeta si es que lo hay. |
public class UsuarioWeb
Representa un usuario web registrado en TCC para usarse en la página web. |
Miembro | Tipo de dato | Descripción |
CodigoCliente | long | Código del cliente registrado. |
CodigoTarjeta | long | Código de la tarjeta. |
EstadoCliente | EnumEstadosClienteConsentido | Estado del cliente. |
NombreCliente | string | Nombre del cliente. |
public class ResultadoWS<T>
Representa un resultado genérico que los métodos del servicio web retornan. T Define el tipo de dato parametrizable. |
|||
Miembro | Tipo de dato | Descripción | |
AvisoBeneficiosNoValidos | string | Mensaje de alerta al cliente pada cuando no apliquen todos los beneficios. | |
CodigosErrores | List<int> | Lista de códigos de posibles errores encontrados. | |
Excepcion | Exception | Excepción ocurrida si es que la hay. | |
NombreCliente | string | Nombre del cliente. | |
MensajeError | String | Mensaje de error si es que falló la operación. | |
Resultado | T | Resultado devuelto por el método web. |
Nota:
La verificación de si un método web realizo con éxito su operación se hace revisando la lista de CodigosErrores en busca del código “00”, el cual indica que la operación terminó sin ningún problema.