Muestra las diferencias entre dos versiones de la página.
Ambos lados, revisión anterior Revisión previa Próxima revisión | Revisión previa | ||
ada:tips:sicoferp:general:pbtows:procesos:inventario:nominamaestros:tipoempleado [2019/07/05 21:45] ciro.soto |
ada:tips:sicoferp:general:pbtows:procesos:inventario:nominamaestros:tipoempleado [2019/07/23 20:20] (actual) ciro.soto |
||
---|---|---|---|
Línea 1: | Línea 1: | ||
- | ====== Maestro Tipos Empleados ====== | + | ====== Maestro Tipo Empleado ====== |
===== Definición ===== | ===== Definición ===== | ||
^ Definición del Componente ^^ | ^ Definición del Componente ^^ | ||
- | ^ Nombre |n_ws05_tipo_tercero| | + | ^ Nombre |n_ws05_tipo_empleado| |
- | ^Descripción |Gestiona el Maestro de Tipos Empleados| | + | ^Descripción |Gestiona el Maestro de Tipos de Empleados| |
- | ^Proyecto PB|ws05_tipo_tercero| | + | |
- | ^Versión PB| 12.5.1| | + | |
- | ^URL SVN|http://adacsc.co:1443/svn/repository/ADA/SICOF/SICOF%20PBtoWS/Branches/Backend/branches%2012.5.2.5.0/05_Nomina/crud| | + | |
- | ^Librerias Propias^Tipo^ | + | |
- | |ws05_tipo_tercero.pbl| Libreria Lanzadora| | + | |
- | |sf05controller_tipo_tercero.pbl|Libreria Controladora| | + | |
- | |sf05model_tipo_tercero.pbl|Libreria Modelo DB| | + | |
- | ^Librerias Core^Tipo^ | + | |
- | |sf00core_object.pbl| Libreria Core de Objetos Base| | + | |
- | |sf00core_transaction.pbl|Libreria Core de control de Transacción DB| | + | |
- | |sf00core_proxy.pbl|Libreria 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 ^^ | ^ Exposición de Servicio ^^ | ||
^Tipo Servicio |SOAP 1.1 y SOAP 1.2 (.Net Easy SOAP - Generado por Powerbuilder)| | ^Tipo Servicio |SOAP 1.1 y SOAP 1.2 (.Net Easy SOAP - Generado por Powerbuilder)| | ||
- | ^URL Recurso |http://10.1.40.170:88/ws05_tipo_tercero/n_ws05_tipo_tercero.asmx?WSDL| | ||
^Operaciones ^Objetivo^ | ^Operaciones ^Objetivo^ | ||
- | |ws_listar|lista los registros actuales de la tabla **NOMINA.TIPOS_TERCERO**.| | + | |ws_actualizar|Actualiza datos del Maestro de Tipo de Empleados| |
- | |ws_insertar|ingresa un nuevo registro en la tabla **NOMINA.TIPOS_TERCERO**.| | + | |ws_consultar|Consulta datos del Maestro de Tipo de Empleados| |
- | |ws_actualizar|actualiza valores en un registro de la tabla **NOMINA.TIPOS_TERCERO**.| | + | |ws_insertar|Registra un nuevo Tipo de Empleados| |
- | + | |ws_listar|Lista del Maestro de Tipo de Empleados| | |
- | + | |ws_list_clase_empleados|Genera una lista con del Maestro de Tipo de Empleados| | |
- | ===== Contrato de Consumo: WS_LISTAR ===== | + | |
- | + | ||
- | ^ Contrato de Consumo ^^^^^^ | + | |
- | ^ Operación^Objetivo ^^^^^ | + | |
- | ^ws_listar|lista los registros actuales de la tabla **NOMINA.TIPOS_TERCERO**.||||| | + | |
- | ^ Parámetros de Entrada ^^^^^^ | + | |
- | ^Nombre^Tipo de Datos^Descripción^^^Formato Tipo^ | + | |
- | |as_config|String|Cadena de Configuración del Consumo|||Json| | + | |
- | |as_data|String|Cadena que contiene los parámetros del Consumo|||Json| | + | |
- | ^ Definición Interna ^^^^^^ | + | |
- | ^Parámetro Entrada^Atributo^Tipo Dato^Descripción^Requerido^Valor por Defecto((Los valores por defecto son asumidos por el consumo interno))^ | + | |
- | |as_config|token_session|String|Cadena que representa el hash de autenticación de acceso al consumo|Si|N/A| | + | |
- | |as_data|firstpag|Integer|Identificador de registro inicial de la paginación del consumo|Si|1| | + | |
- | |as_data|lastpag|Integer|Identificador de registro final de la paginación del consumo|Si|1| | + | |
- | |as_data|orderby|String|Cadena que contiene las columnas de ordenamiento del consumo|No|Utilizado por la DB| | + | |
- | |as_data|where|String|Cadena que contiene la sentencias de filtrado del consumo|No|N/A| | + | |
- | ^ Parámetros de Retorno ^^^^^^ | + | |
- | ^Nombre^Tipo de Datos^Descripción^^^Formato Tipo^ | + | |
- | |ws_listarResult|String|Cadena de retorno del Consumo|||Json| | + | |
- | ^ Definición Interna ^^^^^^ | + | |
- | ^Parámetro Entrada^Atributo^Tipo Dato^Descripción^Requerido^Valor por Defecto((Los valores por defecto son asumidos por el consumo interno))^ | + | |
- | |ws_listarResult|return_code|String|Cadena que representa el código de retorno del consumo 1: OK -1: Error|Si|N/A| | + | |
- | |ws_listarResult|return_user_message|String|Cadena que representa el mensaje de usuario de retorno del consumo|Si|N/A| | + | |
- | |ws_listarResult|return_technical_message|String|Cadena que representa el mensaje técnico de retorno del consumo|Si|N/A| | + | |
- | |ws_listarResult|return_object|String|Cadena que representa el objeto de retorno del consumo|No|N/A| | + | |
- | |return_object|alert|String|Cadena que representa el array de mensajes de alerta de retorno del consumo|No|N/A| | + | |
- | |alert|msg|String|Cadena que representan una posición del array de mensajes de alerta de retorno del consumo|No|N/A| | + | |
- | |return_object|columncount|Long|Valor que representa la cantidad de columnas de la data devuelve en el objeto de consumo|No|N/A| | + | |
- | |return_object|rowcount|Long|Valor que representa la cantidad de filas totales de la data que representa el objeto de consumo|No|N/A| | + | |
- | |return_object|tipo_tercero|Array Object|Array de Objetos que representan la data que devuelve el consumo|No|N/A| | + | |
- | |tipo_tercero|ka_nl_tipo_tercero|String|Código de la Identificación del Registro|Si|N/A| | + | |
- | |tipo_tercero|sc_tipo_tercero|String|Nombre dado al Tipo de Tercero o Entidad|Si|N/A| | + | |
- | |tipo_tercero|c_borrado|String|Identificador para indicar si esta activo o no|Si|N/A| | + | |
- | |tipo_tercero|usuario_empresa|String|Código del Usuario(Entorno Multiempresa)|Si|"NOMINA"| | + | |
- | |tipo_tercero|sc_empleado|String|Código Identificador del Proceso al que Pertenece|Si|"S"| | + | |
- | |tipo_tercero|codigo_mempresa|String|Código de la Empresa(Entorno Multiempresa)|Si|"9999999999"| | + | |
- | |tipo_tercero|tipo_tercero|String|Código identificador del Resgistro|Si|N/A| | + | |
- | |ws_listarResult|return_response_date|Date|Fecha y hora de ejecución del consumo|Si|fecha y hora del sistema| | + | |
- | |ws_listarResult|return_execution_time|Long|Tiempo de ejecución del consumo en milisegundos|Si|0| | + | |
- | + | ||
- | ===== Ejemplos ===== | + | |
- | + | ||
- | ^ Entrada ^^^^^^ | + | |
- | |<code html> | + | |
- | <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": "ae2fd263bbb6de1cc21ef7a60aec69c63c5ee07db8d85a289bf41f38e140c113" } | + | |
- | </tem:as_config> | + | |
- | <!--Optional:--> | + | |
- | <tem:as_data>{"crud_controller": "n_cst_controller_tipo_tercero", "crud_name":"TIPO_TERCERO", "crud_operation":"READ", "crud_interface":"READ", "firstpag":1, "lastpag":100, "resultset":"crud"} | + | |
- | </tem:as_data> | + | |
- | </tem:ws_listar> | + | |
- | </soapenv:Body> | + | |
- | </soapenv:Envelope> | + | |
- | </code>|||||| | + | |
- | ^ Retorno ^^^^^^ | + | |
- | |<code html> | + | |
- | <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 parametro: where" | + | |
- | }, | + | |
- | { | + | |
- | "msg": "no se identifica el parametro: orderby" | + | |
- | } | + | |
- | ], | + | |
- | "crud": [ | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 31, | + | |
- | "sc_tipo_tercero": "ENTIDAD PRESTADORA", | + | |
- | "c_borrado": "N", | + | |
- | "usuario_empresa": "NOMINA", | + | |
- | "sc_empleado": "N", | + | |
- | "codigo_mempresa": "9999999999", | + | |
- | "rnum": 1 | + | |
- | } | + | |
- | ], | + | |
- | "rowcount": 19 | + | |
- | }, | + | |
- | "return_response_date": "05/07/2019 20:22:41", | + | |
- | "return_execution_time": "389" | + | |
- | }</ws_listarResult> | + | |
- | </ws_listarResponse> | + | |
- | </soap:Body> | + | |
- | </soap:Envelope> | + | |
- | </code>|||||| | + | |
- | + | ||
- | + | ||
- | ===== Contrato de Consumo: WS_INSERTAR ===== | + | |
- | + | ||
- | ^ Contrato de Consumo ^^^^^^ | + | |
- | ^ Operación^Objetivo ^^^^^ | + | |
- | ^ws_insertar|Agrega un nuevo registro en la tabla **NOMINA.TIPOS_TERCERO**.||||| | + | |
- | ^ Parámetros de Entrada ^^^^^^ | + | |
- | ^Nombre^Tipo de Datos^Descripción^^^Formato Tipo^ | + | |
- | |as_config|String|Cadena de Configuración del Consumo|||Json| | + | |
- | |as_data|String|Cadena que contiene los parámetros del Consumo|||Json| | + | |
- | ^ Definición Interna ^^^^^^ | + | |
- | ^Parámetro Entrada^Atributo^Tipo Dato^Descripción^Requerido^Valor por Defecto((Los valores por defecto son asumidos por el consumo interno))^ | + | |
- | |as_config|token_session|String|Cadena que representa el hash de autenticación de acceso al consumo|Si|N/A| | + | |
- | |as_data|datarecord|Objeto Json|Objeto que contiene la data a registrar|Si|1| | + | |
- | |datarecord|ka_nl_tipo_tercero|String|Código de la Identificación del Registro|Si|N/A| | + | |
- | |datarecord|sc_tipo_tercero|String|Nombre dado al Tipo de Tercero o Entidad|Si|N/A| | + | |
- | |datarecord|c_borrado|String|Identificador para indicar si esta activo o no|Si|N/A| | + | |
- | |datarecord|usuario_empresa|String|Código del Usuario(Entorno Multiempresa)|Si|"NOMINA"| | + | |
- | |datarecord|sc_empleado|String|Código Identificador del Proceso al que Pertenece|Si|"S"| | + | |
- | |datarecord|codigo_mempresa|String|Código de la Empresa(Entorno Multiempresa)|Si|"9999999999"| | + | |
- | |datarecord|tipo_tercero|String|Código identificador del Resgistro|Si|N/A| | + | |
- | ^ Parámetros de Retorno ^^^^^^ | + | |
- | ^Nombre^Tipo de Datos^Descripción^^^Formato Tipo^ | + | |
- | |ws_insertarResult|String|Cadena de retorno del Consumo|||Json| | + | |
- | ^ Definición Interna ^^^^^^ | + | |
- | ^Parámetro Entrada^Atributo^Tipo Dato^Descripción^Requerido^Valor por Defecto((Los valores por defecto son asumidos por el consumo interno))^ | + | |
- | |ws_insertarResult|return_code|String|Cadena que representa el código de retorno del consumo 1: OK -1: Error|Si|N/A| | + | |
- | |ws_insertarResult|return_user_message|String|Cadena que representa el mensaje de usuario de retorno del consumo|Si|N/A| | + | |
- | |ws_insertarResult|return_response_date|Date|Fecha y hora de ejecución del consumo|Si|fecha y hora del sistema| | + | |
- | |ws_insertarResult|return_execution_time|Long|Tiempo de ejecución del consumo en milisegundos|Si|0| | + | |
- | + | ||
- | ===== Ejemplos ===== | + | |
- | + | ||
- | ^ Entrada ^^^^^^ | + | |
- | |<code html> | + | |
- | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempurl.org"> | + | |
- | <soapenv:Header/> | + | |
- | <soapenv:Body> | + | |
- | <tem:ws_insertar> | + | |
- | <!--Optional:--> | + | |
- | <tem:as_config>{ "token_session": "ae2fd263bbb6de1cc21ef7a60aec69c63c5ee07db8d85a289bf41f38e140c113" } | + | |
- | </tem:as_config> | + | |
- | <!--Optional:--> | + | |
- | <tem:as_data>{"crud_controller": "n_cst_controller_tipo_tercero", "crud_name":"TIPO_TERCERO", "crud_operation":"CREATE", "crud_interface":"CREATE", "datarecord":{"KA_NL_TIPO_TERCERO":35, "sc_tipo_tercero":"ciro", "c_borrado":"N", "usuario_empresa":"NOMINA", "sc_empleado":"N", "codigo_mempresa":"9999999999"}} | + | |
- | </tem:as_data> | + | |
- | </tem:ws_insertar> | + | |
- | </soapenv:Body> | + | |
- | </soapenv:Envelope> | + | |
- | </code>|||||| | + | |
- | ^ Retorno ^^^^^^ | + | |
- | |<code html> | + | |
- | <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_insertarResponse xmlns="http://tempurl.org"> | + | |
- | <ws_insertarResult>{ | + | |
- | "return_code": "1", | + | |
- | "return_user_message": "información registrada correctamente.", | + | |
- | "return_response_date": "05/07/2019 20:30:16", | + | |
- | "return_execution_time": "249" | + | |
- | }</ws_insertarResult> | + | |
- | </ws_insertarResponse> | + | |
- | </soap:Body> | + | |
- | </soap:Envelope> | + | |
- | </code>|||||| | + | |
- | + | ||
- | + | ||
- | ===== Contrato de Consumo: WS_ACTUALIZAR ===== | + | |
- | + | ||
- | ^ Contrato de Consumo ^^^^^^ | + | |
- | ^ Operación^Objetivo ^^^^^ | + | |
- | ^ws_actualizar|Agrega un nuevo registro en la tabla **NOMINA.TIPOS_TERCERO**.||||| | + | |
- | ^ Parámetros de Entrada ^^^^^^ | + | |
- | ^Nombre^Tipo de Datos^Descripción^^^Formato Tipo^ | + | |
- | |as_config|String|Cadena de Configuración del Consumo|||Json| | + | |
- | |as_data|String|Cadena que contiene los parámetros del Consumo|||Json| | + | |
- | ^ Definición Interna ^^^^^^ | + | |
- | ^Parámetro Entrada^Atributo^Tipo Dato^Descripción^Requerido^Valor por Defecto((Los valores por defecto son asumidos por el consumo interno))^ | + | |
- | |as_config|token_session|String|Cadena que representa el hash de autenticación de acceso al consumo|Si|N/A| | + | |
- | |as_data|datarecord|Objeto Json|Objeto que contiene la data a registrar|Si|1| | + | |
- | |as_data|datarecord|Objeto Json|Objeto que contiene la data a registrar|Si|1| | + | |
- | ||datarecord|ka_nl_tipo_tercero|String|Código de la Identificación del Registro|Si|N/A| | + | |
- | |datarecord|sc_tipo_tercero|String|Nombre dado al Tipo de Tercero o Entidad|Si|N/A| | + | |
- | |datarecord|c_borrado|String|Identificador para indicar si esta activo o no|Si|N/A| | + | |
- | |datarecord|usuario_empresa|String|Código del Usuario(Entorno Multiempresa)|Si|"NOMINA"| | + | |
- | |datarecord|sc_empleado|String|Código Identificador del Proceso al que Pertenece|Si|"S"| | + | |
- | |datarecord|codigo_mempresa|String|Código de la Empresa(Entorno Multiempresa)|Si|"9999999999"| | + | |
- | |datarecord|tipo_tercero|String|Código identificador del Resgistro|Si|N/A| | + | |
- | ^ Parámetros de Retorno ^^^^^^ | + | |
- | ^Nombre^Tipo de Datos^Descripción^^^Formato Tipo^ | + | |
- | |ws_actualizarResult|String|Cadena de retorno del Consumo|||Json| | + | |
- | ^ Definición Interna ^^^^^^ | + | |
- | ^Parámetro Entrada^Atributo^Tipo Dato^Descripción^Requerido^Valor por Defecto((Los valores por defecto son asumidos por el consumo interno))^ | + | |
- | |ws_actualizarResult|return_code|String|Cadena que representa el código de retorno del consumo 1: OK -1: Error|Si|N/A| | + | |
- | |ws_actualizarResult|return_user_message|String|Cadena que representa el mensaje de usuario de retorno del consumo|Si|N/A| | + | |
- | |ws_actualizarResult|return_response_date|Date|Fecha y hora de ejecución del consumo|Si|fecha y hora del sistema| | + | |
- | + | ||
- | ===== Ejemplos ===== | + | |
- | + | ||
- | ^ Entrada ^^^^^^ | + | |
- | |<code html> | + | |
- | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempurl.org"> | + | |
- | <soapenv:Header/> | + | |
- | <soapenv:Body> | + | |
- | <tem:ws_actualizar> | + | |
- | <!--Optional:--> | + | |
- | <tem:as_config>{ "token_session": "ae2fd263bbb6de1cc21ef7a60aec69c63c5ee07db8d85a289bf41f38e140c113" } | + | |
- | </tem:as_config> | + | |
- | <!--Optional:--> | + | |
- | <tem:as_data>{"crud_controller": "n_cst_controller_tipo_tercero", "crud_name":"TIPO_TERCERO", "crud_operation":"UPDATE", "crud_interface":"UPDATE", "datarecord":{"KA_NL_TIPO_TERCERO":41, "sc_tipo_tercero":"PRUEBAS", "c_borrado":"N", "usuario_empresa":"NOMINA", "sc_empleado":"N", "codigo_mempresa":"9999999999"}} | + | |
- | </tem:as_data> | + | |
- | </tem:ws_actualizar> | + | |
- | </soapenv:Body> | + | |
- | </soapenv:Envelope> | + | |
- | </code>|||||| | + | |
- | ^ Retorno ^^^^^^ | + | |
- | |<code html> | + | |
- | <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_actualizarResponse xmlns="http://tempurl.org"> | + | |
- | <ws_actualizarResult>{ | + | |
- | "return_code": "1", | + | |
- | "return_user_message": "información actualizada correctamente", | + | |
- | "return_response_date": "05/07/2019 20:36:18" | + | |
- | }</ws_actualizarResult> | + | |
- | </ws_actualizarResponse> | + | |
- | </soap:Body> | + | |
- | </soap:Envelope> | + | |
- | </code>|||||| | + | |
- | + | ||
- | + | ||
- | + | ||
- | ===== Contrato de Consumo: WS_CONSULTAR ===== | + | |
- | + | ||
- | ^ Contrato de Consumo ^^^^^^ | + | |
- | ^ Operación^Objetivo ^^^^^ | + | |
- | ^ws_consultar|consulta un único registro dado de la tabla **NOMINA.TIPOS_TERCERO**||||| | + | |
- | ^ Parámetros de Entrada ^^^^^^ | + | |
- | ^Nombre^Tipo de Datos^Descripción^^^Formato Tipo^ | + | |
- | |as_config|String|Cadena de Configuración del Consumo|||Json| | + | |
- | |as_data|String|Cadena que contiene los parámetros del Consumo|||Json| | + | |
- | ^ Definición Interna ^^^^^^ | + | |
- | ^Parámetro Entrada^Atributo^Tipo Dato^Descripción^Requerido^Valor por Defecto((Los valores por defecto son asumidos por el consumo interno))^ | + | |
- | |as_config|token_session|String|Cadena que representa el hash de autenticación de acceso al consumo|Si|N/A| | + | |
- | |as_data|ka_nl_tipo_tercero|Long|Identificador del registro a consultar|Si|1| | + | |
- | ^ Parámetros de Retorno ^^^^^^ | + | |
- | ^Nombre^Tipo de Datos^Descripción^^^Formato Tipo^ | + | |
- | |ws_consultarResult|String|Cadena de retorno del Consumo|||Json| | + | |
- | ^ Definición Interna ^^^^^^ | + | |
- | ^Parámetro Entrada^Atributo^Tipo Dato^Descripción^Requerido^Valor por Defecto((Los valores por defecto son asumidos por el consumo interno))^ | + | |
- | |ws_consultarResult|return_code|String|Cadena que representa el código de retorno del consumo 1: OK -1: Error|Si|N/A| | + | |
- | |ws_consultarResult|return_user_message|String|Cadena que representa el mensaje de usuario de retorno del consumo|Si|N/A| | + | |
- | |ws_consultarResult|return_technical_message|String|Cadena que representa el mensaje técnico de retorno del consumo|Si|N/A| | + | |
- | |ws_consultarResult|return_object|String|Cadena que representa el objeto de retorno del consumo|No|N/A| | + | |
- | |return_object|alert|String|Cadena que representa el array de mensajes de alerta de retorno del consumo|No|N/A| | + | |
- | |alert|msg|String|Cadena que representan una posición del array de mensajes de alerta de retorno del consumo|No|N/A| | + | |
- | |return_object|columncount|Long|Valor que representa la cantidad de columnas de la data devuelve en el objeto de consumo|No|N/A| | + | |
- | |return_object|rowcount|Long|Valor que representa la cantidad de filas totales de la data que representa el objeto de consumo|No|N/A| | + | |
- | |return_object|tipo_tercero|Array Object|Array de Objetos que representan la data que devuelve el consumo|No|N/A| | + | |
- | |tipo_tercero|ka_nl_tipo_tercero|String|Código de la Identificación del Registro|Si|N/A| | + | |
- | |tipo_tercero|sc_tipo_tercero|String|Nombre dado al Tipo de Tercero o Entidad|Si|N/A| | + | |
- | |tipo_tercero|c_borrado|String|Identificador para indicar si esta activo o no|Si|N/A| | + | |
- | |tipo_tercero|usuario_empresa|String|Código del Usuario(Entorno Multiempresa)|Si|"NOMINA"| | + | |
- | |tipo_tercero|sc_empleado|String|Código Identificador del Proceso al que Pertenece|Si|"S"| | + | |
- | |tipo_tercero|codigo_mempresa|String|Código de la Empresa(Entorno Multiempresa)|Si|"9999999999"| | + | |
- | |tipo_tercero|tipo_tercero|String|Código identificador del Resgistro|Si|N/A| | + | |
- | |ws_listarResult|return_response_date|Date|Fecha y hora de ejecución del consumo|Si|fecha y hora del sistema| | + | |
- | |ws_listarResult|return_execution_time|Long|Tiempo de ejecución del consumo en milisegundos|Si|0| | + | |
- | + | ||
- | ===== Ejemplos ===== | + | |
- | + | ||
- | ^ Entrada ^^^^^^ | + | |
- | |<code html> | + | |
- | <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": "ae2fd263bbb6de1cc21ef7a60aec69c63c5ee07db8d85a289bf41f38e140c113" } | + | |
- | </tem:as_config> | + | |
- | <!--Optional:--> | + | |
- | <tem:as_data>{"crud_controller": "n_cst_controller_tipo_tercero", "crud_name":"TIPO_TERCERO", "crud_operation":"READ", "crud_interface":"READ_ONLY_ONE", "KA_NL_TIPO_TERCERO": 1} | + | |
- | </tem:as_data> | + | |
- | </tem:ws_consultar> | + | |
- | </soapenv:Body> | + | |
- | </soapenv:Envelope> | + | |
- | </code>|||||| | + | |
- | ^ Retorno ^^^^^^ | + | |
- | |<code html> | + | |
- | <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": { | + | |
- | "alert": [ | + | |
- | { | + | |
- | "msg": "no se identifica el parametro: firstpag" | + | |
- | }, | + | |
- | { | + | |
- | "msg": "no se identifica el parametro: lastpag" | + | |
- | }, | + | |
- | { | + | |
- | "msg": "no se identifica el parametro: orderby" | + | |
- | } | + | |
- | ], | + | |
- | "TIPOS_TERCERO": [ | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 1, | + | |
- | "sc_tipo_tercero": "EMPLEADOS", | + | |
- | "c_borrado": "N", | + | |
- | "usuario_empresa": "NOMINA", | + | |
- | "sc_empleado": "S", | + | |
- | "codigo_mempresa": "9999999999", | + | |
- | "rnum": 1 | + | |
- | } | + | |
- | ], | + | |
- | "rowcount": 19 | + | |
- | }, | + | |
- | "return_response_date": "05/07/2019 20:34:10", | + | |
- | "return_execution_time": "187" | + | |
- | }</ws_consultarResult> | + | |
- | </ws_consultarResponse> | + | |
- | </soap:Body> | + | |
- | </soap:Envelope> | + | |
- | </code>|||||| | + | |
- | + | ||
- | ===== Contrato de Consumo: WS_LIST_TIPO_TERCERO ===== | + | |
- | + | ||
- | ^ Contrato de Consumo ^^^^^^ | + | |
- | ^ Operación^Objetivo ^^^^^ | + | |
- | ^ws_listar|lista los registros actuales de la tabla **NOMINA.TIPOS_TERCERO**.||||| | + | |
- | ^ Parámetros de Entrada ^^^^^^ | + | |
- | ^Nombre^Tipo de Datos^Descripción^^^Formato Tipo^ | + | |
- | |as_config|String|Cadena de Configuración del Consumo|||Json| | + | |
- | |as_data|String|Cadena que contiene los parámetros del Consumo|||Json| | + | |
- | ^ Definición Interna ^^^^^^ | + | |
- | ^Parámetro Entrada^Atributo^Tipo Dato^Descripción^Requerido^Valor por Defecto((Los valores por defecto son asumidos por el consumo interno))^ | + | |
- | |as_config|token_session|String|Cadena que representa el hash de autenticación de acceso al consumo|Si|N/A| | + | |
- | |as_data|firstpag|Integer|Identificador de registro inicial de la paginación del consumo|Si|1| | + | |
- | |as_data|lastpag|Integer|Identificador de registro final de la paginación del consumo|Si|1| | + | |
- | |as_data|orderby|String|Cadena que contiene las columnas de ordenamiento del consumo|No|Utilizado por la DB| | + | |
- | |as_data|where|String|Cadena que contiene la sentencias de filtrado del consumo|No|N/A| | + | |
- | ^ Parámetros de Retorno ^^^^^^ | + | |
- | ^Nombre^Tipo de Datos^Descripción^^^Formato Tipo^ | + | |
- | |ws_listarResult|String|Cadena de retorno del Consumo|||Json| | + | |
- | ^ Definición Interna ^^^^^^ | + | |
- | ^Parámetro Retorno^Atributo^Tipo Dato^Descripción^Requerido^Valor por Defecto((Los valores por defecto son asumidos por el consumo interno))^ | + | |
- | |ws_listarResult|return_code|String|Cadena que representa el código de retorno del consumo 1: OK -1: Error|Si|N/A| | + | |
- | |ws_listarResult|return_user_message|String|Cadena que representa el mensaje de usuario de retorno del consumo|Si|N/A| | + | |
- | |ws_listarResult|return_technical_message|String|Cadena que representa el mensaje técnico de retorno del consumo|Si|N/A| | + | |
- | |ws_listarResult|return_object|String|Cadena que representa el objeto de retorno del consumo|No|N/A| | + | |
- | |return_object|alert|String|Cadena que representa el array de mensajes de alerta de retorno del consumo|No|N/A| | + | |
- | |alert|msg|String|Cadena que representan una posición del array de mensajes de alerta de retorno del consumo|No|N/A| | + | |
- | |return_object|columncount|Long|Valor que representa la cantidad de columnas de la data devuelve en el objeto de consumo|No|N/A| | + | |
- | |return_object|mapping_field|Long|Nombre de la Tabla en Base de Datos|No|N/A| | + | |
- | |return_object|description_list|Long|Nombre del Listado del objeto de consumo|No|N/A| | + | |
- | |return_object|rowcount|Long|Valor que representa la cantidad de filas totales de la data que representa el objeto de consumo|No|N/A| | + | |
- | |return_object|tipo_tercero|Array Object|Array de Objetos que representan la data que devuelve el consumo|No|N/A| | + | |
- | |tipo_tercero|ka_nl_tipo_tercero|String|Código de la Identificación del Registro|Si|N/A| | + | |
- | |tipo_tercero|sc_tipo_tercero|String|Nombre dado al Tipo de Tercero o Entidad|Si|N/A| | + | |
- | |ws_listarResult|return_response_date|Date|Fecha y hora de ejecución del consumo|Si|fecha y hora del sistema| | + | |
- | |ws_listarResult|return_execution_time|Long|Tiempo de ejecución del consumo en milisegundos|Si|0| | + | |
- | + | ||
- | ===== Ejemplos ===== | + | |
- | + | ||
- | ^ Entrada ^^^^^^ | + | |
- | |<code html> | + | |
- | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempurl.org"> | + | |
- | <soapenv:Header/> | + | |
- | <soapenv:Body> | + | |
- | <tem:ws_list_tipo_empleado> | + | |
- | <!--Optional:--> | + | |
- | <tem:as_config>{ "token_session": "ae2fd263bbb6de1cc21ef7a60aec69c63c5ee07db8d85a289bf41f38e140c113" } | + | |
- | </tem:as_config> | + | |
- | <!--Optional:--> | + | |
- | <tem:as_data>{"list_name":"TIPO_TERCERO"} | + | |
- | </tem:as_data> | + | |
- | </tem:ws_list_tipo_empleado> | + | |
- | </soapenv:Body> | + | |
- | </soapenv:Envelope> | + | |
- | </code>|||||| | + | |
- | + | ||
- | ^ Retorno ^^^^^^ | + | |
- | |<code html> | + | |
- | <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_list_tipo_empleadoResponse xmlns="http://tempurl.org"> | + | |
- | <ws_list_tipo_empleadoResult>{ | + | |
- | "return_code": "1", | + | |
- | "return_user_message": "consulta de datos existosa", | + | |
- | "return_technical_message": "consulta de datos existosa", | + | |
- | "return_object": { | + | |
- | "datalist": [ | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 1, | + | |
- | "sc_tipo_tercero": "EMPLEADOS" | + | |
- | }, | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 2, | + | |
- | "sc_tipo_tercero": "JUBILADOS" | + | |
- | }, | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 3, | + | |
- | "sc_tipo_tercero": "OBREROS" | + | |
- | }, | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 4, | + | |
- | "sc_tipo_tercero": "CONTRATISTAS" | + | |
- | }, | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 5, | + | |
- | "sc_tipo_tercero": "USUARIOS DEL SISTEMA" | + | |
- | }, | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 6, | + | |
- | "sc_tipo_tercero": "EPS - PENSION Y CESANTIAS,ARP" | + | |
- | }, | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 8, | + | |
- | "sc_tipo_tercero": "BENEFICIARIOS" | + | |
- | }, | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 9, | + | |
- | "sc_tipo_tercero": "ENTIDAD BANCARIA" | + | |
- | }, | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 11, | + | |
- | "sc_tipo_tercero": "PROVEEDOR" | + | |
- | }, | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 12, | + | |
- | "sc_tipo_tercero": "ENTIDAD PUBLICA" | + | |
- | }, | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 13, | + | |
- | "sc_tipo_tercero": "COOPERATIVAS" | + | |
- | }, | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 26, | + | |
- | "sc_tipo_tercero": "DEMANDANTE A EMPLEADOS" | + | |
- | }, | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 27, | + | |
- | "sc_tipo_tercero": "COOPERATIVA" | + | |
- | }, | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 28, | + | |
- | "sc_tipo_tercero": "FONDOS" | + | |
- | }, | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 29, | + | |
- | "sc_tipo_tercero": "ESTUDIANTE" | + | |
- | }, | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 31, | + | |
- | "sc_tipo_tercero": "ENTIDAD PRESTADORA" | + | |
- | }, | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 32, | + | |
- | "sc_tipo_tercero": "ENTIDAD OPERADORA" | + | |
- | }, | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 33, | + | |
- | "sc_tipo_tercero": "ASEGURADORA" | + | |
- | }, | + | |
- | { | + | |
- | "ka_nl_tipo_tercero": 41, | + | |
- | "sc_tipo_tercero": "PRUEBAS" | + | |
- | } | + | |
- | ], | + | |
- | "description_list": "Listado Tipos Terceros", | + | |
- | "mapping_field": "NOMINA.TIPOS_TERCERO", | + | |
- | "rowcount": 19 | + | |
- | }, | + | |
- | "return_response_date": "05/07/2019 20:37:33" | + | |
- | }</ws_list_tipo_empleadoResult> | + | |
- | </ws_list_tipo_empleadoResponse> | + | |
- | </soap:Body> | + | |
- | </soap:Envelope> | + | |
- | </code>|||||| | + | |
+ | ===== Contrato de Servicios ===== | ||
- | ===== Validaciones ===== | + | [[http://adacsc.co:1443/svn/repository/ADA/SICOF/SICOF%20PBtoWS/Documentos/Contratos%20de%20Servicios/Backend/05_Nomina/crud/tipo_empleado |
+ | |Maestro Tipo Empleado - SVN ADA]] | ||
- | ^id^codigo^Descripción^ | ||
- | |162|CRUD_THE_QUERY_PARAMETER_IS_NOT_IDENTIFIED|no se identifica el parámetro| | ||
- | |163|CRUD_LIMIT_CONTROL_OF_RECORD_PER_PAGE|control de límite de registros por paginación| | ||
- | |283|CRUD_THERE_PREVIOUSLY_ENTERED_RECORD_IDENTIFIER|existe un registro previamente ingresado con el identificador| | ||
- | |381|CRUD_INDEFINITE_QUERY_CONFIGURATION|configuración de consulta indefinida| | ||
- | |402|CRUD_INDEFINITE_QUERY_VALIDATION|validación de consulta indefinida| | ||
- | |403|CRUD_INDEFINITE_UPDATE_CONFIGURATION|configuración de actualización indefinida| | ||
- | |404|CRUD_INDEFINITE_UPDATE_VALIDATION|validación de actualización indefinida| | ||
- | |405|CRUD_INDEFINITE_INSERT_VALIDATION|validación de inserción indefinida| | ||
- | |406|CRUD_INDEFINITE_INSERT_CONFIGURATION|configuración de inserción indefinida| | ||
- | |407|CRUD_INDEFINITE_DELETE_VALIDATION|validación de eliminación indefinida| | ||
- | |408|CRUD_INDEFINITE_DELETE_CONFIGURATION|configuración de eliminación indefinida| | ||
- | |421|CRUD_ROW_NUMBER_IN_UPDATE_IS_NOT_IDENTIFIED|no se identifica el número de fila en la actualización| | ||
- | |441|CRUD_EMPTY_OR_NULL_FIELD|campo nulo o vacío| | ||
- | |461|CRUD_THERE_IS_NO_INFORMATION_TO_ELIMINATE|no existe información para eliminar| | ||
- | |462|CRUD_ERROR_WHEN_IDENTIFYING_RECORD_ELIMINATION|error al identificar registros de la eliminación| | ||
- | |501|CRUD_CONSUMPTION_OPERATION_IS_NOT_IDENTIFIED|no se identifica la operación crud del consumo| | ||
- | |502|CRUD_NAME_CAN_NOT_BE_IDENTIFIED|no se puede identifcar el nombre del crud| | ||
+ | [[ada:tips:sicoferp:general:pbtows:procesos:inventario:nominamaestros|←Volver atrás]] |