documento de servicios gestion de procesos version … · permite realizar el cambio de tipo de...

23
DOCUMENTO DE SERVICIOS GESTION DE PROCESOS VERSION 1.0 SISEC 2013

Upload: others

Post on 27-Oct-2019

2 views

Category:

Documents


0 download

TRANSCRIPT

DOCUMENTO DE SERVICIOS GESTION DE PROCESOS

VERSION 1.0

SISEC

2013

2

Contenido Servicios Web - Gestión de procesos .................................................................................................. 4

1. Tablas Paramétricas .................................................................................................................... 4

1.1 Especialidades ........................................................................................................................... 4

1.2 Categorías Gestión de procesos ................................................................................................ 4

1.3 Estado del Proceso .................................................................................................................... 5

1.4 Tipo de Servicio. ........................................................................................................................ 5

2. Servicios Transaccionales Gestión de Procesos. ......................................................................... 6

2.1 Descripción del Servicio ............................................................................................................ 6

2.1.1. Ambiente de Desarrollo .............................................................................................. 6

2.1.1.1. Credenciales ............................................................................................................ 6

2.2.1 Ambiente de Pruebas .................................................................................................. 6

2.2.1.1 Credenciales ................................................................................................................ 6

2.3.1 Ambiente de Producción ............................................................................................. 6

1.1.1. Notación de colores ajustes en los métodos del servicio ........................................... 6

1.2. Consulta Información Prueba .............................................................................................. 7

1.2.1. Datos de Entrada ......................................................................................................... 7

1.2.2. Datos de Salida ............................................................................................................ 7

2.3 Actualización Estado Prueba Medica ........................................................................................ 9

2.3.1 Datos de Entrada ......................................................................................................... 9

2.3.2 Datos de Salida ............................................................................................................ 9

2.4 Actualización Categoría y Tramite ........................................................................................... 11

2.4.1 Datos de Entrada ....................................................................................................... 11

2.4.2 Datos de Salida .......................................................................................................... 11

2.5 Tiempos Parametrizados por Prueba ................................................................................ 13

2.5.1 Datos de Entrada ....................................................................................................... 13

2.5.2 Datos de Salida .......................................................................................................... 13

2.6 Tiempos por Proceso ......................................................................................................... 15

2.6.1 Datos de Entrada ....................................................................................................... 15

2.6.2 Datos de Salida .......................................................................................................... 15

3

2.7 Cupos consumidos por CRC ............................................................................................... 17

2.7.1 Datos de Entrada ....................................................................................................... 17

2.7.2 Datos de Salida .......................................................................................................... 17

2.8 Cupos Disponibles OCP ..................................................................................................... 19

2.8.1 Datos de Entrada ....................................................................................................... 19

2.8.2 Datos de Salida .......................................................................................................... 19

2.9 Procesos por Estado .......................................................................................................... 21

2.9.1 Datos de Entrada ....................................................................................................... 21

2.9.2 Datos de Salida .......................................................................................................... 21

3 Tabla de Excepciones Mensajes – Servicios Gestión de Procesos ............................................ 23

4

Servicios Web - Gestión de procesos

1. Tablas Paramétricas A continuación se describen los códigos y valores de cada una de las tablas paramétricas que

deben ser homologadas en los sistemas externos a SISEC.

1.1 Especialidades Listado de Especialidades para el Servicio de gestión de Procesos aceptadas en el sistema.

Código Nombre

a90e3383-0f42-4338-9065-6ee8c7b87118

Oftalmología.

faa90c20-9801-401f-abc3-9432ca936333

Fonoaudiología

c11038d6-15c5-4280-87c8-b415e51b512b

Psicología

f5df72b4-b32b-410e-98db-f144eed072ae

Medicina General

1.2 Categorías Gestión de procesos Listado de Categorías para el Servicio de gestión de Procesos aceptadas en el sistema.

Código Nombre

A1 Motocicletas con cilindrada hasta 125.

A2 Motocicletas y moto triciclos con cilindrada mayor a 125.

B1 Automóviles, motocarros, cuatrimotos, camperos, camionetas y microbuses de servicio particular.

C1 Automóviles, camperos, camionetas y microbuses de servicio público.

B2 Camiones rígidos, busetas y buses de servicio particular.

C2 Camiones rígidos, busetas y buses de servicio público.

B3 Vehículos articulados servicio particular. C3 Vehículos articulados servicio público.

5

1.3 Estado del Proceso Listado de Estados del Proceso para el Servicio de gestión de Procesos aceptadas en el

sistema.

Código Nombre Observaciones

PRUMED Pruebas Médicas. En proceso de Pruebas Médicas de cualquiera de las 4 especialidades (Optometría, Psicología, Fonoaudiología y medicina General)

VERPRB Verificación Prueba. El medico certificador está en proceso de verificación del resultado de las pruebas médicas realizadas por los 4 especialistas.

CERPRU Certificación Prueba. El medico certificador ya registró la atestación para el usuario aspirante.

CARUNT Cargue Certificado. El medico autorizado por el CRC ya realizó el cargue del certificado en la página del RUNT.

FINALI Proceso Finalizado. El usuario aspirante ya termino su proceso de certificación en el CRC y su certificado se encuentra en el RUNT.

INCONS Proceso Inconsistente Dentro del proceso se produjo alguna anomalía la cual obligo a que el proceso se registrara en este estado.

1.4 Tipo de Servicio. Listado de Tipos de Servicio, aplicables para el servicio de Gestión de procesos.

Código Nombre

1 Examen Certificado Pase de Conducción

2 Examen Certificado Porte de Armas

6

2. Servicios Transaccionales Gestión de Procesos.

2.1 Descripción del Servicio

Nombre Servicio

GestionProcesos

La conexión del Ente Externo al sistema se realizará a través de la integración de servicios,

que estarán dispuestos en un servidor al cual tendrá acceso cada centro con cada una de sus

aplicaciones. Se dispondrá de un servicio para el ambiente de desarrollo y otro para el

ambiente de producción con cada centro. A continuación se relacionan las rutas de servicios

en cada ambiente:

2.1.1. Ambiente de Desarrollo

https://201.234.176.148/Dev/GestionProceso/GestionProcesos.asmx

2.1.1.1. Credenciales

Usuario Contraseña

PruebasDum Sd4125ww$##dsdf2234asd52112asd554522asd154ASD5a4sd545asd

2.2.1 Ambiente de Pruebas

https:// 200.14.47.242/GestionProcesos.asmx

2.2.1.1 Credenciales

Usuario Contraseña

CENTROPILOTO 7p$S!Ja6

2.3.1 Ambiente de Producción

https://servicios.sisec.co:8002/GestionProcesos.asmx?WSDL

1.1.1. Notación de colores ajustes en los métodos del servicio

Color Notación

Gris Modificación del campo o valor ya existente en el método, tabla paramétrica o pregunta. Ajuste o aclaración.

Azul Campo o valor nuevo en el método, tabla paramétrica o pregunta.

Eliminación Eliminación del campo o valor en el método, tabla paramétrica o pregunta.

7

1.2. Consulta Información Prueba

Nombre del Método

SeleccionarGPInformacionProcesoTherion

Este método retorna en una entidad con la siguiente información:

Estado del Examen.

Resultado del examen.

Fecha y Hora Inicial de la Prueba.

Fecha y Hora Final de la Prueba.

Esta información está sujeta al número de proceso y la especialidad en específico que se

requiera consultar.

1.2.1. Datos de Entrada

Parámetro Tipo de Dato Longitud Observación

UsuarioServicio Cadena de Texto 50 Usuario de autenticación matriculado para el CRC.

ContrasenaServicio Cadena de Texto 100 Contraseña de autenticación matriculada para el CRC.

IdProceso

Entero 64 Bits Número único identificador del proceso.

IdRolEspecialidad

Entero 32 Bits Código del Tipo de especialidad a consultar, listado 2.16.

1.2.2. Datos de Salida

EntidadGPInformacionProcesoTherion

Parámetro Tipo de Dato Longitud Observación

EstadoExamen

Cadena de Texto Estado en el que se encuentra el Examen.

