Wiki

Herramientas de usuario

Herramientas del sitio

Traza: • seguridadsocial • tipocuenta • rentas.carterarecaudo.novedades • cuentas_contables_por_grupo • maestromodulos • rentas.industriacomercio • cargaempleado • calamidad • motivoretiro
ada:tips:sicoferp:general:pbtows:procesos:inventario:nominamaestros:motivoretiro

¡Esta es una revisión vieja del documento!

Tabla de Contenidos

Maestro Motivos de retiro

Definición

Definición del Componente
Nombre n_ws05_motivo_retiro
Descripción Gestiona el maestro de motivos de retiros de los empleados
Proyecto PBws05_motivo_retiro
Versión PB 12.5.1
URL SVNhttp://adacsc.co:1443/svn/repository/ADA/SICOF/SICOF%20PBtoWS/Branches/branches%2012.5.2.5.0/05_Nomina/motivo_retiro
Librerias PropiasTipo
ws05_motivo_retiro.pbl Libreria Lanzadora
sf05controller_motivo_retiro.pblLibreria Controladora
sf05model_motivo_retiro.pblLibreria Modelo DB
Librerias CoreTipo
sf00core_object.pbl Libreria Core de Objetos Base
sf00core_transaction.pblLibreria Core de control de Transacción DB
sf00core_proxy.pblLibreria de Soporte de Consumos WS - Internos
Requisitos Técnicos
Framework .Net 4.02 o Superior
Servidor Internet Information Server 7.5 o Superior
Sistema Operativo Windows Server 2012 R2
Memoria Ram 8GB
Exposición de Servicio
Tipo Servicio SOAP 1.1 y SOAP 1.2 (.Net Easy SOAP - Generado por Powerbuilder)
URL Recurso http://10.1.40.170:88/ws05_motivo_retiro/n_ws05_motivo_retiro.asmx?WSDL
Operaciones Objetivo
ws_listarlista los registros actuales de la tabla NOMINA.MOTIVO_RETIRO.
ws_insertaringresa un nuevo registro en la tabla NOMINA.MOTIVO_RETIRO.
ws_actualizaractualiza valores en un registro de la tabla NOMINA.MOTIVO_RETIRO.
ws_consultarconsulta un único registro dado de la tabla NOMINA.MOTIVO_RETIRO.

Contrato de Consumo: WS_LISTAR

Contrato de Consumo
OperaciónObjetivo
ws_listarlista los registros actuales de la tabla NOMINA.MOTIVO_RETIRO.
Parámetros de Entrada
NombreTipo de DatosDescripciónFormato Tipo
as_configStringCadena de Configuración del ConsumoJson
as_dataStringCadena que contiene los parámetros del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto1)
as_configtoken_sessionStringCadena que representa el hash de autenticación de acceso al consumoSiN/A
as_datafirstpagIntegerIdentificador de registro inicial de la paginación del consumoSi1
as_datalastpagIntegerIdentificador de registro final de la paginación del consumoSi1
as_dataorderbyStringCadena que contiene las columnas de ordenamiento del consumoNoUtilizado por la DB
as_datawhereStringCadena que contiene la sentencias de filtrado del consumoNoN/A
Parámetros de Retorno
NombreTipo de DatosDescripciónFormato Tipo
ws_listarResultStringCadena de retorno del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto2)
ws_listarResultreturn_codeStringCadena que representa el código de retorno del consumo 1: OK -1: ErrorSiN/A
ws_listarResultreturn_user_messageStringCadena que representa el mensaje de usuario de retorno del consumoSiN/A
ws_listarResultreturn_technical_messageStringCadena que representa el mensaje técnico de retorno del consumoSiN/A
ws_listarResultreturn_objectStringCadena que representa el objeto de retorno del consumoNoN/A
return_objectalertStringCadena que representa el array de mensajes de alerta de retorno del consumoNoN/A
alertmsgStringCadena que representan una posición del array de mensajes de alerta de retorno del consumoNoN/A
return_objectcolumncountLongValor que representa la cantidad de columnas de la data devuelve en el objeto de consumoNoN/A
return_objectrowcountLongValor que representa la cantidad de filas totales de la data que representa el objeto de consumoNoN/A
return_objectmotivo_retiroArray ObjectArray de Objetos que representan la data que devuelve el consumoNoN/A
motivo_retiroka_nl_motivo_retiroLongIdentificador del registroSiN/A
motivo_retiross_descripcionLongDescripción del motivo de retiroSiN/A
motivo_retirocodigo_mempresaStringCódigo de la Empresa (Entorno Multiempresa)Si“9999999999”
motivo_retirornumLongIdentificador de fila del registroSiAuto incremental por fila
ws_listarResultreturn_response_dateDateFecha y hora de ejecución del consumoSifecha y hora del sistema
ws_listarResultreturn_execution_timeLongTiempo de ejecución del consumo en milisegundosSi0

