API DE INTEROPERACION ENTRE TELCEL Y MOVILTEK PARA EL REGISTRO DE EQUIPOS AVL

Transcripción

1 MANUEL J. CHAVIRA INS-035R04 10-Nov-06 1 de 23 TABLA DE CONTENIDO 1 1 INTRODUCCIÓN COMUNICACIÓN INTERCAMBIO DE DATOS SOAP SEGURIDAD FASES OPERATIVAS 4 2 REFERENCIA PARA CONSUMIR EL SERVICIO WEB SERVIDOR DE PRUEBAS SERVIDOR DEFINITIVO 7 3 DESCRIPCION DE LOS MÉTODOS DISPONIBLES DEL SERVICIO WEB ALTA DE LINEA CONSULTA DE LINEA EDICIÓN DE DATOS DE LINEA CANCELACIÓN DE LINEA 11 4 TRANSACCIONES DE DATOS TIPOS DE DATOS IDENTIFICADOR DE TRANSACCIÓN RESULTADO DE UNA TRANSACCIÓN PARÁMETROS OPCIONALES Y OBLIGATORIOS 15 5 DESCRIPCION DETALLADA DE LOS METODOS DISPONIBLES ALTA DE LINEA CONSULTA DE LINEA EDICIÓN DE DATOS DE LINEA CANCELACIÓN DE LINEA 22 Control de Cambios del Documento Fecha Sección Afectada Cambio Realizado 10-Nov Resultado de una Transacción Se modificó la tabla de los Códigos de Escape o Resultado

2 MANUEL J. CHAVIRA INS-035R04 10-Nov-06 2 de 23 REFERENCIA Documento INS-036R02: PROCESO GENERAL DE PUESTA EN OPERACIÓN DE EQUIPOS DE LOCALIZACION DE VEHICULOS 1 INTRODUCCIÓN Este API permite la implementación de la primera fase del proceso general de puesta en operación de los equipos de localización de vehículos, misma que consiste en el aprovisionamiento de las líneas móviles que serán, en un paso posterior, asignadas a los equipos móviles. Las funciones descritas por este documento están totalmente orientadas al aprovisionamiento y administración de los registros de líneas exclusivamente, quedando para la segunda etapa las actividades de registro de las unidades, cliente, cuentas de acceso a las interfaces de monitoreo, etc. Sólo la primera etapa del proceso estará a cargo de Telcel. La segunda etapa correrá por cuenta de los centros de instalación de equipos. 1.1 COMUNICACIÓN El API de interoperación se ejecuta por medio de Web Services utilizando el protocolo SOAP para el intercambio de datos XML. 1.2 INTERCAMBIO DE DATOS Los datos de entrada y salida de los Web Services se intercambian mediante XML. El metalenguaje extensible XML permite definir la gramática de lenguajes específicos, por lo tanto no es realmente un lenguaje en particular, sino una manera de definir lenguajes para diferentes necesidades. Aunque nació en aplicaciones que operan en Internet, en realidad se propone como un estándar para el intercambio de información estructurada entre diferentes plataformas. XML es una tecnología sencilla que tiene a su alrededor otras que la complementan y la hacen mucho más grande y con unas posibilidades mucho mayores. Tiene un papel muy importante en la actualidad ya que permite la compatibilidad entre sistemas para compartir la información de una manera segura, fiable y fácil. VENTAJAS Algunas características de XML hacen de ésta la opción ideal para la transferencia de datos Por su formato estructurado y documentado, es inteligible tanto para máquinas como para personas.

3 MANUEL J. CHAVIRA INS-035R04 10-Nov-06 3 de 23 Soporta Unicode, por lo que permite incluir prácticamente cualquier tipo de información en prácticamente cualquier idioma humano. Permite representar las estructuras informáticas más generales: registros, listas y árboles. El formato autodocumentado describe la estructura, nombres de campos y valores, simplificando su comprensión y análisis. La estricta sintaxis ayuda a que los algoritmos de procesamiento sean simples, eficientes y consistentes. Adicionalmente, otras ventajas de XML son: Es un formato robusto y lógico basado en estándares internacionales. Su estructura jerárquica lo hace adecuado para la mayoría de los tipos de documentos. Se almacena como archivos de texto plano, ajenos a licencias o restricciones de derechos. Es independiente de la plataforma operativa, por lo que resulta inmune a los cambios en las tecnologías. Ha estado en uso desde hace años, por lo que hay amplia experiencia en el desarrollo de aplicaciones que lo utilicen. DESVENTAJAS A pesar de todas sus bondades, XML cuenta también con deficiencias para algunas aplicaciones, como la que se pretende implementar: Su sintaxis es redundante y abundante en texto, por lo que puede ser una deficiencia cuando el ancho de banda es limitado, además de requerir mayor espacio para almacenamiento y procesamiento. Los requerimientos de inclusión de datos, no soportan una amplia variedad de tipos de datos, por lo que se requiere implementar algoritmos más complejos para procesar los datos de un documento toda vez que se incluye toda la información como texto. 1.3 SOAP SOAP (siglas de Simple Object Access Protocol) es un protocolo estándar creado por Microsoft, IBM y otros, está actualmente bajo el auspicio de la W3C que define cómo dos objetos en diferentes procesos pueden comunicarse por medio de intercambio de datos XML. SOAP es uno de los protocolos utilizados en los servicios Web.

4 MANUEL J. CHAVIRA INS-035R04 10-Nov-06 4 de 23 A diferencia de DCOM y CORBA, que son binarios, SOAP usa el código fuente en XML. Esto es una ventaja ya que facilita su lectura por parte de humanos, pero también es un inconveniente dado que los mensajes resultantes son más largos. El intercambio de mensajes se realiza mediante tecnología de componentes (software componentry, ver ingeniería de software). El término Object en el nombre significa que se adhiere al paradigma de la programación orientada a objetos. SOAP es un marco extensible y descentralizado que permite trabajar sobre múltiples pilas de protocolos de redes informáticas. Los procedimientos de llamadas remotas pueden ser modelados en la forma de varios mensajes SOAP interactuando entre sí. SOAP funciona sobre cualquier protocolo de Internet, generalmente HTTP, que es el único homologado por el W3C. SOAP tiene como base XML, con un diseño que cumple el patrón Cabecera-Desarrollo de diseño de software, como otros muchos diseños, verbigracia HTML. La cabecera Header es opcional y contiene metadatos sobre enrutamiento (routing), seguridad o transacciones. El desarrollo Body contiene la información principal, que se conoce como carga útil (payload). La carga útil se acoge a un XML Schema propio. 1.4 SEGURIDAD Como complemento a la propuesta original, se ha implementado como medida de seguridad el uso de un nombre de usuario y una contraseña, los cuales deberán incluirse en cada transacción solicitada. El catálogo de usuario se construirá en forma independiente en conjunto entre Telcel y Moviltek. Puede generarse un catálogo tan detallado como se requiera o emplear un único juego de datos de acceso. 1.5 FASES OPERATIVAS Como se detalla en el documento al que se hace referencia, el proceso general de puesta en operación de los equipos de localización, se compone por varias fases, mismas que es conveniente mencionar brevemente. Para mayores detalles consúltese el documento referido. Fase Responsable Acciones 1 Ejecutivo de Ventas o Atención, o Distribuidor de Telcel Trámite y papelería comercial (contratación). Dar de alta la línea y al cliente en el sistema convencional. Asignar equipo al nuevo suscriptor. Aprovisionar en la Plataforma Moviltek la línea telefónica, el radio y el SIM asignados, así como el plan tarifario contratado. Estos datos quedarán en la base de datos de la Plataforma como línea registrada pendiente de asignar a un usuario y vehículo,