ResultadoExamen Cadena de Texto Resultado de la prueba Médica.

FechaInicioPrueba Datetime Fecha y Hora en la que se le dio inicio a la prueba. Formato: YYYY-MM-DD HH: MI: SS.MMM.

FechaFinPrueba

Datetime Fecha y Hora en la que finalizo a la prueba.

8

Formato: YYYY-MM-DD HH: MI: SS.MMM.

Excepcion

EntidadExcepcionTherionGP

La entidad contiene los elementos código de error y mensaje de error los cuales le permitirán identificar si el proceso se llevó a cabo de forma correcta o no. Ver a continuación.

EntidadExcepcionTherionGP

Parámetro Tipo de Dato Longitud Observación

CodigoExcepcion Entero 32 Bits Registra el código de error que se pueda presentar al consumir el Servicio, 9 Tabla de Excepciones Mensajes – Servicios Gestión de Procesos.

MensajeExcepcion Cadena de Texto 512 Parámetro por Referencia, registra la descripción del error que se pueda presentar al consumir el Servicio, 9 Tabla de Excepciones Mensajes – Servicios Gestión de Procesos .

9

2.3 Actualización Estado Prueba Medica

Nombre del Método

ActualizarGPEstadoPruebaMedicaTherion

Actualiza la prueba en específico a su estado inicial (Pendiente) para que pueda ser procesada

nuevamente, retornando una confirmación de si el cambio se realizó o no, en caso de que el

resultado sea negativo, se puede verificar en los campos CodigoExcepcion y Mensaje

Excepción de la entidad EntidadExcepcionTherionGP las causas por las que el cambio no se

llevó a cabo.

2.3.1 Datos de Entrada

Parámetro Tipo de Dato Longitud Observación

UsuarioServicio Cadena de Texto 50 Usuario de autenticación matriculado para el CRC.

ContrasenaServicio Cadena de Texto 100 Contraseña de autenticación matriculada para el CRC.

IdProceso

Entero 64 Bits Número único identificador del proceso.

IdRolEspecialidad

Entero 32 Bits Código del Tipo de especialidad a consultar, listado 2.16.

2.3.2 Datos de Salida

Parámetro Tipo de Dato Longitud Observación

Procesado Booleano Si es verdadero indica que el Cambio se ejecutó de forma correcta, si es falso verifique el campo, Excepción.

Excepcion

EntidadExcepcionTherionGP

La entidad contiene los elementos código de error y mensaje de error los cuales le permitirán identificar si el proceso se llevó a cabo de forma correcta o no. Ver a continuación.

10

EntidadExcepcionTherionGP

Parámetro Tipo de Dato Longitud Observación CodigoExcepcion Entero 32 Bits Registra el código de error

que se pueda presentar al consumir el Servicio, 9 Tabla de Excepciones Mensajes – Servicios Gestión de Procesos.

MensajeExcepcion Cadena de Texto 512 Parámetro por Referencia, registra la descripción del error que se pueda presentar al consumir el Servicio, 9 Tabla de Excepciones Mensajes – Servicios Gestión de Procesos .

11

2.4 Actualización Categoría y Tramite

Nombre del Método

ActualizarGPTramiteCategoriaTherion

Permite realizar el cambio de Tipo de trámite y Categoría, se solicita el número de proceso y la

categoría final, quiere decir la categoría a la que se quiere cambiar el proceso, una vez se

verifica que el proceso es apto para un cambio de trámite y categoría , se retorna una

confirmación de que el cambio se llevó a cabo con éxito, en caso de que el resultado sea

negativo, se puede verificar en los campos CodigoExcepcion y Mensaje Excepción de la

entidad EntidadExcepcionTherionGP las causas por las que el cambio no se llevó a cabo.

2.4.1 Datos de Entrada

Parámetro Tipo de Dato Longitud Observación

UsuarioServicio Cadena de Texto 50 Usuario de autenticación matriculado para el CRC.

ContrasenaServicio Cadena de Texto 100 Contraseña de autenticación matriculada para el CRC.

IdProceso

Entero 64 Bits Número único identificador del proceso.

IdCategoriaFinal

Entero 32 Bits Código del Tipo de Categoría al cual se quiere actualizar, listado 2.17.

2.4.2 Datos de Salida

Parámetro Tipo de Dato Longitud Observación

Procesado Booleano Si es verdadero indica que el Cambio se ejecutó de forma correcta, si es falso verifique el campo, Excepción.

Excepcion

EntidadExcepcionTherionGP

La entidad contiene los elementos código de error y mensaje de error los cuales le permitirán identificar si el proceso se llevó a cabo de forma correcta o no. Ver a continuación.

12

EntidadExcepcionTherionGP

Parámetro Tipo de Dato Longitud Observación CodigoExcepcion Entero 32 Bits Registra el código de error

que se pueda presentar al consumir el Servicio, 9 Tabla de Excepciones Mensajes – Servicios Gestión de Procesos.

MensajeExcepcion Cadena de Texto 512 Parámetro por Referencia, registra la descripción del error que se pueda presentar al consumir el Servicio, 9 Tabla de Excepciones Mensajes – Servicios Gestión de Procesos .

13

2.5 Tiempos Parametrizados por Prueba

Nombre del Método

SeleccionarGPTiemposParametrizadosXPruebaTherion

Este método retorna en una entidad la información con el tiempo que se tiene estimado de

duración de una prueba en minutos, para una especialidad en determinado centro. El centro

se determina según el usuario y el centro al que el pertenece.

2.5.1 Datos de Entrada

Parámetro Tipo de Dato Longitud Observación

UsuarioServicio Cadena de Texto 50 Usuario de autenticación matriculado para el CRC.

ContrasenaServicio Cadena de Texto 100 Contraseña de autenticación matriculada para el CRC.

IdProceso

Entero 64 Bits Número único identificador del proceso.

IdRolEspecialidad

Entero 32 Bits Código del Tipo de especialidad a consultar, listado 2.16.

2.5.2 Datos de Salida

EntidadGPTiemposParametrizadosXPruebaTherion

Parámetro Tipo de Dato Longitud Observación TiempoEstimado

Entero 32 Bits Tiempo predeterminado que se tiene para la prueba consultada en el centro asociado al usuario que consulta.

Excepcion

EntidadExcepcionTherionGP

La entidad contiene los elementos código de error y mensaje de error los cuales le permitirán identificar si el proceso se llevó a cabo de forma correcta o no. Ver a continuación.

14

EntidadExcepcionTherionGP

Parámetro Tipo de Dato Longitud Observación CodigoExcepcion Entero 32 Bits Registra el código de error

que se pueda presentar al consumir el Servicio, 9 Tabla de Excepciones Mensajes – Servicios Gestión de Procesos.

MensajeExcepcion Cadena de Texto 512 Parámetro por Referencia, registra la descripción del error que se pueda presentar al consumir el Servicio, 9 Tabla de Excepciones Mensajes – Servicios Gestión de Procesos .

15

2.6 Tiempos por Proceso

Nombre del Método

SeleccionarGPTiemposProcesoTherion

Este método retorna en una entidad la fecha inicial y final que tardo la prueba según el

número de proceso y especialidad consultada.

2.6.1 Datos de Entrada

Parámetro Tipo de Dato Longitud Observación

UsuarioServicio Cadena de Texto 50 Usuario de autenticación matriculado para el CRC.

ContrasenaServicio Cadena de Texto 100 Contraseña de autenticación matriculada para el CRC.

IdProceso

Entero 64 Bits Número único identificador del proceso.

IdRolEspecialidad

Entero 32 Bits Código del Tipo de especialidad a consultar, listado 2.16.

2.6.2 Datos de Salida

3 EntidadGPTiemposProcesoTherion

Parámetro Tipo de Dato Longitud Observación

FechaInicioPrueba

Datetime Fecha y hora inicial de ejecución de la prueba. Formato: YYYY-MM-DD HH: MI: SS.MMM.

FechaFinalPrueba

Datetime Fecha y hora final de ejecución de la prueba. Formato: YYYY-MM-DD HH: MI: SS.MMM.

Excepcion

EntidadExcepcionTherionGP

La entidad contiene los elementos código de error y mensaje de error los cuales le permitirán identificar si el proceso se llevó a cabo de forma correcta o no. Ver a continuación.

16

EntidadExcepcionTherionGP

Parámetro Tipo de Dato Longitud Observación CodigoExcepcion Entero 32 Bits Registra el código de error

que se pueda presentar al consumir el Servicio, 9 Tabla de Excepciones Mensajes – Servicios Gestión de Procesos.

MensajeExcepcion Cadena de Texto 512 Parámetro por Referencia, registra la descripción del error que se pueda presentar al consumir el Servicio, 9 Tabla de Excepciones Mensajes – Servicios Gestión de Procesos .

17

2.7 Cupos consumidos por CRC

Nombre del Método

SeleccionarCuposConsumidosCRCTherion

Este método retorna en una entidad, según el usuario que consulta y el centro al cual se

encuentra asociado cuantos cupos han sido consumidos por el CRC.

2.7.1 Datos de Entrada

Parámetro Tipo de Dato Longitud Observación

UsuarioServicio Cadena de Texto 50 Usuario de autenticación matriculado para el CRC.

ContrasenaServicio Cadena de Texto 100 Contraseña de autenticación matriculada para el CRC.

2.7.2 Datos de Salida

EntidadGPTiemposParametrizadosXPruebaTherion

Parámetro Tipo de Dato Longitud Observación

Cupos_Consumidos

Entero 32 Bits Cantidad de cupos consumidos por el CRC al que se encuentra vinculado el usuario que consulta.

Excepcion

EntidadExcepcionTherionGP

La entidad contiene los elementos código de error y mensaje de error los cuales le permitirán identificar si el proceso se llevó a cabo de forma correcta o no. Ver a continuación.

18

EntidadExcepcionTherionGP

Parámetro Tipo de Dato Longitud Observación CodigoExcepcion Entero 32 Bits Registra el código de error

que se pueda presentar al consumir el Servicio, 9 Tabla de Excepciones Mensajes – Servicios Gestión de Procesos.

MensajeExcepcion Cadena de Texto 512 Parámetro por Referencia, registra la descripción del error que se pueda presentar al consumir el Servicio, 9 Tabla de Excepciones Mensajes – Servicios Gestión de Procesos .

19

2.8 Cupos Disponibles OCP

Nombre del Método

SeleccionarCuposDisponiblesOCPTherion

Este método retorna en una entidad, según el usuario que consulta y el centro al cual se

encuentra asociado determina cuantos cupos hay Disponibles para el OCP al que se encuentra

vinculado el Centro como también la cantidad de disponibles adicionales.

2.8.1 Datos de Entrada

Parámetro Tipo de Dato Longitud Observación

UsuarioServicio Cadena de Texto 50 Usuario de autenticación matriculado para el CRC.

ContrasenaServicio Cadena de Texto 100 Contraseña de autenticación matriculada para el CRC.

2.8.2 Datos de Salida

EntidadCuposDisponiblesOCPTherion

Parámetro Tipo de Dato Longitud Observación

Disponibles

Entero 32 Bits Cantidad de cupos Disponibles que tiene el OCP para consumir.

Disponibles_Adicionales

Entero 32 Bits Cantidad de cupos Disponibles Adicionales que tiene el OCP para consumir

Excepcion

EntidadExcepcionTherionGP

La entidad contiene los elementos código de error y mensaje de error los cuales le permitirán identificar si el proceso se llevó a cabo de forma correcta o no. Ver a continuación.

20

EntidadExcepcionTherionGP

Parámetro Tipo de Dato Longitud Observación CodigoExcepcion Entero 32 Bits Registra el código de error

que se pueda presentar al consumir el Servicio, 9 Tabla de Excepciones Mensajes – Servicios Gestión de Procesos.

MensajeExcepcion Cadena de Texto 512 Parámetro por Referencia, registra la descripción del error que se pueda presentar al consumir el Servicio, 9 Tabla de Excepciones Mensajes – Servicios Gestión de Procesos .

21

2.9 Procesos por Estado

Nombre del Método

SeleccionarProcesosXEstadoTherion

Este método retorna en una entidad, según el estado (Estado del proceso) y Tipo de Servicio

(Conductores - Armas) los procesos que cumplan la condición, se entregaran los resultados

desde la fecha consultada hasta la actualidad siempre y cuando el intervalo de días no supere

los 60.

2.9.1 Datos de Entrada

Parámetro Tipo de Dato Longitud Observación

UsuarioServicio Cadena de Texto 50 Usuario de autenticación matriculado para el CRC.

ContrasenaServicio Cadena de Texto 100 Contraseña de autenticación matriculada para el CRC.

fecha

Cadena de Texto 8 Formato AAAAMMDD.

IdEstado Entero 32 Bits Código del Estado en el que se puede encontrar un proceso, listado 2.18.

idTipo Entero 32 Bits Código del Tipo de Servicio que se desea consultar, listado 2.19.

2.9.2 Datos de Salida

EntidadProcesosXEstadoTherion

Parámetro Tipo de Dato Longitud Observación NumeroDocumento

Cadena de Texto 15 Numero de Documento del Cliente.

TipoDocumento

Cadena de Texto 30 Tipo de Documento del Cliente.

IdProceso

Entero 64 Bits Número único identificador del proceso.

Excepcion

EntidadExcepcionTherionGP

La entidad contiene los elementos código de error y mensaje de error los cuales le permitirán identificar si el proceso se llevó a

22

cabo de forma correcta o no. Ver a continuación.

EntidadExcepcionTherionGP

Parámetro Tipo de Dato Longitud Observación

CodigoExcepcion Entero 32 Bits Registra el código de error que se pueda presentar al consumir el Servicio, 9 Tabla de Excepciones Mensajes – Servicios Gestión de Procesos.

MensajeExcepcion Cadena de Texto 512 Parámetro por Referencia, registra la descripción del error que se pueda presentar al consumir el Servicio, 9 Tabla de Excepciones Mensajes – Servicios Gestión de Procesos .

23

3 Tabla de Excepciones Mensajes – Servicios Gestión de Procesos

Código Mensaje

0 La consulta no arrojo ningún resultado.

1 ¡Consulta Realizada Exitosamente!

1000 El número de Proceso no se encuentra relacionado al Usuario o Centro.

1001 El Id del proceso no corresponde a un número valido.

1002 El rol de la Especialidad a consultar no existe.

1003 El proceso que está consultando tiene un estado diferente a Creado o Validación Manual, la consulta por este medio está definida para Procesos que se encuentren dentro de estos dos estados.

1004 El proceso que está consultando tiene un estado diferente a Pruebas Médicas o Pendiente Certificar, la consulta por este medio está definida para Procesos que se encuentren dentro de estos dos estados.

1005 El proceso que está consultando se encuentra en estado Finalizado o Certificado, por lo tanto no se puede Cancelar la prueba Médica.

1006 No es posible Cancelar la prueba médica, puesto que la prueba médica ya fue cancelada.

1007 No está definido un tiempo estimado para las Pruebas médicas según el centro al que está asociado este proceso.

1008 El proceso que está consultando tiene un estado diferente a Pruebas Médicas, la consulta por este medio está definida para Procesos que se encuentren vinculados a este estado.

1009 El Usuario no es válido o no se encuentra vinculado a un Centro.

1010 No se halló una relación entre el CRC al que pertenece el usuario y un OCP.

1011 No se hallaron cupos disponibles para el OCP.

1012 El proceso que está consultando tiene se encuentra en estado Certificado o Finalizado, no puede realizar el procedimiento de cambio de tipo de trámite y categoría.

1013 La categoría enviada no corresponde a una categoría valida, valide por favor y inténtelo nuevamente.

1014 Solo se pueden realizar cambios de Grupo 1 a Grupo 2 o viceversa, no entre ellos.

1015 No fue posible determinar la última fecha de dispersión de cupos.

1016 La fecha enviada supera el límite establecido para búsquedas (60 Días).

1017 El estado a consultar enviado no existe.

1018 Para este proceso alguna de las pruebas se encuentra en estado diferente a Pendiente o Terminado.