Contrato de Consumo |
Operación | Objetivo |
ws_listar | lista los registros actuales de la tabla NOMINA.MOTIVO_RETIRO. |
Parametros de Entrada |
Nombre | Tipo de Datos | Descripcion | Formato Tipo |
as_config | String | Cadena de Configuración del Consumo | Json |
as_data | String | Cadena que contiene los parametros del Consumo | Json |
Definicion Interna |
Parametro Entrada | Atributo | Tipo Dato | Descripción | Requerido | Valor por Defecto1) |
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 |
Ejemplo de Consumo - 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>
|
Parametros de Retorno |
Nombre | Tipo de Datos | Descripcion | Formato Tipo |
ws_listarResult | String | Cadena de retorno del Consumo | Json |
Definicion Interna |
Parametro Entrada | Atributo | Tipo Dato | Descripción | Requerido | Valor por Defecto2) |
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 | motivo_retiro | Array Object | Array de Objetos que representan la data que devuelve el consumo | No | N/A |
motivo_retiro | ka_nl_motivo_retiro | Long | Identificador del registro | Si | N/A |
motivo_retiro | ss_descripcion | Long | Descripción del motivo de retiro | Si | N/A |
motivo_retiro | codigo_mempresa | Long | Código de la Empresa (Entorno Multiempresa) | Si | “9999999999” |
motivo_retiro | 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 |
Ejemplo de Consumo - Salida |
<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"
}
],
"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>
|