Contenido
API de sincronización de dispositivos
Servicio: /api/v1/audit/refresh/log Resultado: JSON
Este API despliega la información histórica de tiempos de dispositivos y sincronización de datos de usuarios con el servidor, indicando la diferencia en tiempo del dispositivo vs. el servidor (Por si hay cambios).
Refresh_time: Fecha/Hora de última sincronización
Device_time: Fecha/Hora en el dispositivo
Server_ahead: Hora/minutos/segundos/ milisegundos de diferencia entre hora del servidor y hora del dispositivo.
deviceid: Identificador del dispositivo para KontrolId, incluye nombre del skin y el id.
appversion: Número de la versión móvil con la que cuenta el dispositivo. (A partir de la versión móvil 6.515).
Lon, lat: Longitud/ Latitud donde ocurrió la sincronización (Si estaba activado GPS)
https://api.kontrolid.com/api/v1/audit/refresh/log
Parámetros
Los parámetros son pares variable=valor que se especifican en la url adicionando un ? al final de la misma y que modifican los registros que se muestran en la consulta. Cuando se aplican varios parámetros o filtros, estos se separan con &.
user
Recupera los datos del usuario especificado
start
Recupera los datos desde el id especificado.
limit
El número de registros a recuperar. El orden es: Los últimos primero.
tz
Define una Zona Horaria para ajustar las fechas. Si no se ha definido la zona horaria es tomada como UTC + 00 o GMT.
geojson
Establecido como “yes”, los datos son retornados en formato GEOJSON en vez del JSON estándar. Esto es útil cuando se usan análisis extensivos basados en datos geográficos. Consulte wikipedia para un entendimiento rápido y la especificación GeoJson.
API de auditoría de respuestas
Servicio: /api/v1/audit/ Resultado: JSON
Este API despliega los servicios disponibles para recuperar los datos de auditoria de repuestas por formulario. Devuelve los enlaces aún cuando no se haya definido auditoría de los mismos formularios.
API de auditoría de respuestas detallado por formulario
Servicio: /api/v1/audit/(Ident Formulario) Resultado: GeoJSON
Este API despliega el detalle de la auditoría de respuestas por formulario. El ident o identificador del formulario lo encuentra en la lista de formularios o desde el API anterior que devuelve los enlaces. Devuelve un objeto GeoJSON por cada pregunta e incluye el tiempo en milisegundos que el usuario necesitó para responder la pregunta y las coordenadas GPS donde la pregunta fue respondida. Estos datos sólo son retornados si al formulario se le han activado en ajustes: Auditoría de Respuestas y Registrar ubicación de respuestas.
Parámetros
start
Recupera los datos desde la llave primaria.
limit
El número de registros a recuperar.
sort
Permite ordenar los datos por una pregunta. Se debe especificar sin comillas. Ej: sort=Pregunta
dirn
Dirección del ordenamiento “asc” (Ascendente – Valor por defecto) o “desc” (Descendente)
form
Nombre del grupo de repetición (subformulario) para recuperar los datos del mismo.
start_parkey
Llave de la tabla principal (main) desde donde empezar a traer los registros. Útil solamente en datos de subformularios o grupos de repetición y necesita limitar los datos a uno o más registros.
parkey
Significa parent key (llave del registro padre). Se usa cuando se consulta los datos de un subformulario asociados al registro padre en tabla principal (main).
hrk
Restringe los datos a una llave específica
bad
Opciones: yes, only o none. Si es definido como yes incluye los registros marcados como erróneos.
tz
Define una Zona Horaria para ajustar los metadatos de fechas. Si no se ha definido la zona horaria es tomada como UTC + 00 o GMT. Se refiere a la misma zona horaria especificada anteriormente.
API de auditoría de que tareas y formularios debería recibir (ver) un usuario
Servicio: /surveyKPI/myassignments Resultado: JSON
Este API simula la información que debe recibir un dispositivo móvil o web respecto a los formularios y tareas de un usuario.
Nota: Para usar este api y ver un usuario específico el llamado debe hacerse con el usuario destino.
En el siguiente ejemplo usamos el usuario api/api y nos trae la siguiente información:
- Data (Tareas). Si hay la muestra de primero con todo el detalle:
2. Forms (formularios) con sus ident(id), name (nombre), versión, y Project (Project)
3. La parte final corresponde a Settings (ajustes) según se hayan definido para todos los dispositivos en ajustes de aplicación móvil
