Wiki

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

====== Maestro Tipos Identificación ======

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

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

^  Contrato de Consumo  ^^^^^^
^  Operación^Objetivo  ^^^^^
^ws_listar|lista los registros actuales de la tabla **TESORE01.NATURALEZA_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|naturaleza|Array Object|Array de Objetos que representan la data que devuelve el consumo|No|N/A|
|naturaleza|codigo|String|Código de la Identificación del Registro|Si|N/A|
|naturaleza|descripcion|String|Nombre dado al Tipo Naturaleza|Si|N/A|
|naturaleza|estado|String|Identificador para indicar si esta activo o no|Si|N/A|
|naturaleza|usuario_empresa|String|Código del Usuario(Entorno Multiempresa)|Si|"NOMINA"|
|naturaleza|codigo_mempresa|String|Código de la Empresa(Entorno Multiempresa)|Si|"9999999999"|
|naturaleza|naturaleza|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>
         
         <tem:as_config>{"token_session": "ae2fd263bbb6de1cc21ef7a60aec69c63c5ee07db8d85a289bf41f38e140c113"}</tem:as_config>
         
         <tem:as_data>{"crud_controller": "n_cst_controller_naturaleza", "crud_name":"NATURALEZA", "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": [
            {
                "codigo": 6,
                "descripcion": "PRUEBAS 2",
                "estado": "A",
                "usuario_empresa": "PRESUP01",
                "codigo_mempresa": "9999999999",
                "rnum": 1
            }
        ],
        "rowcount": 6
    },
    "return_response_date": "05/07/2019 13:54:09",
    "return_execution_time": "359"
}</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 **TESORE01.NATURALEZA_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|codigo|String|Código de la Identificación del Registro|Si|N/A|
|datarecord|descripcion|String|Nombre dado al Tipo Naturaleza|Si|N/A|
|datarecord|estado|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|codigo_mempresa|String|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": "ae2fd263bbb6de1cc21ef7a60aec69c63c5ee07db8d85a289bf41f38e140c113" }
         </tem:as_config>
         
         <tem:as_data>{"crud_controller": "n_cst_controller_naturaleza", "crud_name":"NATURALEZA", "crud_operation":"CREATE", "crud_interface":"CREATE", "datarecord":{"codigo":9, "descripcion":"ciro", "estado":"A", "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": "05/07/2019 19:57:33",
    "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 **TESORE01.NATURALEZA_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|codigo|String|Código de la Identificación del Registro|Si|N/A|
|datarecord|descripcion|String|Nombre dado al Tipo Naturaleza|Si|N/A|
|datarecord|estado|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|codigo_mempresa|String|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|

===== 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": "ae2fd263bbb6de1cc21ef7a60aec69c63c5ee07db8d85a289bf41f38e140c113" }
         </tem:as_config>
         
         <tem:as_data>{"crud_controller": "n_cst_controller_naturaleza", "crud_name":"NATURALEZA", "crud_operation":"UPDATE", "crud_interface":"UPDATE", "datarecord":{"codigo":9, "descripcion":"PRUEBAS", "estado":"A", "usuario_empresa":"NOMINA", "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:01:10"
}</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 **TESORE01.NATURALEZA_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|codigo|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|naturaleza|Array Object|Array de Objetos que representan la data que devuelve el consumo|No|N/A|
|naturaleza|codigo|String|Código de la Identificación del Registro|Si|N/A|
|naturaleza|descripcion|String|Nombre dado al Tipo Naturaleza|Si|N/A|
|naturaleza|estado|String|Identificador para indicar si esta activo o no|Si|N/A|
|naturaleza|usuario_empresa|String|Código del Usuario(Entorno Multiempresa)|Si|"NOMINA"|
|naturaleza|codigo_mempresa|String|Código de la Empresa(Entorno Multiempresa)|Si|"9999999999"|
|naturaleza|naturaleza|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>
         
         <tem:as_config>{ "token_session": "ae2fd263bbb6de1cc21ef7a60aec69c63c5ee07db8d85a289bf41f38e140c113" }</tem:as_config>
         
         <tem:as_data>{"crud_controller": "n_cst_controller_naturaleza", "crud_name":"NATURALEZA", "crud_operation":"READ", "crud_interface":"READ_ONLY_ONE", "codigo":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"
            }
        ],
        "naturaleza": [
            {
                "codigo": 1,
                "descripcion": "Natural",
                "estado": "A",
                "usuario_empresa": "NOMINA",
                "codigo_mempresa": "9999999999",
                "rnum": 1
            }
        ],
        "rowcount": 7
    },
    "return_response_date": "05/07/2019 14:04:50",
    "return_execution_time": "203"
}</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