Documentación API.

¿Cómo obtener el test?

Descripción

Esta función es la encargada de retornar mediante un código el estado en el que se encuentra el Agente de servicios web.

Retorna un string con el código y el estado del Agente de Servicios web.

Seguridad

Aplica todas las configuraciones de seguridad de datos y de seguridad de acciones de ContaPyme / AgroWin.

Compatibilidad de la API

Función disponible desde ContaPyme/AgroWin Versión 4 - Release 7.

Requisitos

Debe haber realizado el logueo en el agente a través de la función GETAUTH().

Parámetros

Nombre parámetro	Tipo	Descripción	Ejemplo
dataJSON	JSON	Es función no recibe ningún parámetro.
controlkey	Varchar	Corresponde al keyagente obtenido en el logueo (requerido).	"564654"	"222912"
iapp	Varchar	Código que identifica a la aplicación que interactúa con el Agente (requerido)	"1068"
random	Varchar	Cadena aleatoria que se crea en el lado del cliente, esto con el fin de que las peticiones no sean cacheadas por el navegador Internet Explorer (para aplicaciones web). (Opcional).	"54654"

Ver documentación de la petición por GET.

{ "result": [ "4|AGENTESERVICIOSWEB1 conectado al área de trabajo." ] }

Nombre parámetro	Tipo	Descripción
respuesta	JSON	Contiene el código y estado del Agente separados por el caracter "\|". Los estados en los que se puede encontrar un Agente son: 1\|Servicio detenido. 2\|Servicio en ejecución. 3\|Servicio conectándose al área de trabajo. 4\|Servicio conectado al área de trabajo. 5\|Agente no conectado al área de trabajo.

Para esta función se pueden presentar las siguientes eventualidades o errores:

0: Error en la aplicación, errores no controlados.
1: Mensaje que le indica al usuario que debe corregir errores (errores controlados).
40: Usuario no logueado.
130: No se ingresó el parámetro "X".

Un ejemplo del JSON que retorna la función cuando se genera una eventualidad es el siguiente:

{ "result":[{ "encabezado":{"resultado":"false","imensaje":"40","mensaje":"Usuario no logueado."}, "respuesta":{"datos":""} }] }