Salidas y Transportes

Obtener registro de entradas

Obtener el registro de entradas (arribos) de alumnos para un día, opcionalmente filtrado por grupo, sección o grado. El resultado se limita a los grupos autorizados del usuario de API.

Request
query Parameters
date
string^[0-9]{2}/[0-9]{2}/[0-9]{4}$

Fecha de consulta (DD/MM/YYYY). Por defecto, hoy.

group_id
string^[0-9A-Za-z]{8}$

Filtrar por grupo

section_id
string^[0-9A-Za-z]{8}$

Filtrar por sección

level_id
string^[0-9A-Za-z]{8}$

Filtrar por grado

student_id
string^[0-9A-Za-z]{8}$

Filtrar por alumno

header Parameters
algebraix-api-token
required
string = 32 characters

ALGEBRAIX API KEY

Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
Default: false

La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema

NOTA: La instancia se crea desde web.

Responses
200

No error

400

Bad parameters

401

Authorization Required

get/syt/entries
Request samples
Response samples
application/json
[
  • {
    }
]

Registrar entrada

Registrar el arribo (registro de entradas) de uno o más alumnos en la puerta. Acepta student_id (un alumno) o student_ids (un arreglo de alumnos, p. ej. una caseta que escanea un grupo). La respuesta siempre es un arreglo results con un elemento por alumno solicitado.

Si el alumno ya tiene una entrada registrada hoy, no se crea un registro nuevo y el elemento correspondiente trae already_existed: true con el entry_id existente.

door_id y doorman_id son opcionales: si se omiten se almacena NULLNULL para door_id y el id de sesión del usuario de API para doorman_id.

Nota: este endpoint NO dispara notificaciones push de arribo (a diferencia de la pantalla /bin).

El acceso se limita a los grupos autorizados del usuario de API; si cualquier alumno solicitado queda fuera del alcance, la petición completa se rechaza con 403 y no se escribe nada.

Request
header Parameters
algebraix-api-token
required
string = 32 characters

ALGEBRAIX API KEY

Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
Default: false

La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema

NOTA: La instancia se crea desde web.

Request Body schema: application/json
required
student_id
string^[0-9A-Za-z]{8}$

Identificador del alumno (alternativo a student_ids)

student_ids
Array of strings

Arreglo de identificadores de alumnos (alternativo a student_id)

door_id
string^[0-9A-Za-z]{8}$

Identificador de la puerta. Opcional (por defecto NULLNULL).

doorman_id
string^[0-9A-Za-z]{8}$

Identificador del portero. Opcional (por defecto, el usuario de API).

notes
string

Notas

Responses
201

Entradas registradas

400

Bad parameters

401

Authorization Required

403

Fuera del alcance de grupos autorizados

post/syt/entries
Request samples
application/json
{
  • "student_id": "WADFERF3",
  • "door_id": "VZGDCTLU"
}
Response samples
application/json
{
  • "results": [
    ]
}

Eliminar entrada

Eliminar un registro de entrada erróneo (quitar entrada). El registro se elimina físicamente. El acceso se limita a los grupos autorizados del usuario de API.

Request
path Parameters
entry_id
required
string^[0-9A-Za-z]{8}$

Identificador único del registro de entrada

Example: AB12CD34
header Parameters
algebraix-api-token
required
string = 32 characters

ALGEBRAIX API KEY

Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
Default: false

La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema

NOTA: La instancia se crea desde web.

Responses
204

Entrada eliminada (sin contenido)

401

Authorization Required

403

Fuera del alcance de grupos autorizados

404

No encontrado

delete/syt/entries/{entry_id}
Request samples
Response samples
application/json
{
  • "details": [ ],
  • "message": "Invalid API session. Verify your algebraix-api-token."
}

Obtener registro de salidas

Obtener los eventos del registro de salidas (dismissal) de alumnos para un día, opcionalmente filtrado por grupo. Cada fila corresponde a un evento real del registro. El resultado se limita a los grupos autorizados del usuario de API.

Request
query Parameters
date
string^[0-9]{2}/[0-9]{2}/[0-9]{4}$

Fecha de consulta (DD/MM/YYYY). Por defecto, hoy.

group_id
string^[0-9A-Za-z]{8}$

Filtrar por grupo

header Parameters
algebraix-api-token
required
string = 32 characters

ALGEBRAIX API KEY

Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
Default: false

La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema

NOTA: La instancia se crea desde web.

Responses
200

No error

400

Bad parameters

401

Authorization Required

get/syt/exits
Request samples
Response samples
application/json
[
  • {
    }
]

Registrar / avanzar salida

Registrar o avanzar el evento de salida (registro de salidas) de un alumno. Crea un nuevo registro o avanza el estado de recogida de uno existente.

pickup_status admite ARRIVED (notificación), GOING (en camino) y CONFIRMED (adiós/entregado). La llamada es idempotente: si el registro ya tiene el estado solicitado, responde 200 con skipped: true sin cambios.

A diferencia de la pantalla /bin, este endpoint NO consulta el tablero de salidas ni dispara notificaciones push.

Si la configuración SYT_FORCE_PICKUP_USER está activa, un CONFIRMED sin pickup_user_id se rechaza con 422.

El acceso se limita a los grupos autorizados del usuario de API.

Request
header Parameters
algebraix-api-token
required
string = 32 characters

ALGEBRAIX API KEY

Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
Default: false

La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema

NOTA: La instancia se crea desde web.

Request Body schema: application/json
required
student_id
required
string^[0-9A-Za-z]{8}$

Identificador del alumno