Ejemplos

Entrada 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:tem="http://tempurl.org">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:ws_listar>
         <!--Optional:-->
         <tem:as_config>
         {"token_session": "5d72d47a04aca434619c06dc9021c8b9877dd02f8537499cb61915656b8907c1"}
         </tem:as_config>
         <!--Optional:-->
         <tem:as_data>
         {"firstpag": 1, "lastpag": 1, "orderby":"ss_descripcion asc"}
         </tem:as_data>
      </tem:ws_listar>
   </soapenv:Body>
</soapenv:Envelope>
Retorno 
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <ws_listarResponse xmlns="http://tempurl.org">
         <ws_listarResult>{
    "return_code": "1",
    "return_user_message": "consulta de datos existosa",
    "return_technical_message": "consulta de datos existosa",
    "return_object": {
        "alert": [
            {
                "msg": "no se identifica el parámetro: where"
            }
        ],
        "dataobject": "dsg_core_dual",
        "columncount": 4,
        "motivo_retiro": [
            {
                "ka_nl_motivo_retiro": 4,
                "ss_descripcion": "CUMPLIMIENTO EDAD",
                "codigo_mempresa": "9999999999",
                "rnum": 1
            }
        ],
        "rowcount": 10
    },
    "return_response_date": "21/06/2019 16:51:38",
    "return_execution_time": "203"
}</ws_listarResult>
      </ws_listarResponse>
   </soap:Body>
</soap:Envelope>

Contrato de Consumo: WS_INSERTAR

Contrato de Consumo
OperaciónObjetivo
ws_insertarAgrega un nuevo registro en la tabla NOMINA.MOTIVO_RETIRO.
Parámetros de Entrada
NombreTipo de DatosDescripciónFormato Tipo
as_configStringCadena de Configuración del ConsumoJson
as_dataStringCadena que contiene los parámetros del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto3)
as_configtoken_sessionStringCadena que representa el hash de autenticación de acceso al consumoSiN/A
as_datadatarecordObjeto JsonObjeto que contiene la data a registrarSi1
datarecordka_nl_motivo_retiroLongIdentificador del registroSi0
datarecordss_descripcionStringDescripción del motivo de retiroSiN/A
datarecordcodigo_mempresaStringCódigo de la Empresa (Entorno Multiempresa)Si“9999999999”
Parámetros de Retorno
NombreTipo de DatosDescripciónFormato Tipo
ws_insertarResultStringCadena de retorno del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto4)
ws_insertarResultreturn_codeStringCadena que representa el código de retorno del consumo 1: OK -1: ErrorSiN/A
ws_insertarResultreturn_user_messageStringCadena que representa el mensaje de usuario de retorno del consumoSiN/A
ws_insertarResultreturn_response_dateDateFecha y hora de ejecución del consumoSifecha y hora del sistema
ws_insertarResultreturn_execution_timeLongTiempo de ejecución del consumo en milisegundosSi0

Ejemplos

Entrada 
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" 
xmlns:tem="http://tempurl.org">
   <soap:Header/>
   <soap:Body>
      <tem:ws_insertar>
         <!--Optional:-->
         <tem:as_config>
         { "token_session": "5d72d47a04aca434619c06dc9021c8b9877dd02f8537499cb61915656b8907c1"}
         </tem:as_config>
         <!--Optional:-->
         <tem:as_data>
         {"datarecord":{"ka_nl_motivo_retiro":0,"ss_descripcion":"OTRO MOTIVO"}}
         </tem:as_data>
      </tem:ws_insertar>
   </soap:Body>
</soap:Envelope>
Retorno 
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <ws_insertarResponse xmlns="http://tempurl.org">
         <ws_insertarResult>{
    "return_code": "1",
    "return_user_message": "información registrada correctamente.",
    "return_response_date": "21/06/2019 19:36:48",
    "return_execution_time": "906"
}</ws_insertarResult>
      </ws_insertarResponse>
   </soap:Body>
