TOKEN = 'x-api-key'
## Registrar nuevo usuario
## POST /registrar
# Cuerpo
matricula: string(15) requerido
apPaterno: string(50) requerido
apMaterno: string(50) requerido
nombre: string(100) requerido
correoElectronico: string(100) requerido
# Respuestas http
400: Peticion Mal Formada
500: Error de Servidor
409: Conflicto
201: Creado ## Autorizar acceso
## POST /autorizar
# Cuerpo
correoElectronico: string(100) requerido
password: string(150) requerido
# Respuestas HTTP
400: Peticion Mal Formada
500: Error de Servidor
404: Recurso no encontrado
401: No autorizado
200: Ok ## Ver Usuarios
## GET /usuarios
# Cabeceras
x-api-key: TOKEN
# Respuestas HTTP
500: Error de Servidor
200: Ok ## Ver Usuario por :id
## GET /usuarios/:id
# Cabeceras
x-api-token: TOKEN
# Respuestas HTTP
500: Error de Servidor
404: Recurso no encontrado
200: OK ## Actualizar usuario por :id
## PATCH /usuarios/:id
# Cabeceras
x-api-token: TOKEN
# Cuerpo
matricula: string(15)
apPaterno: string(50)
apMaterno: string(50)
nombre: string(100)
correoElectronico: string(100)
rol: enum('profesor', 'estudiante')
password: string(150)
# Respuestas HTTP
500: Error de Servidor
400: Peticion Mal Formada
200: Ok ## Eliminar usuario por :id
## DELETE /usuarios/:id
# Cabeceras
x-api-token: TOKEN
# Respuestas HTTP
404: Recurso no encontrado
500: Error de Servidor
200: Ok ## Obtener lista de Instituciones registradas
## GET /catalogos/instituciones
# Cabeceras
x-api-token: TOKEN
# Respuestas HTTP
500: Error de Servidor
200: Ok ## Obtener lista de facultades por institucion
## GET /catalogos/instituciones/:nombreInstitucion/facultades
# Cabeceras
x-api-token: TOKEN
# Respuestas HTTP
500: Error de Servidor
200: Ok ## Enlistar todos los salones registrados
## GET /salones
# Cabeceras
x-api-token: TOKEN
# Respuestas HTTP
500: Error de Servidor
200: Ok ## Obtener todos los salones por facultad
## GET /salones/:nombreFacultad
# Cabeceras
x-api-token: TOKEN
# Respuestas HTTP
500: Error de Servidor
200: Ok ## Enlistar todos los Cursos
## GET /cursos
# Query
?hoy [true | false]
# Cabeceras
x-api-token: TOKEN
# Respuestas HTTP
500: Error de Servidor
200: Ok ## Obtener un curso por :id
## GET /cursos/:id
# Cabeceras
x-api-token: TOKEN
# Respuestas HTTP
400: Peticion Mal Formada
500: Error de Servidor
200: Ok ## Crear nuevo Curso
## POST /cursos
# Cabeceras
x-api-token: TOKEN
# Cuerpo
curso:
matricula: string(15) requerido
nombre: string(255) requerido
inicio: date requerido YYYY-mm-dd
fin: date requerido YYYY-mm-dd
salon:
id: idSalon NOTA: Si envias este parámetro, el resto de los parámetros de salón serán ignorados.
codigo: string(15) requerido
edificio: string(15) requerido
facultad: string(100) requerido
institucion: string(100) requerido
horarios[]:
dia: enum<'L','A','M','J','V','S','D'> requerido
hora: time requerido
# Respuestas HTTP
400: Peticion Mal Formada
500: Error de Servidor
201: Creado ## Actualizar curso por :id
## PATCH /cursos/:id
# Cabeceras
x-api-token: TOKEN
# Cuerpo
curso:
matricula: string(15)
nombre: string(255)
inicio: date YYYY-mm-dd
fin: date YYYY-mm-dd
salon:
codigo: string(15)
edificio: string(15)
facultad: string(100)
institucion: string(100)
horarios[]:
dia: enum<'L','A','M','J','V','S','D'>
hora: time
# Respuestas HTTP
400: Peticion Mal Formada
500: Error de Servidor
404: Recurso no encontrado
200: Ok ## Eliminar Curso por :id
## DELETE /cursos/:id
# Cabeceras
x-api-token: TOKEN
# Respuestas HTTP
500: Error de Servidor
200: OK ## Obtener todas las actividades de un curso por :id
## GET /cursos/:id/actividades
# Cabeceras
x-api-token: TOKEN
# Respuestas HTTP
500: Error de Servidor
200: Ok ## Crear nueva Actividad en un Curso por :id
## POST /cursos/:id/actividades
# Cabeceras
x-api-token: TOKEN
# Cuerpo
indice: string(10) requerido
nombre: string(50) requerido
descripcion: string requerido
# Respuestas HTTP
400: Peticion Mal Formada
500: Error de Servidor
201: Creado ## Actualizar Actividad con :idActividad asignada a un Curso por :id
## PATCH /cursos/:id/actividades/:idActividad
# Cabeceras
x-api-token: TOKEN
# Cuerpo
indice: string(10)
nombre: string(50)
descripcion: string
# Respuestas HTTP
500: Error de Servidor
404: Recurso no encontrado
200: Ok ## Obtener Asistentes de un Curso por :id
## GET /cursos/:id/asistentes
# Cabeceras
x-api-token: TOKEN
# Respuestas HTTP
500: Error de Servidor
200: Ok ## Registrar nuevo Asistente a un Curso por :id
## POST /cursos/:id/asistentes
# Cabeceras
x-api-token: TOKEN
# Respuestas HTTP
500: Error de Servidor
409: Conflicto
201: Creado ## Obtener asistencias del Curso pod :id
## GET /cursos/:id/asistencias
# Cabeceras
x-api-token: TOKEN
# Respuestas HTTP
500: Error de Servidor
200: Ok ## Eliminar asistencia del Curso por :id
## DELETE /cursos/:id/asistencias/:idAsistencia
# Cabeceras
x-api-token: TOKEN
# Respuestas HTTP
404: Recurso no encontrado
500: Error de Servidor
200: Ok ## Registrar asistencia a un Estudiante por Curso
## POST /cursos/:id/asistencias
# Cabeceras
x-api-token: TOKEN
# Cuerpo
asistente: idAsistente requerido
fecha: datetime requerido YYYY-mm-dd HH:ii:ss