Wiki

Has cargado una revisión vieja del documento! Si la guardas crearás una versión nueva con estos datos.

====== Maestro Tipos de Centros de Costos ======

===== Definición =====

===== Contrato de Consumo: WS_LISTAR =====

^  Contrato de Consumo  ^^^^^^^^
^  Operación^Objetivo  ^^^^^^^
^ws_listar|lista los registros actuales de la tabla **NOMINA.TIPOS_NOMINA**.|||||||
^  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|
|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 sentencia 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((Nombre del Parametro Contenedor del String en Formato Json))^Atributo(())^Tipo Dato^Descripción^Requerido^Valor por Defecto((Los valores por defecto son asumidos por el consumo interno))^GUI((Esta propiedad indica que el campo es visible "Si" en la interfaz gráfica del Front-End))^PK((Indica que el campo hace parte de la clave primaria "Si" y debe enviarse en las operaciones CRUD))^
|ws_listarResult|return_code|String|Cadena que representa el código de retorno del consumo 1: OK -1: Error|Si|N/A|No|No|
|ws_listarResult|return_user_message|String|Cadena que representa el mensaje de usuario de retorno del consumo|Si|N/A|Si|No|
|ws_listarResult|return_technical_message|String|Cadena que representa el mensaje técnico de retorno del consumo|Si|N/A|No|No|
|ws_listarResult|return_object|String|Cadena que representa el objeto de retorno del consumo|No|N/A|N/A|No|
|return_object|alert|String|Cadena que representa el array de mensajes de alerta de retorno del consumo|No|N/A|N/A|No|
|alert|msg|String|Cadena que representan una posición del array de mensajes de alerta de retorno del consumo|No|N/A|Si|No|
|return_object|columncount|Long|Valor que representa la cantidad de columnas de la data devuelve en el objeto de consumo|No|N/A|No|No|
|return_object|rowcount|Long|Valor que representa la cantidad de filas totales de la data que representa el objeto de consumo|No|N/A|Si|No|
|return_object|tipo_ccosto|Array Object|Array de Objetos que representan la data que devuelve el consumo|No|N/A|N/A|No|
|tipo_ccosto|ka_nl_tipo_nomina|Long|Identificador del registro|Si|N/A|No|Si|
|tipo_ccosto|s_descripcion|String|Descripción del tipo de centro de costo|Si|N/A|Si|No|
|tipo_ccosto|usuario_empresa|String|usuario de módulo|Si|N/A|No|No|
|tipo_ccosto|codigo_mempresa|Long|Código de la Empresa (Entorno Multiempresa)|Si|"9999999999"|No|No|
|tipo_ccosto|liquida_por_puntos|String|Identifica que forma de liquidar tiene el tipo|Si|N/A|Si|No|
|tipo_ccosto|rnum|Long|Identificador de fila del registro|Si|Auto incremental por fila|Si|No|
|ws_listarResult|return_response_date|Date|Fecha y hora de ejecución del consumo|Si|fecha y hora del sistema|No|No|
|ws_listarResult|return_execution_time|Long|Tiempo de ejecución del consumo en milisegundos|Si|0|No|No|

===== 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>
         
         <tem:as_config>
           { "token_session": "75fc8798d624646a88ee12db006e5a98a477683c030e0f1f21fbaca8058d5404" }
         </tem:as_config>
         
         <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: orderby"
            }
        ],
        "dataobject": "dsg_core_dual",
        "columncount": 6,
        "tipo_ccosto": [
            {
                "ka_nl_tipo_nomina": 3,
                "s_descripcion": "NOMINA ADMINISTRATIVOS PLANTA",
                "usuario_empresa": "NOMINA",
                "codigo_mempresa": "9999999999",
                "liquida_por_puntos": "N",
                "rnum": 1
            }
        ],
        "rowcount": 15
    },
    "return_response_date": "25/06/2019 21:47:07",
    "return_execution_time": "219"
}</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_NOMINAS**.|||||
^  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_nomina|Long|Identificador del registro|Si|0|
|datarecord|s_descripcion|String|Descripción del tipo de centro de costo|Si|N/A|
|datarecord|liquida_por_puntos|String|Identifica que forma de liquidar tiene el tipo|Si|N/A|
|datarecord|usuario_empresa|String|usuario de módulo|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>
         
         <tem:as_config>
         { "token_session": "75fc8798d624646a88ee12db006e5a98a477683c030e0f1f21fbaca8058d5404"}
         </tem:as_config>
         
         <tem:as_data>
         {"datarecord":{"ka_nl_tipo_nomina":19,"s_descripcion":"CCOSTO_GENERICO_006_2",
		 "liquida_por_puntos":"S","usuario_empresa":"NOMINA","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": "25/06/2019 21:19:17",
    "return_execution_time": "226"
}</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.TIPOS_NOMINAS**.|||||
^  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_tipo_nomina|Long|Identificador del registro|Si|0|
|datarecord|s_descripcion|String|Descripción del tipo de centro de costo|Si|N/A|
|datarecord|liquida_por_puntos|String|Identifica que forma de liquidar tiene el tipo|Si|N/A|
|datarecord|usuario_empresa|String|usuario de módulo|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_actualizar>
         
         <tem:as_config>
         { "token_session": "75fc8798d624646a88ee12db006e5a98a477683c030e0f1f21fbaca8058d5404"}
         </tem:as_config>
         
         <tem:as_data>
         {"datarecord":{"ka_nl_tipo_nomina":17,"s_descripcion":"BCCOSTO_GENERICO_006_2",
		 "liquida_por_puntos":"S"}}
         </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": "25/06/2019 21:17:54"
}</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_NOMINA**.|||||
^  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_nomina|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_ccosto|Array Object|Array de Objetos que representan la data que devuelve el consumo|No|N/A|
|tipo_ccosto|ka_nl_tipo_nomina|Long|Identificador del registro|Si|N/A|
|tipo_ccosto|s_descripcion|String|Descripción del tipo de centro de costo|Si|N/A|
|tipo_ccosto|usuario_empresa|String|usuario de módulo|Si|N/A|
|tipo_ccosto|codigo_mempresa|Long|Código de la Empresa (Entorno Multiempresa)|Si|"9999999999"|
|tipo_ccosto|liquida_por_puntos|String|Identifica que forma de liquidar tiene el tipo|Si|N/A|
|tipo_ccosto|rnum|Long|Identificador de fila del registro|Si|Auto incremental por fila|
|ws_consultarResult|return_response_date|Date|Fecha y hora de ejecución del consumo|Si|fecha y hora del sistema|
|ws_consultarResult|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>
         
         <tem:as_config>
         { "token_session": "75fc8798d624646a88ee12db006e5a98a477683c030e0f1f21fbaca8058d5404" }
         </tem:as_config>
         
         <tem:as_data>
         {"ka_nl_tipo_nomina":12}
         </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": {
        "dataobject": "dsf_tipo_ccosto_only_one",
        "columncount": 5,
        "tipo_ccosto": [
            {
                "ka_nl_tipo_nomina": 12,
                "s_descripcion": "ADMINISTRATIVOS",
                "usuario_empresa": "NOMINA",
                "codigo_mempresa": "9999999999",
                "liquida_por_puntos": "N"
            }
        ],
        "rowcount": 13
    },
    "return_response_date": "25/06/2019 21:16:57",
    "return_execution_time": "240"
}</ws_consultarResult>
      </ws_consultarResponse>
   </soap:Body>
</soap:Envelope>
</code>||||||

===== Validaciones =====

Resumen de la edición

Wiki

Herramientas de usuario

Herramientas del sitio

Herramientas de la página