pickup_status
required
string

Estado de la recogida

Enum: "ARRIVED" "GOING" "CONFIRMED"
pickup_user_id
string^[0-9A-Za-z]{8}$

Identificador del padre/contacto que recoge

door_id
string^[0-9A-Za-z]{8}$

Identificador de la puerta

notes
string

Notas

super_carpool_id
string^[0-9A-Za-z]{8}$

Identificador de la ronda (super carpool)

is_super_carpool
boolean

Marca el registro como parte de una ronda

Responses
200

Registro avanzado o sin cambios

201

Salida registrada

400

Bad parameters

401

Authorization Required

403

Fuera del alcance de grupos autorizados

422

pickup_user_id requerido para CONFIRMED

post/syt/exits
Request samples
application/json
{
  • "student_id": "WADFERF3",
  • "pickup_status": "ARRIVED"
}
Response samples
application/json
{
  • "exit_id": "AB12CD34",
  • "student_id": "WADFERF3",
  • "pickup_status": "GOING",
  • "skipped": false
}

Deshacer salida

Deshacer o retroceder la recogida de un alumno (quitar adiós). Según el estado y el usuario que avanzó el registro, el estado retrocede un nivel (200 con el nuevo pickup_status) o el registro se elimina por completo (204).

Request
path Parameters
exit_id
required
string^[0-9A-Za-z]{8}$

Identificador único del registro de salida

Example: AB12CD34
header Parameters
algebraix-api-token
required
string = 32 characters

ALGEBRAIX API KEY

Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
Default: false

La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema

NOTA: La instancia se crea desde web.

Responses
200

Estado retrocedido

204

Registro eliminado (sin contenido)

401

Authorization Required

403

Fuera del alcance de grupos autorizados

404

No encontrado / nada que deshacer

delete/syt/exits/{exit_id}
Request samples
Response samples
application/json
{
  • "exit_id": "AB12CD34",
  • "student_id": "WADFERF3",
  • "pickup_status": "GOING"
}

Obtener rutas de transporte

Obtener las rutas de transporte (bus lines) de la institución, con sus paradas, horario, operador, supervisor y chofer.

Request
query Parameters
include_inactive
boolean

Incluir rutas inactivas (true o false). Por defecto sólo activas.

header Parameters
algebraix-api-token
required
string = 32 characters

ALGEBRAIX API KEY

Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
Default: false

La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema

NOTA: La instancia se crea desde web.

Responses
200

No error

400

Bad parameters

401

Authorization Required

get/syt/bus_lines
Request samples
Response samples
application/json
[
  • {
    }
]

Obtener registro diario de rutas

Obtener la actividad diaria de las rutas (ascensos/descensos) para un día, opcionalmente filtrada por ruta o grupo. El resultado se limita a los grupos autorizados del usuario de API.

Request
query Parameters
date
string^[0-9]{2}/[0-9]{2}/[0-9]{4}$

Fecha de consulta (DD/MM/YYYY). Por defecto, hoy.

bus_line_id
string^[0-9A-Za-z]{8}$

Filtrar por ruta

group_id
string^[0-9A-Za-z]{8}$

Filtrar por grupo

header Parameters
algebraix-api-token
required
string = 32 characters

ALGEBRAIX API KEY

Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
Default: false

La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema

NOTA: La instancia se crea desde web.

Responses
200

No error

400

Bad parameters

401

Authorization Required

get/syt/bus_lines/registry
Request samples
Response samples
application/json
[
  • {
    }
]

Obtener rondas (carpools)

Obtener las rondas / carpools (super carpools) de la institución, con sus alumnos, horarios y choferes. Use carpool_id para una sola ronda.

Request
query Parameters
carpool_id
string^[0-9A-Za-z]{8}$

Obtener una sola ronda por identificador

header Parameters
algebraix-api-token
required
string = 32 characters

ALGEBRAIX API KEY

Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
Default: false

La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema

NOTA: La instancia se crea desde web.

Responses
200

No error

400

Bad parameters

401

Authorization Required

get/syt/carpools
Request samples
Response samples
application/json
[
  • {
    }
]

Obtener alumnos para recogida

Obtener los alumnos que un usuario (padre o chofer de rondín) puede recoger en la salida para una fecha (modo por defecto: requiere user_id y date), o una sugerencia de alumno por nombre dentro de un campus y sección (suggested=true: requiere name, campus_id, section_id). En el modo por defecto el resultado se limita a los grupos autorizados del usuario de API.

Request
query Parameters
suggested
boolean

Usar la variante de sugerencia (búsqueda por nombre) en lugar de la lista por usuario.

user_id
string^[0-9A-Za-z]{8}$

Usuario (padre o chofer) cuyos alumnos a recoger se listan. Requerido en el modo por defecto.

date
string^[0-9]{2}/[0-9]{2}/[0-9]{4}$

Fecha de consulta (DD/MM/YYYY). Requerida en el modo por defecto.

name
string

Nombre a buscar (modo sugerencia).

lastname
string

Apellido a buscar (modo sugerencia, opcional).

campus_id
string^[0-9A-Za-z]{8}$

Campus (modo sugerencia).

section_id
string^[0-9A-Za-z]{8}$

Sección (modo sugerencia).

header Parameters
algebraix-api-token
required
string = 32 characters

ALGEBRAIX API KEY

Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
Default: false

La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema

NOTA: La instancia se crea desde web.

Responses
200

No error

400

Bad parameters

401

Authorization Required

get/syt/pickups
Request samples
Response samples
application/json
[
  • {
    }
]