Saltar a contenido

GET /api/v2/incident/my

Obtiene el listado de incidencias de fichaje del empleado autenticado.

Autenticación

Authorization: Bearer <token>

Query Parameters

Parámetro Tipo Obligatorio Descripción
status string No Filtrar por estado: open o closed
limit number No Número máximo de incidencias a devolver
offset number No Número de incidencias a saltar (paginación)

Ejemplo de petición

# Obtener todas las incidencias
curl -X GET "$HOST/api/v2/incident/my" \
  -H "Authorization: Bearer $TOKEN"

# Obtener solo incidencias abiertas
curl -X GET "$HOST/api/v2/incident/my?status=open" \
  -H "Authorization: Bearer $TOKEN"

# Con paginación (10 resultados, saltando los primeros 5)
curl -X GET "$HOST/api/v2/incident/my?status=open&limit=10&offset=5" \
  -H "Authorization: Bearer $TOKEN"

Respuesta exitosa (200)

{
  "status": "success",
  "data": {
    "incidents": [
      {
        "id": 123,
        "description": "Descripción de la incidencia",
        "status": "open",
        "reviewStatus": "underReview",
        "incidentType": "general_issue",
        "timeRecordId": 456,
        "employeeId": 40,
        "schoolCourseId": 1,
        "createdAt": "2025-01-15T08:30:00.000Z",
        "updatedAt": "2025-01-15T08:30:00.000Z",
        "Employee": {
          "id": 40,
          "name": "Juan",
          "lastName": "Pérez"
        }
      }
    ],
    "counts": {
      "open": 5,
      "closed": 12
    }
  }
}

Campos de la incidencia

Campo Tipo Descripción
id number ID único de la incidencia
description string Descripción o respuesta del empleado
status string Estado: open o closed
reviewStatus string Estado de revisión: underReview, requiresEmployeeAction
incidentType string Tipo de incidencia
timeRecordId number ID del registro de fichaje asociado
employeeId number ID del empleado
schoolCourseId number ID del curso escolar
createdAt string Fecha de creación (ISO 8601)
updatedAt string Fecha de última actualización (ISO 8601)
Employee object Datos básicos del empleado

Ordenamiento

  • Incidencias abiertas (status=open): Primero las que requieren acción del empleado (requiresEmployeeAction), luego por fecha ascendente (más antiguas primero).
  • Incidencias cerradas (status=closed): Por fecha descendente (más recientes primero).

Errores

Código Mensaje Descripción
400 employeeId missing from token Token inválido o sin employeeId
400 Invalid status. Allowed values: open, closed Valor de status no válido
400 limit must be a positive number Limit debe ser > 0
400 offset must be a number >= 0 Offset debe ser >= 0
401 Unauthorized Token no proporcionado o expirado