Kimkëlen API

API Kimkëlen provee servicios para obtener información de estudiantes y tutores del sistema de gestión integrada de colegios secundarios realizado por el CeSPI perteneciente a la Universidad Nacional de La Plata UNLP. Los servicios permitirán acceso de consulta a inasistencias, sanciones disciplinarias y calificaciones.

Instalación

Editar la configuración de la base de datos

La configuración de la base de datos se realiza por medio del archivo database.yml. Se provee este archivo a modo de ejemplo en el directorio config/

cp config/database.yml-sample config/database.yml

Edite este archivo según la configuración de su entorno. Debe especificar el dsn (nombre de la base de datos, host, usuario de la BBDD y contraseña de la BBDD)

Ejemplo de database.yml

....
development:
  database: alumnos
  adapter:  mysql2
  encoding: utf8
  pool:     5
  username: user
  password: beSAfePlease
  host:     localhost

Invocación de servicios

Ejemplos de invocación con cURL en servidor local.

Obtener alumno

 curl -X GET http://localhost:3000/api/v1/students/:id

Obtener tutor

curl -X GET http://localhost:3000/api/v1/tutors/:id

Obtener años lectivos de un alumno

curl -X GET http://localhost:3000/api/v1/students/:id/school_years

Obtener años lectivos cargados en el sistema

curl -X GET http://localhost:3000/api/v1/school_years

Obtener años lectivos cargados en el sistema

curl -X GET http://localhost:3000/api/v1/students/:id/school_years

Obtener calificaciones de un alumno para un año lectivo

curl -X GET http://localhost:3000/api/v1/students/:id/marks/:school_year

Obtener inasistencias de un alumno para un año lectivo

curl -X GET http://localhost:3000/api/v1/students/:id/absences/:school_year

Obtener sanciones disciplinarias de un alumno para un año lectivo

curl -X GET http://localhost:3000/api/v1/students/:id/disciplinary_sanctions/:school_year