Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/iamalexis689725/cole/llms.txt

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

Cole includes a dedicated parent portal that gives parents and guardians read-only access to their children’s academic life. Parents authenticate the same way as any other user — via POST /api/auth/login — and their padre role restricts them to their own linked children’s data. No grading or administrative action is possible from a parent account.

Setting Up a Parent Account

Parent accounts are created and linked to students exclusively by a director. There is no self-registration flow for parents.

Step 1 — Create the Parent Account

curl -X POST https://api.yourschool.com/api/padre-familias \
  -H "Authorization: Bearer <director-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Roberto García",
    "email": "roberto@example.com",
    "password": "securepassword",
    "telefono": "+1 555-0100",
    "ocupacion": "Engineer"
  }'
{
  "message": "Padre de familia creado correctamente",
  "data": {
    "id": 7,
    "user_id": 15,
    "telefono": "+1 555-0100",
    "ocupacion": "Engineer",
    "user": {
      "id": 15,
      "name": "Roberto García",
      "email": "roberto@example.com"
    }
  }
}
Other parent management operations (all require director role):
MethodEndpointDescription
GET/api/padre-familiasList all parent accounts
GET/api/padre-familias/{id}Get a specific parent
PUT/api/padre-familias/{id}Update a parent account
DELETE/api/padre-familias/{id}Delete a parent account
GET/api/padre-familias/{id}/estudiantesList students linked to a parent
After the parent account is created, link one or more enrolled students to it:
curl -X POST https://api.yourschool.com/api/padre-familias/asignar-estudiante \
  -H "Authorization: Bearer <director-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "padre_familia_id": 7,
    "estudiante_id": 101
  }'
{
  "message": "Estudiante asignado correctamente",
  "data": {
    "padre_familia_id": 7,
    "estudiante_id": 101,
    "parentesco": null
  }
}
A parent can be linked to multiple children. Repeat this request for each child.

Parent Authentication

Parents log in using the same endpoint as all other users:
curl -X POST https://api.yourschool.com/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "roberto@example.com",
    "password": "securepassword"
  }'
{
  "token": "3|def456...",
  "user": {
    "id": 15,
    "name": "Roberto García",
    "email": "roberto@example.com",
    "role": "padre"
  }
}
Use the returned token as Authorization: Bearer <token> on all parent portal requests below.

Parent Portal Endpoints

List Linked Children

Returns all students linked to the authenticated parent.
curl -X GET https://api.yourschool.com/api/padre/mis-hijos \
  -H "Authorization: Bearer <padre-token>"
[
  {
    "id": 101,
    "nombre": "Ana García",
    "curso": "7th Grade",
    "paralelo": "A"
  },
  {
    "id": 105,
    "nombre": "Pedro García",
    "curso": "5th Grade",
    "paralelo": "B"
  }
]

All Pending Tasks Across Children

Returns outstanding agenda tasks for all linked children at once — useful for a parent who wants a single view of what needs to be done across the household.
curl -X GET https://api.yourschool.com/api/padre/mis-hijos/agendas \
  -H "Authorization: Bearer <padre-token>"
[
  {
    "id": 30,
    "titulo": "Math Homework – Chapter 4",
    "descripcion": "Exercises 4.1 to 4.10",
    "fecha_entrega": "2024-10-10",
    "estudiante_id": 101,
    "estudiante": "Ana García",
    "estado": "pendiente"
  },
  {
    "id": 31,
    "titulo": "Science Project Draft",
    "descripcion": "First draft of the plant biology project",
    "fecha_entrega": "2024-10-12",
    "estudiante_id": 105,
    "estudiante": "Pedro García",
    "estado": "pendiente"
  }
]
This endpoint requires the agenda module to be active for the tenant. If the module is inactive, the endpoint returns 403 Forbidden.

Agenda Tasks for a Specific Child

Retrieve agenda tasks for a single linked child:
curl -X GET https://api.yourschool.com/api/padre/mis-hijos/101/agendas \
  -H "Authorization: Bearer <padre-token>"
