Servicio Web para la funcionalidad del OTP del Banco Agrario Con la finalidad de poder brindar el servicio web

de envo de mensajes de texto a cualquiera de las aplicaciones del Banco Agrario que deseen utilizarlo, se va a implementar una nueva interface que expone 2 nuevos servicios con informacin ms detallada de los usuarios, servicios, errores, estados de sms y dems datos requeridos por el cliente. A continuacin describo cada uno de los servicios, los parmetros requeridos y la utilizacin de estos 1. SmsResponse enviarSms(SmsRequest smsRequest): Ingresa un SMS en el sistema y
lo registra como pendiente para ser enviado. Datos de entrada: SmsRequest Objeto que representa la peticin de envo de mensaje de texto, se compone de las siguientes atributos:

SmsControl: Objeto que representa los datos de control para el envo del mensaje de texto, se compone de los siguientes atributos: Nombre usuario password cliente codigo String String String String Tipo Descripcin Usuario del servicio Contrasea del usuario del servicio Descripcin del cliente y aplicacin que utiliza el servicio Cdigo asignado al cliente para la utilizacin del servicio

SmsIn: Objeto que representa el mensaje de texto a ser enviado, se compone de los siguientes atributos: Nombre referencia nombrePersona mensaje prioridad numeroCelular String String String Integer Long Tipo Descripcin Motivo o referencia del sms o grupo de sms Nombre de la persona a la que va ser enviado el sms Mensaje o texto a ser enviado Prioridad del envo del SMS(entre ms alto, mayor prioridad) Nmero de celular al que va ser enviado el SMS

A continuacin se muestra una imagen de ejemplo de los parmetros del envo de sms

Datos de salida SmsResponse: Objeto que representa la informacin de un sms ingresado al sistema. Si se produce un error en el momento de insertar en el sistema, se devuelve con un error y una descripcin. Se compone de los siguientes atributos: Nombre id referencia Long String Tipo Descripcin Identificador nico del sms en el sistema. Sirve para busquedas. Motivo o referencia del sms o grupo de sms

fecha estado

Date String

Fecha de creacin Estado del SMS en el sistema. Tiene los siguientes estados: PENDIENTE: Est en espera para ser enviado. Representa tambin que el SMS fue ingresado correctamente al sistema. ENVIADO: El SMS ha sido enviado correctamente. ERROR: El SMS no pudo ser ingresado al sistemas o el SMS no ha podido ser enviado. Fecha en que se asign el estado actual del sms. Cdigo de error si se genera una excepcin, los cdigos son los siguientes: 01: Usuario y password incorrectos 02: Cdigo cliente inexistente 03: Faltan datos obligatorios 04: Validacin de datos incorrecta 05: Error en el envo del sms 06: Error del sistema Descripcin detallada del error si se genera una excepcin

fechaEstado codigoError

Date String

descripcionError

String

A continuacin se muestra el cdigo xml generado por la respuesta del envo del sms. <env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> <env:Header/> <env:Body> <ns2:enviarSmsResponse xmlns:ns2="http://facade.core.bancoagrario.crm.millenium.com/"> <SmsResponse> <estado>Pendiente</estado> <fecha>2011-03-02T23:25:29.685-05:00</fecha> <fechaEstado>2011-03-02T23:25:29.685-05:00</fechaEstado> <id>1231</id> <referencia>Pruebas</referencia> </SmsResponse> </ns2:enviarSmsResponse> </env:Body> </env:Envelope>

1. SmsResponse obtenerSms(Long id): Obtiene la informacin de un SMS por el id

dado Datos de entrada: id: identificador nico del SMS ingresado en el sistema.

Datos de salida:

SmsResponse: Igual que el objeto del anterior servicio.