Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/miagv/PlataformaEduca/llms.txt

Use this file to discover all available pages before exploring further.

All endpoints under /api/coordinador require a valid JWT token issued to a user with the COORDINADOR role. Requests that carry a token for a different role receive 403 Forbidden. Requests with a missing or invalid token receive 401 Unauthorized. Include the token in the Authorization header of every request as shown in the examples below.

Authentication

Authorization
string
required
Bearer token from /api/auth/login. The authenticated user must have the COORDINADOR role.

Returns platform-wide aggregate counts for users, courses, grade levels, and teacher assignments. Useful for building a coordinator overview screen.No request parameters.

Response

totalUsuarios
integer
Total number of registered users across all roles.
totalCursos
integer
Total number of courses in the catalog.
totalGrados
integer
Total number of academic grade levels configured on the platform.
totalAsignaciones
integer
Total number of teacher-course assignments that have been created.

Example response

{
  "totalUsuarios": 4,
  "totalCursos": 2,
  "totalGrados": 2,
  "totalAsignaciones": 1
}

curl

curl --request GET \
  --url https://your-api-host/api/coordinador/dashboard \
  --header "Authorization: Bearer YOUR_TOKEN"
Assigns a teacher (Docente) to a course (Curso) within a specific classroom (Aula) and academic period (Periodo). All four references must point to existing records; the API returns the fully created AsignacionDocente object including the generated id.

Request body

docente
object
required
Reference to an existing Docente record. Provide only the id.
{ "id": 1 }
curso
object
required
Reference to an existing Curso record. Provide only the id.
{ "id": 1 }
aula
object
required
Reference to an existing Aula record. Provide only the id.
{ "id": 1 }
periodo
object
required
Reference to an existing Periodo record. Provide only the id.
{ "id": 1 }

Example request

{
  "docente": { "id": 1 },
  "curso": { "id": 1 },
  "aula": { "id": 1 },
  "periodo": { "id": 1 }
}

curl

curl --request POST \
  --url https://your-api-host/api/coordinador/asignar \
  --header "Authorization: Bearer YOUR_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "docente": { "id": 1 },
    "curso": { "id": 1 },
    "aula": { "id": 1 },
    "periodo": { "id": 1 }
  }'
Returns all Grado records configured on the platform. Each record represents an academic grade level with an optional section label.

Response

id
integer
Unique identifier for the grade level.
nombre
string
Human-readable grade level name, for example "1ro Secundaria".
seccion
string
Section label within the grade, for example "A".

Example response

[
  { "id": 1, "nombre": "1ro Secundaria", "seccion": "A" },
  { "id": 2, "nombre": "2do Secundaria", "seccion": "B" }
]

curl

curl --request GET \
  --url https://your-api-host/api/coordinador/grados \
  --header "Authorization: Bearer YOUR_TOKEN"
Returns all AsignacionDocente records. Each record includes the full nested Docente, Curso, Aula, and Periodo objects, giving a complete view of every teacher-course-classroom-period combination.

curl

curl --request GET \
  --url https://your-api-host/api/coordinador/asignaciones \
  --header "Authorization: Bearer YOUR_TOKEN"
Returns all Aula records. Use this endpoint to populate classroom selectors when creating a new teacher assignment.

Response

id
integer
Unique identifier for the classroom.
nombre
string
Classroom name, for example "Aula 101".
capacidad
integer
Maximum student capacity for the classroom.
ubicacion
string
Physical location description, for example "Pabellón A".

Example response

[
  { "id": 1, "nombre": "Aula 101", "capacidad": 30, "ubicacion": "Pabellón A" },
  { "id": 2, "nombre": "Aula 202", "capacidad": 25, "ubicacion": "Pabellón B" }
]

curl

curl --request GET \
  --url https://your-api-host/api/coordinador/aulas \
  --header "Authorization: Bearer YOUR_TOKEN"

Error responses

StatusCause
401 UnauthorizedThe Authorization header is missing or the token is expired or invalid.
403 ForbiddenThe token is valid but the authenticated user does not have the COORDINADOR role.

Build docs developers (and LLMs) love