</soap:Envelope>

Contrato de Consumo: WS_ACTUALIZAR

Contrato de Consumo
OperaciónObjetivo
ws_actualizarAgrega un nuevo registro en la tabla NOMINA.MOTIVO_RETIRO.
Parámetros de Entrada
NombreTipo de DatosDescripciónFormato Tipo
as_configStringCadena de Configuración del ConsumoJson
as_dataStringCadena que contiene los parámetros del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto5)
as_configtoken_sessionStringCadena que representa el hash de autenticación de acceso al consumoSiN/A
as_datadatarecordObjeto JsonObjeto que contiene la data a actualizarSi1
datarecordka_nl_motivo_retiroLongIdentificador del registro a actualizarSiN/A
datarecordss_descripcionStringDescripción del motivo de retiroSiN/A
datarecordcodigo_mempresaStringCódigo de la Empresa (Entorno Multiempresa)Si“9999999999”
Parámetros de Retorno
NombreTipo de DatosDescripciónFormato Tipo
ws_actualizarResultStringCadena de retorno del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto6)
ws_actualizarResultreturn_codeStringCadena que representa el código de retorno del consumo 1: OK -1: ErrorSiN/A
ws_actualizarResultreturn_user_messageStringCadena que representa el mensaje de usuario de retorno del consumoSiN/A
ws_actualizarResultreturn_response_dateDateFecha y hora de ejecución del consumoSifecha y hora del sistema

Ejemplos

Entrada 
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" 
xmlns:tem="http://tempurl.org">
   <soap:Header/>
   <soap:Body>
      <tem:ws_actualizar>
         <!--Optional:-->
         <tem:as_config>
         { "token_session": "5d72d47a04aca434619c06dc9021c8b9877dd02f8537499cb61915656b8907c1"}
         </tem:as_config>
         <!--Optional:-->
         <tem:as_data>
         {"datarecord":{"ka_nl_motivo_retiro":22,"ss_descripcion":"MOTIVO DE PRUEBA"}}
         </tem:as_data>
      </tem:ws_actualizar>
   </soap:Body>
</soap:Envelope>
Retorno 
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <ws_actualizarResponse xmlns="http://tempurl.org">
         <ws_actualizarResult>{
    "return_code": "1",
    "return_user_message": "información actualizada correctamente",
    "return_response_date": "21/06/2019 20:06:07"
}</ws_actualizarResult>
      </ws_actualizarResponse>
   </soap:Body>
</soap:Envelope>

Contrato de Consumo: WS_CONSULTAR

Contrato de Consumo
OperaciónObjetivo
ws_consultarconsulta un único registro dado de la tabla NOMINA.MOTIVO_RETIRO.
Parámetros de Entrada
NombreTipo de DatosDescripciónFormato Tipo
as_configStringCadena de Configuración del ConsumoJson
as_dataStringCadena que contiene los parámetros del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto7)
as_configtoken_sessionStringCadena que representa el hash de autenticación de acceso al consumoSiN/A
as_dataka_nl_motivo_retiroLongIdentificador del registro a consultarSi1
Parámetros de Retorno
NombreTipo de DatosDescripciónFormato Tipo
ws_consultarResultStringCadena de retorno del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto8)
ws_consultarResultreturn_codeStringCadena que representa el código de retorno del consumo 1: OK -1: ErrorSiN/A
ws_consultarResultreturn_user_messageStringCadena que representa el mensaje de usuario de retorno del consumoSiN/A
ws_consultarResultreturn_technical_messageStringCadena que representa el mensaje técnico de retorno del consumoSiN/A
ws_consultarResultreturn_objectStringCadena que representa el objeto de retorno del consumoNoN/A
return_objectalertStringCadena que representa el array de mensajes de alerta de retorno del consumoNoN/A
alertmsgStringCadena que representan una posición del array de mensajes de alerta de retorno del consumoNoN/A
return_objectcolumncountLongValor que representa la cantidad de columnas de la data devuelve en el objeto de consumoNoN/A
return_objectrowcountLongValor que representa la cantidad de filas totales de la data que representa el objeto de consumoNoN/A
return_objectmotivo_retiroArray ObjectArray de Objetos que representan la data que devuelve el consumoNoN/A
motivo_retiroka_nl_motivo_retiroLongIdentificador del registroSiN/A
motivo_retiross_descripcionStringDescripción del motivo de retiroSiN/A
motivo_retirocodigo_mempresaStringCódigo de la Empresa (Entorno Multiempresa)Si“9999999999”
motivo_retirornumLongIdentificador de fila del registroSiAuto incremental por fila
ws_consultarResultreturn_response_dateDateFecha y hora de ejecución del consumoSifecha y hora del sistema
ws_consultarResultreturn_execution_timeLongTiempo de ejecución del consumo en milisegundosSi0