5 MANUEL J. CHAVIRA INS-035R04 10-Nov-06 5 de 23 hasta que se realice la Fase 3. Entregar al nuevo suscriptor su documentación, el equipo físicamente, la tarjeta SIM y una lista de los centros autorizados de instalación del equipo móvil. 2 Suscriptor Acudir al centro autorizado de instalación de su elección, llevando el equipo móvil, la tarjeta SIM, la documentación que le haya entregado Telcel y el vehículo. Los datos imprescindibles serán los 3 elementos aprovisionados en la Plataforma Moviltek: - MSISDN (Mobile Suscriber ISDN) - IMEI (International Mobile Equipment Identity) - IMSI (International Mobile Subscriber Identifier) 3 Instalador Aprovisionar en la Plataforma Moviltek, todos los datos del equipo móvil y asignarle la línea telefónica previamente aprovisionada en la misma Plataforma por Telcel. Si es un cliente nuevo crear su perfil. Si es un cliente ya existente, agregar el equipo y línea a su cuenta de usuario o perfil. Realizar la instalación física y eléctrica del equipo móvil en el vehículo designado para ello. 4 Suscriptor Operar la localización desde las interfaces de monitoreo disponibles en la Plataforma. 5 Call Center Operar la localización asistida en caso de siniestros, así como las acciones de control: paro de motor, control de seguros, sirena, etc. En la Fase 1, se realiza el aprovisionamiento de la línea móvil en la Plataforma Moviltek. La información del presente documento se refiere exclusivamente a las actividades de esta fase, que serán implementadas y utilizadas por los sistemas y personal de Telcel. Una vez aprovisionada una línea, estará disponible para ser asociada a un equipo móvil en la Fase 3. A esta Fase 1, se le llamará en lo sucesivo Fase de Aprovisionamiento o simplemente Aprovisionamiento. En la Fase 3, se realiza el registro de los detalles del equipo de localización, del vehículo, del usuario, de las cuentas de acceso a las interfaces de monitoreo y en ella se vincula el registro del equipo con la línea telefónica que se le asignará, misma que deberá de haber sido aprovisionada previamente por Telcel. A esta Fase 3, se le llamará en lo sucesivo Fase de Registro o simplemente Operación. Las Fases 4 y 5 corresponden a la operación del sistema, en la modalidad autónoma (4) y asistida por el centro de monitoreo o Call Center (5).

6 MANUEL J. CHAVIRA INS-035R04 10-Nov-06 6 de 23 Internamente en la Plataforma, en un esquema simplificado, cuenta con dos bases de datos: Líneas Aprovisionadas Contiene todas aquellas líneas que hayan sido previamente aprovisionadas por Telcel, las cuales están disponibles para ser asignadas a los equipos durante la fase de registro. Los datos que se incluyen son el MSISDN, el IMEI, el IMSI, el Status (suspendido o activo), el Product (plan tarifario) y el Transaction_ID o número de referencia de las transacción realizada. Móviles en Operación Contiene todos aquellos móviles que ya se han registrado y a los cuales se les ha asignado una línea previamente aprovisionada en la Plataforma. Los datos que contiene son los propios de la línea, más los datos del equipo localizador, los datos del vehículo automotor así como la información del usuario y sus cuentas de acceso a las interfaces de monitoreo. Dependiendo del estado de aprovisionamiento de la línea que se refiera al ejecutar cualquiera de los métodos del servicio web, se afectará a una u otra base de datos.

7 MANUEL J. CHAVIRA INS-035R04 10-Nov-06 7 de 23 2 REFERENCIA PARA CONSUMIR EL SERVICIO WEB 2.1 SERVIDOR DE PRUEBAS Disponible a partir del 8 de Noviembre de 2006, a las 10:00 horas, en la ubicación SERVIDOR DEFINITIVO Disponible una vez que se concluya la etapa de desarrollo

8 MANUEL J. CHAVIRA INS-035R04 10-Nov-06 8 de 23 3 DESCRIPCION DE LOS MÉTODOS DISPONIBLES DEL SERVICIO WEB 3.1 ALTA DE LINEA a) La aplicación de TELCEL Ejecuta el método WS_TCL_01 pasando los parámetros: PARÁMETRO User Password Transaction_ID MSISDN IMSI IMEI Product DESCRIPCIÓN Nombre de usuario de la cuenta de acceso Contraseña de la cuenta de acceso Identificador de la Transacción (Generado al momento de la ejecución) Número asignado a la línea telefónica Número de la tarjeta SIM (International Mobile Subscriber Identity) Número Electrónico del Transceptor (International Mobile Equipment Identity) Producto de Servicio (Plan Tarifario) b) La Plataforma realiza una validación en su registro de datos buscando si ya existe la línea que se pretende aprovisionar. Si se encuentra la misma línea (MSISDN) en cualquiera de los dos estados (aprovisionamiento u operación), se devuelve un código de escape indicando que la acción no pudo ejecutarse por haberse generado una condición de excepción. Los códigos de escape se describen en la sección 4.3 RESULTADO DE UNA TRANSACCIÓN. c) Si la línea (MSISDN) que se pretende aprovisionar como nueva, pasa la validación previa, la Plataforma crea un nuevo registro en la base de datos de Líneas Aprovisionadas, usando los datos recibidos. d) Una vez aprovisionada la nueva línea, se registra la transacción en la bitácora interna de la Plataforma y queda lista para ser asignada posteriormente a un móvil, en la fase de registro. NOTA. La descripción detallada de la ejecución y la respuesta de este método se incluye en la sección 5.1 ALTA DE LINEA.

