Muestra las diferencias entre dos versiones de la página.
Próxima revisión | Revisión previa | ||
ada:tips:sicoferp:general:pbtows:procesos:inventario:nominamaestros:seccion [2019/06/25 14:35] edixson.matos creado |
ada:tips:sicoferp:general:pbtows:procesos:inventario:nominamaestros:seccion [2019/07/23 20:17] (actual) ciro.soto |
||
---|---|---|---|
Línea 1: | Línea 1: | ||
- | ====== Maestro Secciones ====== | + | ====== Maestro Secciones ====== |
===== Definición ===== | ===== Definición ===== | ||
^ Definición del Componente ^^ | ^ Definición del Componente ^^ | ||
- | ^ Nombre |n_ws05_seccion| | + | ^ Nombre |n_ws05_secciones| |
- | ^Descripción |Gestiona el maestro de secciones| | + | ^Descripción |Gestiona el Maestro de Tipos de Secciones| |
- | ^Proyecto PB|ws05_seccion| | + | |
- | ^Versión PB| 12.5.1| | + | |
- | ^URL SVN|http://adacsc.co:1443/svn/repository/ADA/SICOF/SICOF%20PBtoWS/Branches/branches%2012.5.2.5.0/05_Nomina/seccion| | + | |
- | ^Librerias Propias^Tipo^ | + | |
- | |ws05_seccion.pbl| Libreria Lanzadora| | + | |
- | |sf05controller_seccion.pbl|Libreria Controladora| | + | |
- | |sf05model_seccion.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_seccion/n_ws05_seccion.asmx| | ||
^Operaciones ^Objetivo^ | ^Operaciones ^Objetivo^ | ||
- | |ws_listar|lista las secciones actuales de la tabla **NOMINA.SECCIONES**.| | + | |ws_actualizar|Actualiza datos del Maestro de Tipos de Secciones| |
- | |ws_insertar|ingresa un nuevo registro en la tabla **NOMINA.SECCIONES**.| | + | |ws_consultar|Consulta datos del Maestro de Tipos de Secciones| |
- | |ws_actualizar|actualiza valores en un registro de la tabla **NOMINA.SECCIONES**.| | + | |ws_insertar|Registra un nuevo Tipo de Secciones| |
- | + | |ws_listar|Lista del Maestro de Tipos de Secciones| | |
- | + | |ws_list_clase_empleados|Genera una lista con del Maestro de Tipos de Secciones| | |
- | ===== Contrato de Consumo: WS_LISTAR ===== | + | |
- | + | ||
- | ^ Contrato de Consumo ^^^^^^ | + | |
- | ^ Operación^Objetivo ^^^^^ | + | |
- | ^ws_listar|lista los registros actuales de la tabla **NOMINA.SECCIONES**.||||| | + | |
- | ^ 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|seccion|Array Object|Array de Objetos que representan la data que devuelve el consumo|No|N/A| | + | |
- | |seccion|ka_nl_seccion|Long|Identificador del registro|Si|N/A| | + | |
- | |seccion|ka_ni_centro_costo|Long|Identificador del centro de costo de la sección|No|N/A| | + | |
- | |seccion|ss_seccion|String|Descripción de la sección|Si|N/A| | + | |
- | |seccion|usuario_empresa|String|usuario de módulo|Si|N/A| | + | |
- | |seccion|codigo_mempresa|Long|Código de la Empresa (Entorno Multiempresa)|Si|"9999999999"| | + | |
- | |seccion|rnum|Long|Identificador de fila del registro|Si|Auto incremental por fila| | + | |
- | |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": "d715d7c2d82c20e4237149aa58d2e6b391a619150733c59493cb442dbf1a5940"} | + | |
- | </tem:as_config> | + | |
- | <!--Optional:--> | + | |
- | <tem:as_data> | + | |
- | </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: firstpag" | + | |
- | }, | + | |
- | { | + | |
- | "msg": "no se identifica el parametro: lastpag" | + | |
- | }, | + | |
- | { | + | |
- | "msg": "no se identifica el parametro: where" | + | |
- | }, | + | |
- | { | + | |
- | "msg": "no se identifica el parametro: orderby" | + | |
- | } | + | |
- | ], | + | |
- | "dataobject": "dsg_seccion", | + | |
- | "columncount": 6, | + | |
- | "seccion": [ | + | |
- | { | + | |
- | "ka_nl_seccion": 1914, | + | |
- | "ka_ni_centro_costo": 2000, | + | |
- | "ss_seccion": "GENERICO", | + | |
- | "usuario_empresa": "NOMINA", | + | |
- | "codigo_mempresa": "9999999999", | + | |
- | "rnum": 1 | + | |
- | } | + | |
- | ], | + | |
- | "rowcount": 1 | + | |
- | }, | + | |
- | "return_response_date": "25/06/2019 14:13:16", | + | |
- | "return_execution_time": "531" | + | |
- | }</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.SECCIONES**.||||| | + | |
- | ^ 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_seccion|Long|Identificador del registro|Si|0| | + | |
- | |datarecord|ka_ni_centro_costo|Long|Identificador del centro de costo asociado|Si|0| | + | |
- | |datarecord|ss_seccion|String|Descripción de la sección|Si|N/A| | + | |
- | |datarecord|codigo_mempresa|Long|Código de la Empresa (Entorno Multiempresa)|Si|"9999999999"| | + | |
- | ^ 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> | + | |
- | {"token_session": "d715d7c2d82c20e4237149aa58d2e6b391a619150733c59493cb442dbf1a5940"} | + | |
- | <tem:as_config>?</tem:as_config> | + | |
- | <!--Optional:--> | + | |
- | <tem:as_data>{"datarecord":{"ka_nl_seccion":0,"ka_ni_centro_costo":3148,"ss_seccion":"GENERICO_006"}}</tem:as_data> | + | |
- | </tem:ws_insertar> | + | |
- | </soapenv:Body> | + | |
- | </soapenv:Envelope> | + | |
- | </code>|||||| | + | |
- | ^ Retorno ^^^^^^ | + | |
- | |<code html> | + | |
- | <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> | + | |
- | </code>|||||| | + | |
- | + | ||
- | + | ||
- | ===== Contrato de Consumo: WS_ACTUALIZAR ===== | + | |
- | + | ||
- | ^ Contrato de Consumo ^^^^^^ | + | |
- | ^ Operación^Objetivo ^^^^^ | + | |
- | ^ws_actualizar|actualiza un registro en la tabla **NOMINA.SECCIONES**.||||| | + | |
- | ^ 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 actualizar|Si|1| | + | |
- | |datarecord|ka_nl_seccion|Long|Identificador del registro a actualizar|Si|N/A| | + | |
- | |datarecord|ss_seccion|String|Descripción del motivo de retiro|Si|N/A| | + | |
- | |datarecord|codigo_mempresa|Long|Código de la Empresa (Entorno Multiempresa)|Si|"9999999999"| | + | |
- | ^ 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| | + | |
- | |ws_actualizarResult|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> | + | |
- | {"token_session": "d715d7c2d82c20e4237149aa58d2e6b391a619150733c59493cb442dbf1a5940"} | + | |
- | <tem:as_config>?</tem:as_config> | + | |
- | <!--Optional:--> | + | |
- | <tem:as_data> | + | |
- | {"datarecord":{"ka_nl_seccion":2213,"ss_seccion":"GENERICO_006_3"}} | + | |
- | </tem:as_data> | + | |
- | </tem:ws_insertar> | + | |
- | </soapenv:Body> | + | |
- | </soapenv:Envelope> | + | |
- | </code>|||||| | + | |
- | ^ Retorno ^^^^^^ | + | |
- | |<code html> | + | |
- | <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> | + | |
- | </code>|||||| | + | |
+ | ===== Contrato de Servicios ===== | ||
- | ===== Validaciones ===== | + | [[http://adacsc.co:1443/svn/repository/ADA/SICOF/SICOF%20PBtoWS/Documentos/Contratos%20de%20Servicios/Backend/05_Nomina/crud/secciones |
+ | |Maestro Secciones - 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 eliminacion 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]] |