Ejemplos

Entrada 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:tem="http://tempurl.org">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:ws_consultar>
         <!--Optional:-->
         <tem:as_config>
         { "token_session": "75fc8798d624646a88ee12db006e5a98a477683c030e0f1f21fbaca8058d5404" }
         </tem:as_config>
         <!--Optional:-->
         <tem:as_data>
         {"ka_nl_motivo_retiro":8}
         </tem:as_data>
      </tem:ws_consultar>
   </soapenv:Body>
</soapenv:Envelope>
Retorno 
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <ws_consultarResponse xmlns="http://tempurl.org">
         <ws_consultarResult>{
    "return_code": "1",
    "return_user_message": "consulta de datos existosa",
    "return_technical_message": "consulta de datos existosa",
    "return_object": {
        "dataobject": "dsg_core_dual",
        "columncount": 4,
        "motivo_retiro": [
            {
                "ka_nl_motivo_retiro": 8,
                "ss_descripcion": "CUMPLIMIENTO EDAD",
                "codigo_mempresa": "9999999999",
                "rnum": 1
            }
        ],
        "rowcount": 0
    },
    "return_response_date": "28/06/2019 09:51:59",
    "return_execution_time": "375"
}</ws_consultarResult>
      </ws_consultarResponse>
   </soap:Body>
</soap:Envelope>

Validaciones

idcodigoDescripción
162CRUD_THE_QUERY_PARAMETER_IS_NOT_IDENTIFIEDno se identifica el parámetro
163CRUD_LIMIT_CONTROL_OF_RECORD_PER_PAGEcontrol de límite de registros por paginación
283CRUD_THERE_PREVIOUSLY_ENTERED_RECORD_IDENTIFIERexiste un registro previamente ingresado con el identificador
381CRUD_INDEFINITE_QUERY_CONFIGURATIONconfiguración de consulta indefinida
402CRUD_INDEFINITE_QUERY_VALIDATIONvalidación de consulta indefinida
403CRUD_INDEFINITE_UPDATE_CONFIGURATIONconfiguración de actualización indefinida
404CRUD_INDEFINITE_UPDATE_VALIDATIONvalidación de actualización indefinida
405CRUD_INDEFINITE_INSERT_VALIDATIONvalidación de inserción indefinida
406CRUD_INDEFINITE_INSERT_CONFIGURATIONconfiguración de inserción indefinida
407CRUD_INDEFINITE_DELETE_VALIDATIONvalidación de eliminacion indefinida
408CRUD_INDEFINITE_DELETE_CONFIGURATIONconfiguración de eliminación indefinida
421CRUD_ROW_NUMBER_IN_UPDATE_IS_NOT_IDENTIFIEDno se identifica el número de fila en la actualización
441CRUD_EMPTY_OR_NULL_FIELDcampo nulo o vacío
461CRUD_THERE_IS_NO_INFORMATION_TO_ELIMINATEno existe información para eliminar
462CRUD_ERROR_WHEN_IDENTIFYING_RECORD_ELIMINATIONerror al identificar registros de la eliminación
501CRUD_CONSUMPTION_OPERATION_IS_NOT_IDENTIFIEDno se identifica la operación crud del consumo
502CRUD_NAME_CAN_NOT_BE_IDENTIFIEDno se puede identifcar el nombre del crud
1) , 2) , 3) , 4) , 5) , 6) , 7) , 8)
Los valores por defecto son asumidos por el consumo interno
ada/tips/sicoferp/general/pbtows/procesos/inventario/nominamaestros/motivoretiro.1562968198.txt.gz · Última modificación: 2019/07/12 21:49 por ciro.soto

Herramientas de la página

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki