ESPECIFICACIONES PARA WEBSERVICE DE ALCALDÍAS PARA SERVICIOS CAMERALES

Transcripción

1 EPECIFICACIONE PARA WEBERVICE DE ALCALDÍA PARA ERVICIO CAMERALE Cra. 3 No. 26A 47 Of PBX: (57) FAX: (57) Bogotá D.C. Colombia

2 Control de Versiones del Documento VERIÓN FECHA DECRIPCIÓN CREACIÓN/MODIFICACIÓN.0 eptiembre 03 de 203 Documento Inicial. eptiembre 5 de 203 Adición de diagrama de transacción. Elaborado por: Óscar O. Rodríguez C. - Ingeniero Programa CAE Documentos Anexos Ninguno Cra. 3 No. 26A 47 Of PBX: (57) FAX: (57) Bogotá D.C. Colombia

3 Contenido Control de Versiones del Documento... 2 Objetivo... 4 Justificación... 4 Usuarios del istema... 4 Diagrama de transacción... 4 Casos de Uso... 5 Reglas del negocio... 8 Requerimientos no funcionales... 9 Anexos... 9 Anexo Tipos de Identificación... 9 Anexo 2 - Tipos de Organización Jurídica... 9 Anexo 3 - XMLs Ejemplo... 0 Request... 0 Response... 3 Cra. 3 No. 26A 47 Of PBX: (57) FAX: (57) Bogotá D.C. Colombia

4 Objetivo Conocer las especificaciones necesarias para el desarrollo de un web service necesario para la comunicación de la información requerida por las alcaldías de los municipios y ciudades dentro de los convenios CAE suscritos por las cámaras de comercio. Justificación Debido a la necesidad de realizar la replica de la información generada en los procesos de gestión y formalización por medio de la plataforma del CAE y Confecámaras a las respectivas alcaldias de ciudades y/o municipios de manera rápida y autónoma. Por ello se ve la necesidad de generar una solución autónoma y eficaz que supla las necesidades de transporte de datos de manera fiable, por ello se crean los webservices (W). Estos W, tienen caracteristicas especificas las cuales se describirán el el presente documento. Usuarios del istema Aplicativos II: istema de registro de la cámara de comercio. Alcaldía municipal: istema de la alcaldía del municipio y/o ciudad con la que se realiza el intercambio de información. Diagrama de transacción Cra. 3 No. 26A 47 Of PBX: (57) FAX: (57) Bogotá D.C. Colombia

5 Casos de Uso Recibir Información Cámara de Comercio Descripción La alcaldía provee un servicio web que contiene un método responsable de recibir la información enviada por la cámara de comercio. Disparador de Eventos En la cámara de comercio se realiza un proceso de inscripción de una matrícula mercantil nueva. Actores II Alcaldía Pre- Condiciones - El sistema II tiene conexión con el servicio web de la alcaldía y cumple con las especificaciones de seguridad de acceso establecidas por la alcaldía. Post- condiciones Ninguna. Flujo de Eventos. El aplicativo local de la cámara de comercio prepara un xml con la información a enviar a la alcaldía, dicho XML cuenta con los siguientes campos: Campo Tipo Lon Descripción Obligat orio i/no Ocurrencia Establecimientos Establecimiento Matricula string 0 Numero de Matricula Camara de Comercio del Establecimiento, ucursal o NombreEstablecimiento string 253 Nombre del Establecimiento, ucursal o DireccionNotificacionJudicial string 253 Dirección de Notificación Judicial del Establecimiento, ucursal o DireccionComercial string 00 Dirección Comercial del Establecimiento, ucursal o Telefono string 20 Teléfono Comercial del Establecimiento, ucursal o :n Cra. 3 No. 26A 47 Of PBX: (57) FAX: (57) Bogotá D.C. Colombia

6 Municipio string 5 Código DANE del Municipio Comercial del Establecimiento, ucursal o NombreMunicipio string 00 Nombre Municipio Comercial del Establecimiento, ucursal o NumeroEmpleados Numeric 6 Número de Empleados del Establecimiento, ucursal o FechaInicioActividades string 8 Fecha Inicio Actividad en formato aaaa- mm- dd del Establecimiento, ucursal o PromedioMensualIngresos Numeric 7 Promedio Mensual de Ingresos del Establecimiento, ucursal o FechaMatricula string 8 Fecha de matrícula en formato aaaa- mm- dd del Establecimiento, ucursal o FechaRenovacion string 8 Fecha de renovación en formato aaaa- mm- dd del Establecimiento, ucursal o FechaCancelacion string 8 Fecha de cancelación en formato aaaa- mm- dd del Establecimiento, ucursal o AnoRenovacion string 4 Ultimo Año Renovado del Establecimiento, ucursal o ActividadEconomica CodigoCIIU string 5 Código CIIU Rev. 4.A.C del Establecimiento, ucursal o Propietarios :n :n Cra. 3 No. 26A 47 Of PBX: (57) FAX: (57) Bogotá D.C. Colombia

7 Propietario Matricula string 0 Numero de Matricula Propietario TipoIdentificacion string Tipo de Identificación del proveedor - Ver Anexo NumeroIdentificacion string 5 Numero de Identificación Propietario DigitoVerificacion string Digito Verificación Propietario PrimerNombre string 00 Primer Nombre Propietario OtrosNombres string 00 Otros Nombres Propietario N PrimerApellido string 00 Primer Apellido egundoapellido string 00 egundo Apellido N OrganizacionJuridica string 2 Tipo de Organización Jurídica - Ver Anexo2 Direccion string 00 Dirección Propietario CodigoDANE string 5 Código DANE del Municipio Comercial Propietario Telefono string 20 Teléfono Comercial Propietario string 00 Correo Electrónico Propietario PaginaWeb string 250 Página Web Propietario N ApartadoAereo string 0 Apartado Aéreo N Exportador string 0 No es importador ni exportador Importador 2 Exportador 3 Importador y Exportador N N XML ejemplo: Ver Anexo 3 2. El II realiza el consumo del método RecibirInfoCC del servicio web expuesto por la alcaldía, este método solo recibe un único parámetro de tipo string, en este campo será enviado como cadena de texto el XML previamente generado en el paso. 3. La alcaldía procesa el XML enviado y prepara el xml de respuesta con los siguientes datos: Campo Tipo Lon Descripción Obligatorio i/no Ocurrencia EstablecimientosResult Cra. 3 No. 26A 47 Of PBX: (57) FAX: (57) Bogotá D.C. Colombia

8 Procesados ResultEstablecimiento Matricula string 0 Numero de Matricula Camara de Comercio del Establecimiento, ucursal o Consecutivo string 0 Consecutivo asignado por la alcaldía :n FechaAlcaldia string 0 Fecha de asignación consecutivo alcaldía formato aaaa- mm- dd HoraAlcaldia string 8 Hora de asignación consecutivo alcaldía formato hh:mm:ss Errores ErrorEstablecimiento :n Matricula string 0 Numero de Matricula Camara de Comercio del Establecimiento, ucursal o Detalles string 255 Descripción del error por el cual no pudo ser actualizada la matrícula. 4. El aplicativo de la alcaldía responde a la petición de actualización con una cadena string que contiene el xml preparado en el paso 3. Flujos de Excepción Falla en el punto 2 i hay error de envío la matricula se marca como no enviada para que posteriormente sea procesada. Reglas del negocio No. Definición Delimitación de información a reportar a la alcaldía, ej. olo establecimientos, sociedad con sucursales y /o agencias, etc. Estática/ Dinámica Estática Alcaldía Fuente Cra. 3 No. 26A 47 Of PBX: (57) FAX: (57) Bogotá D.C. Colombia

9 Requerimientos no funcionales El desarrollo realizado en el aplicativo II se realizará en PHP Anexos Anexo Tipos de Identificación =Cedula de Ciudadanía 2=Nit 3=Cedula de Extranjería 4=Tarjeta de Identidad 5=Pasaporte 6=Personería Jurídica 7=Otro Anexo 2 - Tipos de Organización Jurídica 0=Persona Natural 02=Establecimiento de Comercio 03=ociedad Limitada 04=ociedad Anónima 05=ociedad Colectiva 06=ociedad en Comandita imple 07=ociedad en Comandita por Acciones Cra. 3 No. 26A 47 Of PBX: (57) FAX: (57) Bogotá D.C. Colombia

10 08=ociedad Extranjera 09=Empresas Asociativas de Trabajo 0=ociedad Civil =Empresa Unipersonal 2=Entidad in Ánimo de Lucro 4=Economía olidaria 5=Empresas Comerciales e Industriales del Estado 6=ociedades por Acciones implificadas.a.. Anexo 3 - XMLs Ejemplo Request <?xml version=".0" encoding="utf- 8"?> <soap:envelope xmlns:xsi=" instance" xmlns:xsd=" xmlns:soap=" <soap:body> <Establecimientos xmlns=" <Establecimiento> <Matricula>string</Matricula> <NombreEstablecimiento>string</NombreEstablecimiento> <DireccionNotificacionJudicial>string</DireccionNotificacionJudicial> <DireccionComercial>string</DireccionComercial> <Telefono>string</Telefono> <Municipio>string</Municipio> <NombreMunicipio>string</NombreMunicipio> Cra. 3 No. 26A 47 Of PBX: (57) FAX: (57) Bogotá D.C. Colombia

11 <NumeroEmpleados>string</NumeroEmpleados> <FechaInicioActividades>string</FechaInicioActividades> <PromedioMensualIngresos>string</PromedioMensualIngresos> <FechaMatricula>string</FechaMatricula> <FechaRenovacion>string</FechaRenovacion> <FechaCancelacion>string</FechaCancelacion> <AnoRenovacion>string</AnoRenovacion> <ActividadEconomica> <CodigoCIIU>string</CodigoCIIU> </ActividadEconomica> <Propietarios> <Propietario> <Matricula>string</Matricula> <TipoIdentificacion>string</TipoIdentificacion> <NumeroIdentificacion>string</NumeroIdentificacion> <DigitoVerificacion>string</DigitoVerificacion> <PrimerNombre>string</PrimerNombre> <OtrosNombres>string</OtrosNombres> <PrimerApellido>string</PrimerApellido> <egundoapellido>string</egundoapellido> <OrganizacionJuridica>string</OrganizacionJuridica> <Direccion>string</Direccion> <CodigoDANE>string</CodigoDANE> <Telefono>string</Telefono> < >string</ > <PaginaWeb>string</PaginaWeb> <ApartadoAereo>string</ApartadoAereo> Cra. 3 No. 26A 47 Of PBX: (57) FAX: (57) Bogotá D.C. Colombia

12 <Exportador>string</Exportador> </Propietario> <Propietario> <Matricula>string</Matricula> <TipoIdentificacion>string</TipoIdentificacion> <NumeroIdentificacion>string</NumeroIdentificacion> <DigitoVerificacion>string</DigitoVerificacion> <PrimerNombre>string</PrimerNombre> <OtrosNombres>string</OtrosNombres> <PrimerApellido>string</PrimerApellido> <egundoapellido>string</egundoapellido> <OrganizacionJuridica>string</OrganizacionJuridica> <Direccion>string</Direccion> <CodigoDANE>string</CodigoDANE> <Telefono>string</Telefono> < >string</ > <PaginaWeb>string</PaginaWeb> <ApartadoAereo>string</ApartadoAereo> <Exportador>string</Exportador> </Propietario> </Propietarios> </Establecimiento> </Establecimientos> </soap:body> </soap:envelope> Cra. 3 No. 26A 47 Of PBX: (57) FAX: (57) Bogotá D.C. Colombia

13 Response <?xml version=".0" encoding="utf- 8"?> <soap:envelope xmlns:xsi=" instance" xmlns:xsd=" xmlns:soap=" <soap:body> <EstablecimientosResponse xmlns=" <EstablecimientosResult> <Procesados> <ResultEstablecimiento> <Matricula>string</Matricula> <Consecutivo>string</Consecutivo> <Fecha>string</Fecha> <Hora>string</Hora> </ResultEstablecimiento> </Procesados> <Errores> <ErrorEstablecimiento> <Matricula>string</Matricula> <Detalles xsi:nil="true" /> </ErrorEstablecimiento> </Errores> </EstablecimientosResult> </EstablecimientosResponse> </soap:body> </soap:envelope> Cra. 3 No. 26A 47 Of PBX: (57) FAX: (57) Bogotá D.C. Colombia