SERVICIOS WEB RESTFUL PROYECTO CNT
Empresa: SoltecData Sistema: Ws Servicios Web Lugar: Riobamba
Tabla de contenido 1.
DESCRIPCIÓN DEL SERVIDOR...............................................................................4
2.
DESCRIPCIÓN DE LOS SERVICIOS..........................................................................4 DESCRIPCIÓN: Servicio Web Login (wsUsuario)................................................4 DESCRIPCIÓN: Servicio Web AutenticarWeb (wsUsuario)................................5 DESCRIPCIÓN: Servicio Web crearPersona.........................................................6 DESCRIPCIÓN: Servicio Web listaTipoIdentificacion...........................................7 DESCRIPCIÓN: Servicio Web listaRolesById.......................................................8 DESCRIPCIÓN: Servicio Web crearGrupoEmpresarial.......................................9 DESCRIPCIÓN: Servicio Web crearEmpresa......................................................10 DESCRIPCIÓN: Servicio Web listarEmpresaAll..................................................11 DESCRIPCIÓN: Servicio Web listarGruposAll.....................................................12 DESCRIPCIÓN: Servicio Web listarEmpresaPorGrupo.....................................13 DESCRIPCIÓN: Servicio Web listarEmpresasSinGruposAll.............................14 DESCRIPCIÓN: Servicio Web listarFasesProcesosAll......................................15 DESCRIPCIÓN: Servicio Web listaProcesosAll..................................................16 DESCRIPCIÓN: Servicio Web listarProcesosPadreAll......................................17 DESCRIPCIÓN: Servicio Web listaTipoPlanes....................................................18 DESCRIPCIÓN: Servicio Web listaEstadoPlanes...............................................19 DESCRIPCIÓN: Servicio Web editarPersona......................................................20 DESCRIPCIÓN: Servicio Web registrarPlan........................................................21
1. DESCRIPCIÓN DEL SERVIDOR
2. DESCRIPCIÓN DE LOS SERVICIOS TABLA DE COLORES SERVICIOS Test: Test: Test:
Servicio para móvil Servicio para web Servicio para móvil y web
DESCRIPCIÓN: Servicio Web Login (wsUsuario) Método POST RESTful 4: LoginMovil Dirección: http://192.168.1.45:8080/WsCnt/webresources/wsUsuario/LoginMovil Test: http://192.168.1.45:8080/WsCnt/webresources/wsUsuario/LoginMovil Parámetros: strCorreoAlias= Parámetro de entrada correo o alias (tipo String) strPassword= Parámetro de entrada Clave Persona (tipo String) intRolUsuario= Parámetro de entrada rol (tipo Integer) Cuerpo POST:
{ "strCorreoAlias":"jonva", "strPassword":"12345", "intRolUsuario":1 } Respuesta:
{ "chvAlias": "jonva", "chvApellido": "Vasco", "chvCelular": "0983770700", "chvClave": "12345", "chvIdentificacion": "0603455270", "chvMail": "vasco3s2009@gmail.com", "chvNombre": "Jonny", "intIdPerfil": 0, "intIdPersona": 0, "intIdTipoIdentificacion": 1, "intMensaje": 1, "strMensaje": "Logueado" }
DESCRIPCIÓN: Servicio Web AutenticarWeb (wsUsuario) Método POST RESTful 4: AutenticarWeb Dirección: http://192.168.1.45:8080/WsCnt/webresources/wsUsuario/AutenticarWeb Test: http://192.168.1.45:8080/WsCnt/webresources/wsUsuario/AutenticarWeb Parámetros: strCorreoAlias= Parámetro de entrada correo o alias (tipo String) strPassword= Parámetro de entrada Clave Persona (tipo String) Cuerpo POST:
{ "strCorreoAlias":"jonva", "strPassword":"12345", } Respuesta:
{ "chvAlias": "jonva", "chvApellido": "Vasco", "chvCelular": "0983770700", "chvClave": "12345", "chvIdentificacion": "0603455270", "chvMail": "vasco3s2009@gmail.com", "chvNombre": "Jonny", "intIdPerfil": 0, "intIdPersona": 0, "intIdTipoIdentificacion": 1, "intMensaje": 1, "strMensaje": "Logueado" }
DESCRIPCIÓN: Servicio Web crearPersona Método POST RESTful 4: crearPersona Dirección: http://192.168.1.45:8080/WsCnt/webresources/wsPersona/crearPersona Test: http://192.168.1.45:8080/WsCnt/webresources/wsPersona/crearPersona Parámetros: chvNombre Parámetro de entrada nombre (tipo String)
chvApellido Parámetro de entrada apellido (tipo String) chvCelular Parámetro de entrada celular (tipo String) chvAlias Parámetro de entrada alias (tipo String) chvIdentificacion Parámetro de entrada cedula (tipo String) intIdTipoIdentificacion " Parámetro de entrada tipo de identificacion(tipo intIdPerfil Parámetro de entrada perfil (tipo Integer ) chvMail Parámetro de entrada tipo cirreo (tipo String ) chvClave Parámetro de entrada clave (tipo String )
Integer )
Cuerpo POST:
{ "chvNombre":"Cristina3", "chvApellido":"Arcos3", "chvCelular":"0987541015", "chvAlias":"Cris3", "chvIdentificacion":"0604107676", "intIdTipoIdentificacion":1, "intIdPerfil":1, "chvMail":"cristina3.arcos@std.ec", "chvClave":"1234567891" } Mensaje: Usuario creado exitosamente.
Respuesta:
DESCRIPCIÓN: Servicio Web listaTipoIdentificacion Método GET RESTful 4: listaTipoIdentificacion Dirección: http://192.168.1.45:8080/WsCnt/webresources/wsPersona/listaTipoIdentificacion Test: http://192.168.1.45:8080/WsCnt/webresources/wsPersona/listaTipoIdentificacion Parámetros de la respuesta: intIdMensaje Parámetro de salida (tipo Integer) 1 si la lista esta con datos, 0 si la lista esta vacía
strMensaje Parámetro de salida chEstadoLogico Parámetro de
informa el motivo del intIdMensaje (tipo String) salida
(tipo String) indica si el estado del tipo de identificación esta
activado.
chvDescripcion Parámetro de salida (tipo String) indica el nombre del tipo de identificación. intIdTipoIdentificacion Parámetro de salida (tipo Integer) Indica el ID del tipo de identificación. Respuesta: { "intIdMensaje": 1, "objLista": [ { "chEstadoLogico": "A", "chvDescripcion": "Cedula", "intIdTipoIdentificacion": 1 }, { "chEstadoLogico": "A", "chvDescripcion": "RUC", "intIdTipoIdentificacion": 2 } ], "strMensaje": "Lista con datos" }
DESCRIPCIÓN: Servicio Web listaRolesById Método GET RESTful 4: listaRolesById Dirección: http://192.168.1.45:8080/WsCnt/webresources/wsPersona/listaRolesById/idPersona Test: http://192.168.1.45:8080/WsCnt/webresources/wsPersona/listaRolesById/1 Parámetros de entrada: idPersona Parámetro de entrada (tipo Integer). Parámetros de la respuesta: intIdMensaje Parámetro de salida (tipo Integer) 1 si la lista esta con datos, 0 si la lista está vacía
strMensaje Parámetro de salida informa el motivo del intIdMensaje (tipo String) objLista chEstadoLogico Parámetro de salida (tipo String) indica si el estado del perfil está activado. chvNombrePerfil Parámetro de salida (tipo String) indica el nombre del perfil. intIdPerfil Parámetro de salida (tipo Integer) Indica el ID del perfil. Parámetros de salida: { "intIdMensaje": 1, "objLista": [ { "chEstadoLogico": "A", "chvNombrePerfil": "Administrador", "intIdPerfil": 1 }, { "chEstadoLogico": "A", "chvNombrePerfil": "Vendedor", "intIdPerfil": 2 }, { "chEstadoLogico": "A", "chvNombrePerfil": "Operador", "intIdPerfil": 3 }, { "chEstadoLogico": "A", "chvNombrePerfil": "Técnico", "intIdPerfil": 4 }
], "strMensaje": "Lista con datos" }
DESCRIPCIÓN: Servicio Web crearGrupoEmpresarial Método POST RESTful 4: crearGrupoEmpresarial Dirección: http://192.168.1.45:8080/WsCnt/webresources/wsEmpresa/crearGrupoEmpresarial/inIdPersona/intIdUbicacion Test: http://192.168.1.45:8080/WsCnt/webresources/wsEmpresa/crearGrupoEmpresarial/1/1
Parámetros: inIdPersona Parámetro de entrada id persona (tipo Integer) intIdUbicacion Parámetro de entrada idUbicacion (tipo Integer ) chvNombreEmpresa Parámetro de entrada nombre de la empresa (tipo String) chv_ruc Parámetro de entrada ruc (tipo String) txt_razon_social Parámetro de entrada razón social (tipo String) txt_direccion " Parámetro de entrada dirección(tipo String ) Cuerpo POST:
{ "chvNombreEmpresa":"WS Coorp2.", "chvRuc":"0802878710001", "txTrazon_social":"RazonSocial", "txtDireccion":"Direccion 123" } { Respuesta: "intIdMensaje": 1, "strMensaje": "Grupo insertado" }
DESCRIPCIÓN: Servicio Web crearEmpresa Método POST RESTful 4: crearEmpresa Dirección: http://192.168.1.45:8080/WsCnt/webresources/wsEmpresa/crearEmpresa/inIdPersona/intIdUbicacion/intIdEmpr esaPadre Test: http://192.168.1.45:8080/WsCnt/webresources/wsEmpresa/crearEmpresa/1/1/3
Parámetros: inIdPersona Parámetro de entrada id persona (tipo Integer) intIdUbicacion Parámetro de entrada idUbicacion (tipo Integer ) intIdEmpresaPadre Parámetro de entrada idEmpresa padre (tipo Integer ) chvNombreEmpresa Parámetro de entrada nombre de la empresa (tipo String) chv_ruc Parámetro de entrada ruc (tipo String) txt_razon_social Parámetro de entrada razón social (tipo String) txt_direccion " Parámetro de entrada dirección(tipo String ) Cuerpo POST:
{ "chvNombreEmpresa":"WS Coorp4.", "chv_ruc":"0802878711001", "txt_razon_social":"RazonSocial2", "txt_direccion":"Direccion 1234" } {
Respuesta:
"intIdMensaje": 1, "strMensaje": "Empresa creada exitosamente" }
DESCRIPCIÓN: Servicio Web listarEmpresaAll Método GET RESTful 4: listarEmpresaAll Dirección: http://192.168.1.45:8080/WsCnt/webresources/wsEmpresa/listarEmpresaAll/ Test: http://192.168.1.45:8080/WsCnt/webresources/wsEmpresa/listarEmpresaAll/ Parámetros de entrada: Respuesta:
{ "intIdMensaje": 1, "objLista": [ { "bl_tipo": true, "ch_estado_logico": "A", "chvNombreEmpresa": "acasdasd", "chvNombreEmpresaPadre": "", "chv_ruc": "004", "int_id_empresa": 1, "int_id_empresa_padre": 1, "int_id_representante": 1, "int_id_ubicacion": 1, "ts_fecha_registro": "2017/07/200 12:39:59", "txt_direccion": "asdasd", "txt_razon_social": "ppp" }, { "bl_tipo": false, "ch_estado_logico": "A", "chvNombreEmpresa": "grtht", "chvNombreEmpresaPadre": "", "chv_ruc": "rhhtyh", "int_id_empresa": 15,
"int_id_empresa_padre": 1, "int_id_representante": 2, "int_id_ubicacion": 11, "ts_fecha_registro": "2017/07/200 12:39:59", "txt_direccion": "dgrttr", "txt_razon_social": "gffhh" } ], "strMensaje": "Lista con datos" }
DESCRIPCIÓN: Servicio Web listarGruposAll Método GET RESTful 4: listarGruposAll Dirección: http://192.168.1.45:8080/WsCnt/webresources/wsEmpresa/listarGruposAll/ Test: http://192.168.1.45:8080/WsCnt/webresources/wsEmpresa/listarGruposAll/ Parámetros de entrada: Respuesta:
{ "intIdMensaje": 1, "objLista": [ { "bl_tipo": true, "ch_estado_logico": "A", "chvNombreEmpresa": "acasdasd", "chvNombreEmpresaPadre": "", "chv_ruc": "004", "int_id_empresa": 1, "int_id_empresa_padre": 1, "int_id_representante": 1, "int_id_ubicacion": 1, "ts_fecha_registro": "2017/07/200 12:38:08", "txt_direccion": "asdasd", "txt_razon_social": "ppp" }, { "bl_tipo": true, "ch_estado_logico": "A", "chvNombreEmpresa": "dfg ", "chvNombreEmpresaPadre": "",
"chv_ruc": "12635", "int_id_empresa": 11, "int_id_empresa_padre": 1, "int_id_representante": 1, "int_id_ubicacion": 1, "ts_fecha_registro": "2017/07/200 12:38:08", "txt_direccion": "rfgtrfyh", "txt_razon_social": "r th" } ], "strMensaje": "Lista con datos" }
DESCRIPCIÓN: Servicio Web listarEmpresaPorGrupo Método GET RESTful 4: listarEmpresaPorGrupo Dirección: http://192.168.1.45:8080/WsCnt/webresources/wsEmpresa/listarEmpresaPorGrupo/idEmpresaPadre Test: http://192.168.1.45:8080/WsCnt/webresources/wsEmpresa/listarEmpresaPorGrupo/4 Parámetros de entrada: idEmpresaPadre Parametro de entrada (tipo Integer) Respuesta:
{ "intIdMensaje": 1, "objLista": [ { "bl_tipo": true, "ch_estado_logico": "A", "chvNombreEmpresa": "acasdasd", "chvNombreEmpresaPadre": "", "chv_ruc": "004", "int_id_empresa": 1, "int_id_empresa_padre": 1, "int_id_representante": 1, "int_id_ubicacion": 1, "ts_fecha_registro": "2017/07/200 12:38:08", "txt_direccion": "asdasd", "txt_razon_social": "ppp" }, { "bl_tipo": true,
"ch_estado_logico": "A", "chvNombreEmpresa": "dfg ", "chvNombreEmpresaPadre": "", "chv_ruc": "12635", "int_id_empresa": 11, "int_id_empresa_padre": 1, "int_id_representante": 1, "int_id_ubicacion": 1, "ts_fecha_registro": "2017/07/200 12:38:08", "txt_direccion": "rfgtrfyh", "txt_razon_social": "r th" } ], "strMensaje": "Lista con datos" }
DESCRIPCIÓN: Servicio Web listarEmpresasSinGruposAll Método GET RESTful 4: listarEmpresasSinGruposAll Dirección: http://192.168.1.45:8080/WsCnt/webresources/wsEmpresa/listarEmpresasSinGruposAll/ Test: http://192.168.1.45:8080/WsCnt/webresources/wsEmpresa/listarEmpresasSinGruposAll/ Parámetros de entrada: Respuesta:
{ "intIdMensaje": 1, "objLista": [ { "bl_tipo": false, "ch_estado_logico": "A", "chvNombreEmpresa": "grtht", "chvNombreEmpresaPadre": "", "chv_ruc": "rhhtyh", "int_id_empresa": 15, "int_id_empresa_padre": 1, "int_id_representante": 2, "int_id_ubicacion": 11, "ts_fecha_registro": "2017/07/200 12:41:53", "txt_direccion": "dgrttr", "txt_razon_social": "gffhh" }
], "strMensaje": "Lista con datos" }
DESCRIPCIÓN: Servicio Web listarFasesProcesosAll Método GET RESTful 4: listarFasesProcesosAll Dirección: http://192.168.1.45:8080/WsCnt/webresources/wsProceso/listarFasesProcesosAll/idProcesoPadre Test: http://192.168.1.45:8080/WsCnt/webresources/wsProceso/listarFasesProcesosAll/5 Parámetros de entrada: idProcesoPadre parámetro de entrada id de proceso padre. Respuesta:
{ "intIdMensaje": 1, "objLista": [ { "chEstadoLogico": "A", "chvNombreProceso": "proceso 5.1.1", "intIdPerfil": 1, "intIdProceso": 6, "intIdProcesoPadre": 5, "strNombrePerfil": "", "strNombreProcedoPadre": "proceso 5", "tsFechaRegistro": "20170717T11:34:57.42305:00" } ], "strMensaje": "Lista con datos"
}
DESCRIPCIÓN: Servicio Web listaProcesosAll Método GET RESTful 4: listaProcesosAll Dirección: http://192.168.1.45:8080/WsCnt/webresources/wsProceso/listaProcesosAll/ Test: http://192.168.1.45:8080/WsCnt/webresources/wsProceso/listaProcesosAll/ Parámetros de entrada: Respuesta:
{ "intIdMensaje": 1, "objLista": [ { "chEstadoLogico": "A", "chvNombreProceso": "proceso 5", "intIdPerfil": 1, "intIdProceso": 5, "intIdProcesoPadre": 1, "strNombrePerfil": "", "strNombreProcedoPadre": "", "tsFechaRegistro": "20170717T10:35:22.92105:00" }, { "chEstadoLogico": "A",
"chvNombreProceso": "proceso 2", "intIdPerfil": 1, "intIdProceso": 2, "intIdProcesoPadre": 1, "strNombrePerfil": "", "strNombreProcedoPadre": "", "tsFechaRegistro": "20170717T09:45:42.08505:00" }, { "chEstadoLogico": "A", "chvNombreProceso": "proceso 5.1.1", "intIdPerfil": 1, "intIdProceso": 6, "intIdProcesoPadre": 5, "strNombrePerfil": "", "strNombreProcedoPadre": "proceso 5", "tsFechaRegistro": "20170717T11:34:57.42305:00" } ], "strMensaje": "Lista con datos" }
DESCRIPCIÓN: Servicio Web listarProcesosPadreAll Método GET RESTful 4: listarProcesosPadreAll Dirección: http://192.168.1.45:8080/WsCnt/webresources/wsProceso/listarProcesosPadreAll/ Test: http://192.168.1.45:8080/WsCnt/webresources/wsProceso/listarProcesosPadreAll/ Parámetros de entrada: Respuesta:
{ "intIdMensaje": 1, "objLista": [ { "chEstadoLogico": "A", "chvNombreProceso": "proceso 5", "intIdPerfil": 1, "intIdProceso": 5, "intIdProcesoPadre": 1, "strNombrePerfil": "", "strNombreProcedoPadre": "", "tsFechaRegistro": "20170717T10:35:22.92105:00"
}, { "chEstadoLogico": "A", "chvNombreProceso": "proceso 2", "intIdPerfil": 1, "intIdProceso": 2, "intIdProcesoPadre": 1, "strNombrePerfil": "", "strNombreProcedoPadre": "", "tsFechaRegistro": "20170717T09:45:42.08505:00" } ], "strMensaje": "Lista con datos" }
DESCRIPCIÓN: Servicio Web listaTipoPlanes Método GET RESTful 4: listaTipoPlanes Dirección: http://192.168.1.45:8080/WsCnt/webresources/wsPlan/listaTipoPlanes/ Test: http://192.168.1.45:8080/WsCnt/webresources/wsPlan/listaTipoPlanes/ Parámetros de entrada: Respuesta:
{ "intIdMensaje": 1, "objLista": [ { "chvEstadoLogico": "A", "chvNombrePlan": "Ilimitado 10000Mg", "intIdTipoPlan": 1, "tsFechaRegistro": "20170717T08:05:23.80605:00" }, { "chvEstadoLogico": "D",
"chvNombrePlan": "2Postpago", "intIdTipoPlan": 2, "tsFechaRegistro": "20170717T10:31:24.31905:00" }, { "chvEstadoLogico": "A", "chvNombrePlan": "plan1", "intIdTipoPlan": 3, "tsFechaRegistro": "20170717T12:35:00.12405:00" }, { "chvEstadoLogico": "A", "chvNombrePlan": "plan3", "intIdTipoPlan": 4, "tsFechaRegistro": "20170717T12:36:11.59905:00" } ], "strMensaje": "Lista con datos" }
DESCRIPCIÓN: Servicio Web listaEstadoPlanes Método GET RESTful 4: listaEstadoPlanes Dirección: http://192.168.1.45:8080/WsCnt/webresources/wsPlan/listaEstadoPlanes/ Test: http://192.168.1.45:8080/WsCnt/webresources/wsPlan/listaEstadoPlanes/ Parámetros de entrada: Respuesta:
{ "intIdMensaje": 1, "objLista": [ { "chEstadoLogico": "A", "chvDescripcion": "Incorrecto", "intIdEstdPlan": 2 }, {
"chEstadoLogico": "A", "chvDescripcion": "Eliminar", "intIdEstdPlan": 3 }, { "chEstadoLogico": "A", "chvDescripcion": "Correcto", "intIdEstdPlan": 4 }, { "chEstadoLogico": "A", "chvDescripcion": "Incompleto", "intIdEstdPlan": 1 }, { "chEstadoLogico": "A", "chvDescripcion": "Nulo", "intIdEstdPlan": 5 }, { "chEstadoLogico": "A", "chvDescripcion": "N/G", "intIdEstdPlan": 6 } ], "strMensaje": "Lista con datos" }
DESCRIPCIÓN: Servicio Web editarPersona Método PUT RESTful 4: editarPersona Dirección: http://192.168.1.45:8080/WsCnt/webresources/wsPersona/editarPersona/idPersona Test: http://192.168.1.45:8080/WsCnt/webresources/wsPersona/editarPersona/2
Parámetros: idPersona Parámetro de entrada id persona a modificar (tipo Integer) chvNombre Parámetro de entrada nombre (tipo String) chvApellido Parámetro de entrada apellido (tipo String) chvCelular Parámetro de entrada celular (tipo String) chvAlias Parámetro de entrada alias (tipo String) chvMail Parámetro de entrada mail (tipo String)
Cuerpo POST:
{ "chvNombre":"rICHAR", "chvApellido":"Buenaño", "chvCelular":"0968961423", "chvAlias":"ATISH", "chvMail":"rabuenano@gmail.com" } Respuesta:
{ "intIdMensaje": 1, "strMensaje": "Usuario actualizado exitosamente" }
DESCRIPCIÓN: Servicio Web registrarPlan Método POST RESTful 4: registrarPlan Dirección: http://192.168.1.45:8080/WsCnt/webresources/wsPlan/registrarPlan Test: http://192.168.1.45:8080/WsCnt/webresources/wsPlan/registrarPlan
Parámetros: intIdEstdPlan Parámetro de entrada id persona a modificar (tipo Integer) (DEL SERVICIO LISTAR SERVICIO PLANES) intIdPlan Parámetro de entrada nombre (tipo Integer)(SERVICIO LISTATIPOPLANES) intIdProceso Parámetro de entrada apellido (tipo Integer)(SERVICIO LISTADO PROCESOS) intIdUsuario Parámetro de entrada celular (tipo Integer)
Cuerpo POST:
{ "intIdEstdPlan":4, "intIdPlan":1, "intIdProceso":5, "intIdUsuario":2 } Respuesta:
{ "intIdMensaje": 1, "strMensaje": "Plan registrado exitosamente" }