9 MANUEL J. CHAVIRA INS-035R04 10-Nov-06 9 de CONSULTA DE LINEA a) La aplicación de TELCEL ejecuta el método WS_TCL_02 pasando los parámetros: PARÁMETRO User Password Transaction_ID MSISDN_Key DESCRIPCIÓN Nombre de usuario de la cuenta de acceso Contraseña de la cuenta de acceso Identificador de la Transacción (Generado al momento de la ejecución) Dato de búsqueda correspondiente al número de la línea telefónica b) La Plataforma realiza una consulta en las bases de datos. Si encuentra una coincidencia del dato introducido, devuelve los detalles de la línea: DATO Fase Client Vehicle MSISDN IMSI IMEI Product Status DESCRIPCIÓN Fase de Registro en que se encuentra la la línea: "Aprovisionamiento" La línea ha sido aprovisionada pero no está asignada a un móvil. "Operación" La línea se encuentra en operación, asignada a un móvil Identificador del Cliente, propietario del equipo móvil al que fue asignada la línea en la Fase de Operación Identificadores del Equipo Móvil, asignados en la Fase de Operación Número asignado a la línea telefónica Número de la tarjeta SIM (International Mobile Subscriber Identity) Número Electrónico del Transceptor (International Mobile Equipment Identity) Producto de Servicio (Plan Tarifario) Estado de Operación actual de la Línea: "Active" Línea activa. 100% operativa. "Suspended" Línea suspendida por Telcel. Se devuelve también un código de escape que indica si la ejecución tuvo éxito o si se presentó una condición de excepción. Los códigos de escape se describen en la sección 4.3 RESULTADO DE UNA TRANSACCIÓN. c) Se registra la transacción en la bitácora interna de la Plataforma. NOTA. La descripción detallada de la ejecución y la respuesta de este método se incluye en la sección 5.2 CONSULTA DE LINEA.

10 MANUEL J. CHAVIRA INS-035R04 10-Nov de EDICIÓN DE DATOS DE LINEA a) La aplicación de TELCEL Ejecuta el método WS_TCL_03 pasando los parámetros OBLIGATORIOS: PARÁMETRO User Password Transaction_ID MSISDN_Key IMSI_Key IMEI_Key DESCRIPCIÓN Nombre de usuario de la cuenta de acceso Contraseña de la cuenta de acceso Identificador de la Transacción (Generado al momento de la ejecución) Dato de búsqueda. Número de la línea telefónica. Dato de seguridad. Número de IMSI (SIM) Dato de seguridad. Número de IMEI. Adicionalmente es obligatorio incluir por lo menos uno de los siguientes parámetros opcionales: PARÁMETRO MSISDN IMSI IMEI Product Status DESCRIPCIÓN Nuevo dato. Opcional. Nuevo dato. Opcional. Nuevo dato. Opcional. Nuevo dato. Opcional. Nuevo dato. Opcional: "Active" "Suspended" Línea activa. 100% operativa. Línea suspendida por Telcel. b) La Plataforma realiza una consulta en sus bases de datos. Si encuentra un registro en el que coincidan los 3 parámetros especificados como actuales (MSISDN_Key, IMSI_Key e IMEI_Key), se realiza el cambio de el(los) parámetro(s) opcional(es) solicitado(s). Se devuelve también un código de escape que indica si la ejecución tuvo éxito o si se presentó una condición de excepción. Los códigos de escape se describen en la sección 4.3 RESULTADO DE UNA TRANSACCIÓN. c) Se registra la transacción en la bitácora interna de la Plataforma. NOTA. La descripción detallada de la ejecución y la respuesta de este método se incluye en la sección 5.3 EDICION DE DATOS DE LINEA.

