¿Cómo establecer las cuentas favoritas?
SetCuentasFavoritas (datajson, controlkey, iapp, random) : json

Descripción

Esta función es la encargada de registrar las cuentas favoritas de un usuario en la base de datos. Se utiliza tanto para registrar cuentas nuevas como para modificar las cuentas ya asociadas a favoritos.

Resultado

Retorna un Json con la confirmación de la asignación de cuentas favoritas.
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.

Petición

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

Json que contiene en su interior toda la información de la cuenta que se asignará como favorita la siguiente estructura.

idato: Identificador del registro, cuando se está asignando una cuenta a favoritos no se debe enviar nada, pero cuando se está modificando se debe enviar el respectivo código que se obtuvo del agente. (opcional)

nombre: Nombre que se asigna a la cuenta favorita. (requerido).

categoria: Nombre de la categoría a la que pertenece la cuenta o cuentas favoritas. (requerido)

cuentas: Arreglo que contiene el código de la cuenta o cuentas que se agregarán a favoritos.
(requerido)

orden: Número que permite especificar el orden en que se visualizará el favorito en el listado de favoritos.

iclasifop: Especifica la clase de operación por la cual se filtrará el saldo de la cuenta favorita.

ccs: Arreglo que contiene los centros de costos que se utilizaran para filtrar el saldo de la cuenta favorita.

filtro: Permite especificar un filtro SQL que se aplicará para el cálculo del saldo de la cuenta favorita.

{ "idato": "", "nombre": "Ingresos venta computadores", "categoria": "Ingresos", "cuentas": [ "415530" ], "orden": "2", "iclasifop": "5", "ccs": [ "10102" ] }
controlkey Varchar Corresponde al keyagente obtenido en el logueo (requerido). "564654"
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"
Ejemplo de la ejecución en JavaScript
//Escriba a continuación la URL donde se encuentra su Agente de servicios web de ContaPyme. var URLUbicacion = 'http://local.insoft.co:9000' var URLFuncion = '/datasnap/rest/TEstadosFinancieros/"SetCuentasFavoritas"/'; //Se construye la URL completa la cual es la concatenación de la ubicación y la función var URL = URLUbicacion + URLFuncion; //Invocamos la función que retorna controlKey para modo aprendizaje var controlkey = getControlKey(URLUbicacion); //1001 es el iapp configurado para agente de servicios web de ContaPyme. var iapp = "1001"; //dataJSON: parámetros de entrada para la función var dataJSON = { "idato": "", "nombre": "Ingresos venta computadores", "categoria": "Ingresos", "cuentas": [ "415530" ], "orden": "2", "iclasifop": "5", "ccs": [ "10102" ] }; //Se arma los 4 parámetros de entrada de la funcion var JSONSend ={ "_parameters" : [ JSON.stringify(dataJSON), controlkey, iapp ,"0" ] }; //se constuye objeto para realizar la petición desde JavaScript var xhr = new XMLHttpRequest(); //Se inicializa la solicitud enviando el verbo y la URL a invocar xhr.open("POST",URL); //Se define el evento que se disparará cuando se resuelva la petición xhr.onreadystatechange = function() { //se verifica que la petición se hubiese terminado if (xhr.readyState == 4 && xhr.status == 200) { //se envia la respuesta del servidor para que se imprima imprimirRespuesta(xhr.responseText) } }; //Envía la solicitud adjuntando el JSONSend que contiene los 4 parametros de la función xhr.send(JSON.stringify(JSONSend));
EJECUTAR CODIGO
Ver otros ejemplos en: PHP , JAVA , C# , Visual Basic.net , Visual Basic 6 , Delphi.
Ver documentación de la petición por GET.

Respuesta

JSONIr arriba
{ "result": [ { "encabezado": { "resultado": "true", "imensaje": "", "mensaje": "", "tiempo": "6" }, "respuesta": { "datos": [ "true" ] } } ] }
Descripción del JSON Ir arriba
Nombre parámetro Tipo Descripción
encabezado JSON

Json que contiene en su interior los siguientes datos:

resultado (varchar): Retorna true siempre que la petición se ejecute satisfactoriamente.
imensaje (varchar): Código del mensaje de eventualidad o error en caso de presentarse.
mensaje (varchar): Mensaje de eventualidad o error en caso de presentarse.
tiempo (varchar): Tiempo que se tardó el Agente en resolver la petición, este tiempo está dado en milisegundos.

respuesta JSON

Json que contiene en su interior el arreglo “datos” que se describe a continuación:

datos (varchar): Contiene True cuando la cuenta favorita se asigna satisfactoriamente o False cuando no se pudo asignar.

EventualidadesIr arriba
Para esta función se pueden presentar las siguientes eventualidades o errores: 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":""} }] }

©2016 InSoft Todos los derechos reservados.