Contenido
Servicio: /api/v1/submissions Resultado: JSON
Trae todos los datos enviados (Subidos al servidor) de la organización a la que pertenece el usuario que hace el llamado. Se muestran en orden inverso de más reciente a más antiguo. Como el volumen de datos es muy elevado, es importante aplicar los filtros o parámetros adecuados para que no bloquee tu consulta.
Las llaves primarias mostradas (prikey) son diferentes a las que ve en Análisis en la vista (asunto) de datos de formulario. Las llaves primarias corresponden a las que visualiza como Récord en Análisis en la vista (asunto) de Actividad del Usuario:
Ejemplo:
https://api.kontrolid.com/api/v1/submissions
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 &.
limit
El número de registros a recuperar. Como los datos se muestran primero los últimos, si define limit=5, verá los últimos 5 registros.
https://api.kontrolid.com/api/v1/submissions?limit=5
start
Recupera los datos desde la llave primaria especificada sin incluirlos. Ejemplo, si se quiere recuperar a partir de la llave primaria # 1000 con limit=2, sólo se muestran los registros 999 y 998. Este parámetro es muy útil para “paginar” los registros recibidos en bloques partiendo del último registro obtenido.
https://api.kontrolid.com/api/v1/submissions?start=858566&limit=3
links
Establecido como “true”, incluye los enlaces correspondientes a los datos de cada registro, reporte PDF y edición del formulario web:
https://api.kontrolid.com/api/v1/submissions?start=858566&limit=2&links=true
stopat
Establece la llave primaria a la cual debe excluirse los datos. Los datos de la llave especificada no son retornados. Este parámetro es útil cuando se leen los datos como un “feed” (fuente). Por ejemplo si se llama el servicio y el último registro tiene un prikey de 1001, entonces si se llama el servicio nuevamente con stopat=1001, sólo se traerán los registros nuevos enviados.
https://api.kontrolid.com/api/v1/submissions?stopat=858560
user
Establece el nombre de usuario que registró los datos:
https://api.kontrolid.com/api/v1/submissions?user=api
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.
survey_ident
Devuelve los datos de un formulario especifico, empleando el identificador del formulario.
https://api.kontrolid.com/api/v1/submissions?survey_ident=s657_15391