[
  {
    "id": 30,
    "titulo": "Math Homework – Chapter 4",
    "descripcion": "Exercises 4.1 to 4.10",
    "fecha_entrega": "2024-10-10",
    "subject": "Mathematics",
    "estado": "pendiente",
    "archivos": []
  },
  {
    "id": 28,
    "titulo": "Reading Assignment",
    "descripcion": "Read pages 50–75 of the course novel",
    "fecha_entrega": "2024-10-08",
    "subject": "Language Arts",
    "estado": "entregado",
    "archivos": [
      {
        "id": 5,
        "nombre": "reading_notes.pdf",
        "url": "/storage/agenda/reading_notes.pdf"
      }
    ]
  }
]

Child’s Grades and Report Card

Retrieve the full grade report (boleta) for a specific child. The response mirrors the gradebook structure teachers see, filtered to the child’s enrolment.
curl -X GET https://api.yourschool.com/api/padre/mis-hijos/101/notas \
  -H "Authorization: Bearer <padre-token>"
{
  "estudiante": {
    "id": 101,
    "nombre": "Ana García"
  },
  "materias": [
    {
      "subject": "Mathematics",
      "periodos": [
        {
          "periodo": "Q1 – First Quarter",
          "criterios": [
            { "nombre": "Class Participation", "porcentaje": 20, "nota": 88 },
            { "nombre": "Homework",            "porcentaje": 30, "nota": 92 },
            { "nombre": "Midterm Exam",         "porcentaje": 50, "nota": 85 }
          ],
          "promedio": 87.6
        }
      ],
      "promedio_final": 87.6
    },
    {
      "subject": "Language Arts",
      "periodos": [
        {
          "periodo": "Q1 – First Quarter",
          "criterios": [
            { "nombre": "Reading Comprehension", "porcentaje": 40, "nota": 90 },
            { "nombre": "Written Expression",    "porcentaje": 60, "nota": 82 }
          ],
          "promedio": 85.2
        }
      ],
      "promedio_final": 85.2
    }
  ],
  "promedio_general": 86.4
}

Child’s Anecdotal Records

Anecdotal records (anecdotarios) are notes written by teachers documenting significant observations about a student’s behaviour or academic progress.
curl -X GET https://api.yourschool.com/api/padre/mis-hijos/101/anecdotarios \
  -H "Authorization: Bearer <padre-token>"
[
  {
    "id": 12,
    "estudiante_id": 101,
    "profesor": "Prof. Sandra Torres",
    "subject": "Mathematics",
    "descripcion": "Ana showed exceptional problem-solving ability during today's group activity.",
    "fecha": "2024-10-05"
  },
  {
    "id": 9,
    "estudiante_id": 101,
    "profesor": "Prof. Juan Morales",
    "subject": "Language Arts",
    "descripcion": "Reminded Ana to complete reading assignments on time.",
    "fecha": "2024-09-28"
  }
]
This endpoint requires the anecdotario module to be active for the tenant.

Child’s Attendance Records

View the full attendance history for a linked child across all class assignments.
curl -X GET https://api.yourschool.com/api/padre/hijos/101/asistencias \
  -H "Authorization: Bearer <padre-token>"
[
  {
    "fecha": "2024-10-09",
    "subject": "Mathematics",
    "estado": "presente",
    "observacion": null
  },
  {
    "fecha": "2024-10-07",
    "subject": "Mathematics",
    "estado": "falta",
    "observacion": "Parent called in sick"
  },
  {
    "fecha": "2024-10-09",
    "subject": "Language Arts",
    "estado": "tarde",
    "observacion": "Arrived 10 minutes late"
  }
]
This endpoint requires the asistencia module to be active for the tenant.

Portal Endpoint Summary

Children

GET /api/padre/mis-hijosList all students linked to the authenticated parent.

All Pending Tasks

GET /api/padre/mis-hijos/agendasPending agenda tasks across every linked child. Requires agenda module.

Child's Agenda

GET /api/padre/mis-hijos/{estudianteId}/agendasAgenda tasks filtered to one child. Requires agenda module.

Grades & Report Card

GET /api/padre/mis-hijos/{estudiante}/notasFull grade report with weighted averages per subject and period.

Anecdotal Records

GET /api/padre/mis-hijos/{estudiante}/anecdotariosTeacher observations about the child. Requires anecdotario module.

Attendance

GET /api/padre/hijos/{estudiante}/asistenciasFull attendance history across all class sessions. Requires asistencia module.

Build docs developers (and LLMs) love