11 MANUEL J. CHAVIRA INS-035R04 10-Nov de CANCELACIÓN DE LINEA a) La aplicación de TELCEL Ejecuta el método WS_TCL_04 pasando los parámetros: PARÁMETRO User Password Transaction_ID MSISDN_Key IMSI_Key IMEI_Key DESCRIPCIÓN Nombre de usuario de la cuenta de acceso Contraseña de la cuenta de acceso Identificador de la Transacción (Generado al momento de la ejecución) Dato de búsqueda. Número de la línea telefónica. Dato de seguridad. Número de IMSI (SIM) Dato de seguridad. Número de IMEI. b) La Plataforma realiza una consulta en sus bases de datos. Si encuentra un REGISTRO en el que coincidan los 3 parámetros especificados como actuales (MSISDN_Key, IMSI_Key e IMEI_Key), procede a dar de baja la línea telefónica de la Plataforma. El equipo móvil al que se había asignado quedará desvinculado de la línea, por lo que en las interfaces de monitoreo, en forma opcional, se indicará al usuario el estado de suspensión de su línea. Se devuelve también un código de escape que indica si la ejecución tuvo éxito o si se presentó una condición de excepción. Los códigos de escape se describen en la sección 4.3 RESULTADO DE UNA TRANSACCIÓN. c) Se registra la transacción en la bitácora interna de la Plataforma. NOTA. La descripción detallada de la ejecución y la respuesta de este método se incluye en la sección 5.4 CANCELACION DE LINEA.

12 MANUEL J. CHAVIRA INS-035R04 10-Nov de 23 4 TRANSACCIONES DE DATOS 4.1 TIPOS DE DATOS Los datos de los parámetros que acompañan a cada método del servicio web, así como aquellos devueltos por los mismos, son: PARÁMETRO DESCRIPCIÓN TIPO Y TAMAÑO User Nombre de usuario de la cuenta de acceso Cadena de Texto. Mínimo 4, máximo 12 caracteres. Password Contraseña de la cuenta de acceso Cadena de Texto. Mínimo 4, máximo 12 caracteres. Transaction_ID MSISDN_Key IMSI_Key IMEI_Key MSISDN IMSI IMEI Identificador de la Transacción (Generado al momento de la ejecución) Parámetro de búsqueda. Número de línea telefónica utilizado como entrada en las operaciones de Consulta, Edición y Cancelación. Parámetro de seguridad. Número de la tarjeta SIM utilizado como entrada en las operaciones de Edición y Cancelación. Parámetro de seguridad. Número Electrónico del Transceptor utilizado como entrada en las operaciones de Edición y Cancelación. Número asignado a la línea telefónica Número de la tarjeta SIM (International Mobile Subscriber Identity) Número Electrónico del Transceptor (International Mobile Equipment Identity) Cadena de Texto. Máximo 60 caracteres. Generado en forma dinámica al momento de la ejecución de la transacción, como se detalla en el apartado 4.2 IDENTIFICADOR DE TRANSACCIÓN. Cadena de Texto. Máximo 25 caracteres. Cadena de Texto. Máximo 25 caracteres. Cadena de Texto. Máximo 25 caracteres. Cadena de Texto. Máximo 25 caracteres. Cadena de Texto. Máximo 25 caracteres. Cadena de Texto. Máximo 25 caracteres. Product Producto de Servicio (Plan Tarifario) Cadena de Texto. Máximo 50 caracteres. Fase Fase de Registro en que se encuentra la la línea: "Aprovisionamiento" / "Operación" Cadena de Texto. Máximo 25 caracteres.

13 MANUEL J. CHAVIRA INS-035R04 10-Nov de 23 Client Vehicle Status Codigo de Escape Identificador del Cliente, propietario del equipo móvil al que fue asignada la línea en la Fase de Operación. Identificadores del Equipo Móvil, asignados en la Fase de Operación Estado de la línea telefónica: Active o Suspended Código de escape o resultado de la ejecución del método solicitado. Cadena de Texto. Máximo 30 caracteres. Cadena de Texto. Máximo 25 caracteres. Cadena de Texto. Máximo 10 caracteres. Cadena de Texto. Máximo 3 caracteres. El catálogo de valores posibles se detalla en el apartado 4.3 RESULTADO DE UNA TRANSACCIÓN. 4.2 IDENTIFICADOR DE TRANSACCIÓN Toda transacción debe incluir un identificador para fines de registro histórico en la bitácora de actividades de la Plataforma. Se forma por los datos de Fecha, Hora, MSISDN y el Tipo de Transacción, con la sintaxis que se indica: En donde: YYYY YYYY-MM-DD HH:NN:SS MSISDN TRANS Año en 4 dígitos. (1980 en adelante). MM Número del Mes en 2 dígitos. (01 a 12) DD Día del mes, en 2 dígitos. (01 a 31) HH Hora en 2 dígitos. (00 a 23). NN Minutos en 2 dígitos. (00 a 59). SS Segundos en 2 dígitos. (00 a 59). MSISDN TRANS Línea telefónica Trans_Type que se esté enviando: 01 Alta 02 Consulta 03 Edición 04 Cancelación - Carácter - Los espacios en blanco deben respetarse Ejemplo: Una transacción que consulte los datos de la línea en fecha 15-Junio-07 a las 11:24:51 tendría como Transaction_ID la siguiente cadena: :24:

14 MANUEL J. CHAVIRA INS-035R04 10-Nov de RESULTADO DE UNA TRANSACCIÓN Toda transacción solicitada a la Plataforma, genera un código de resultado o escape, en el cual se indica si la operación solicitada fue exitosa o si se presentó alguna condición de excepción. Adicionalmente, la Plataforma devuelve como referencia a la acción invocada el Transaction_ID mismo que recibió como parte de la solicitud de ejecución de cualquiera de los métodos. Los códigos de resultado o escape son los siguientes: CODIGO DESCRIPCIÓN 0 Inicialización del Método. Se obtiene como respuesta a la ejecución de cualquiera de los métodos en el que se especifiquen todos los parámetros como cadenas de texto vacías. Es de utilidad en el momento de diseño en el entorno de desarrollo para ligar un control a cualquiera de los métodos del servicio web para fines de obtener la estructura inicial sin información. 1 Acción ejecutada exitosamente 100 Error de Sintaxis. Transaction_ID Inválido en formato o contenido. 101 Error de Longitud en el parámetro User. La longitud del dato especificado es menor a 4 o mayor a 12 caracteres. 102 Error de Longitud en el parámetro Password. La longitud del dato especificado es menor a 4 o mayor a 12 caracteres. 201 Error de Longitud en MSISDN_Key. La longitud del dato especificado es mayor a 25 caracteres. 202 Error de Longitud en IMSI_Key. La longitud del dato especificado es mayor a 25 caracteres. 203 Error de Longitud en IMEI_Key. La longitud del dato especificado es mayor a 25 caracteres. 204 Error de Longitud en MSISDN. La longitud del dato especificado es mayor a 25 caracteres. 205 Error de Longitud en IMSI. La longitud del dato especificado es mayor a 25 caracteres. 206 Error de Longitud en IMEI. La longitud del dato especificado es mayor a 25 caracteres. 207 Error de Longitud en Product. La longitud del dato especificado es mayor a 50 caracteres. 208 Error de Longitud en Status. La longitud del dato especificado es mayor a 50 caracteres. 301 Error en Status. Se proporcionó un valor no reconocido. Los únicos valores válidos son Active y Suspended. 302 Error en Datos de Acceso. La combinación de User y Password proporcionada, no es válida. 303 Error de Nivel de Acceso El usuario con el que se ejecuta la operación no tiene permiso para esa acción.

15 MANUEL J. CHAVIRA INS-035R04 10-Nov de El MSISDN proporcionado no es administrado por Telcel. (No fue aprovisionado por Telcel, por lo tanto no puede ser modificado). 401 El MSISDN proporcionado ya existe en la base de datos de Líneas Aprovisionadas Pendientes de Asignarse a un Móvil, con el Status Active. 402 El MSISDN proporcionado ya existe en la base de datos de Líneas Aprovisionadas Pendientes de Asignarse a un Móvil, con el Status Suspended. 403 El MSISDN proporcionado ya existe en la base de datos de Móviles, con el Status Active. 404 El MSISDN proporcionado ya existe en la base de datos de Móviles, con el Status Suspended. 405 El MSISDN_Key proporcionado no existe en la Plataforma 406 El IMSI_Key proporcionado no existe en la Plataforma 407 El IMEI_Key proporcionado no existe en la Plataforma 408 El parámetro Product es inválido o no reconocido. 409 El parámetro Status es inválido o no reconocido. 410 No se cumplió con los requisitos de entrada (datos opcionales, datos de seguridad, etc.) 411 La combinación MSISDN_Key IMSI_Key IMEI_Key no existe en la Plataforma 412 El parámetro Product no existe en la Plataforma 500 Error en el procesamiento. 4.4 PARÁMETROS OPCIONALES Y OBLIGATORIOS La siguiente tabla indica cuales parámetros son obligatorios y cuales son opcionales, para cada tipo de movimiento realizado. PARÁMETRO ALTA CONSULTA EDICIÓN CANCELACIÓN Transaction_ID OBLIGATORIO OBLIGATORIO OBLIGATORIO OBLIGATORIO MSISDN_Key N/A OBLIGATORIO OBLIGATORIO OBLIGATORIO IMSI_Key N/A N/A OBLIGATORIO OBLIGATORIO IMEI_Key N/A N/A OBLIGATORIO OBLIGATORIO MSISDN OBLIGATORIO N/A OPCIONAL Se incluye si es afectado IMSI OBLIGATORIO N/A OPCIONAL Se incluye si es afectado IMEI OBLIGATORIO N/A OPCIONAL Se incluye si es afectado Product OBLIGATORIO N/A OPCIONAL Se incluye si es afectado Status N/A N/A OPCIONAL Se incluye si es afectado Nota 1: N/A = No Aplica Nota 2: En el método de EDICIÓN del servicio web (ws_tcl_03) debe incluirse por lo menos uno de los parámetros opcionales. N/A N/A N/A N/A N/A

16 MANUEL J. CHAVIRA INS-035R04 10-Nov de 23 5 DESCRIPCION DETALLADA DE LOS METODOS DISPONIBLES Las cuatro transacciones disponibles en la Plataforma, se ejecutan por medio de los métodos del servicio web correspondientes, con la descripción estandarizada que se indica en los apartados siguientes. 5.1 ALTA DE LINEA Método: ws_tcl_01() Parámetros de Entrada: Parámetros de Salida: Envío: <User> <Password> <Transaction_ID> <MSISDN> <IMSI> <IMEI> <Product> <Transaction_ID> <Codigo de Escape> POST /ws_tcl/ws_tcl.asmx HTTP/1.1 Host: Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: " <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <ws_tcl_01 xmlns=" <User>string</User> <Password>string</Password> <Transaction_ID>string</Transaction_ID> <MSISDN>string</MSISDN> <IMSI>string</IMSI> <IMEI>string</IMEI> <Product>string</Product> </ws_tcl_01> </soap:body> </soap:envelope> Respuesta: HTTP/ OK Content-Type: text/xml; charset=utf-8 Content-Length: length

17 MANUEL J. CHAVIRA INS-035R04 10-Nov de 23 <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <ws_tcl_01response xmlns=" <ws_tcl_01result> </ws_tcl_01result> </ws_tcl_01response> </soap:body> </soap:envelope> Referencia:

18 MANUEL J. CHAVIRA INS-035R04 10-Nov de CONSULTA DE LINEA Método: ws_tcl_02() Parámetros de Entrada: Parámetros de Salida: <User> <Password> <Transaction_ID> <MSISDN_Key> <Transaction_ID> <Codigo de Escape> <Fase> ("Aprovisionamiento", "Operación") <Client> <Vehicle> <MSISDN> <IMSI> <IMEI> <Product> <Status> ("Active", "Suspended") Observaciones: 1) Client está formado por el identificador de cliente y su nombre, asignados en la Fase de Operación. Está presentado en una cadena de texto compuesta por los siguientes campos: Client_Id + "-" + Client_Name Client_Id: String (6) Client_Name: String (20) En caso de no existir un Cliente asignado será devuelta la siguiente cadena: "Sin Cliente Asignado" 2) Vehicle está formado por los identificadores de la unidad asignados en la Fase de Operación. Está presentado en una cadena de texto compuesta por los siguientes campos: Movil_Id + "-" + Nick Movil_Id: String(10) Nick: String(12) En caso de no existir un valor para el campo Nick, solamente se devolverá el campo Movil_Id, omitiéndose el carácter intermedio ("-"). En caso de no existir un Movil_Id asignado será devuelta la siguiente cadena: "Sin Movil Asignado" Envío: POST /ws_tcl/ws_tcl.asmx HTTP/1.1 Host: Content-Type: text/xml; charset=utf-8

19 MANUEL J. CHAVIRA INS-035R04 10-Nov de 23 Content-Length: length SOAPAction: " <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <ws_tcl_02 xmlns=" <User>string</User> <Password>string</Password> <Transaction_ID>string</Transaction_ID> <MSISDN_Key>string</MSISDN_Key> </ws_tcl_02> </soap:body> </soap:envelope> Respuesta: Referencia: HTTP/ OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <ws_tcl_02response xmlns=" <ws_tcl_02result> </ws_tcl_02result> </ws_tcl_02response> </soap:body> </soap:envelope>

20 MANUEL J. CHAVIRA INS-035R04 10-Nov de EDICIÓN DE DATOS DE LINEA Método: ws_tcl_03() Parámetros de Entrada: Parámetros de Salida: <User> <Password> <Transaction_ID> <MSISDN_Key> <IMSI_Key> <IMEI_Key> Al menos unos de los siguientes parámetros es obligatorio: (Los parámetros de entrada que no se deseen modificar, deberán contener una cadena vacía.) <MSISDN> <IMSI> <IMEI> <Product> <Status> <Transaction_ID> <Codigo de Escape> Envío: POST /ws_tcl/ws_tcl.asmx HTTP/1.1 Host: Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: " <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <ws_tcl_03 xmlns=" <User>string</User> <Password>string</Password> <Transaction_ID>string</Transaction_ID> <MSISDN_Key>string</MSISDN_Key> <IMSI_Key>string</IMSI_Key> <IMEI_Key>string</IMEI_Key> <MSISDN>string</MSISDN> <IMSI>string</IMSI> <IMEI>string</IMEI> <Product>string</Product> <Status>string</Status> </ws_tcl_03> </soap:body> </soap:envelope>

21 MANUEL J. CHAVIRA INS-035R04 10-Nov de 23 Respuesta: Referencia: HTTP/ OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <ws_tcl_03response xmlns=" <ws_tcl_03result> </ws_tcl_03result> </ws_tcl_03response> </soap:body> </soap:envelope>

22 MANUEL J. CHAVIRA INS-035R04 10-Nov de CANCELACIÓN DE LINEA Método: ws_tcl_04() Parámetros de Entrada: Parámetros de Salida: <User> <Password> <Transaction_ID> <MSISDN_Key> <IMSI_Key> <IMEI_Key> <Transaction_ID> <Codigo de Escape> Envío: Respuesta: POST /ws_tcl/ws_tcl.asmx HTTP/1.1 Host: Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: " <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <ws_tcl_04 xmlns=" <User>string</User> <Password>string</Password> <Transaction_ID>string</Transaction_ID> <MSISDN_Key>string</MSISDN_Key> <IMSI_Key>string</IMSI_Key> <IMEI_Key>string</IMEI_Key> </ws_tcl_04> </soap:body> </soap:envelope> HTTP/ OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <ws_tcl_04response xmlns=" <ws_tcl_04result>

23 MANUEL J. CHAVIRA INS-035R04 10-Nov de 23 </ws_tcl_04result> </ws_tcl_04response> </soap:body> </soap:envelope> Referencia: