Algebraix logo
Powered by Redocly

General

Obtener estudiantes

Obtener información personal del estudiante para uso del campus

Request
query Parameters
limit
integer [ 1 .. 100 ]
Default: 100

Límite de estudiantes

page
integer >= 1
Default: 1

Número de página de consulta

is_active
boolean

Obtener estudiantes activos o inactivos (true o false)

is_graduated
boolean

Obtener estudiantes graduados (true o false)

group_id
Array of strings (id)

Filtrar por group_id.

Este filtro es de tipo array, la forma de usarlo es la siguiente:

/?group_id=EDFRET4G&group_id=WEDS23DV

username
string

Obtener estudiantes por nombre de usuario

lastname
string

Obtener estudiantes por apellido

student_number
string

Obtener estudiantes por matricula

curp
string

Obtener estudiantes por CURP

email
string

Obtener estudiantes por email

start_date
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...

Fecha inicial para búsqueda por fecha de modificación

Nota importante: Para poder usar de manera correcta la búsqueda, se deben enviar ambas fechas (start_date y end_date), esta búsqueda se basa en el rango de las dos fechas

end_date
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...

Fecha final para búsqueda por fecha de modificación

Nota importante: Para poder usar de manera correcta la búsqueda, se deben enviar ambas fechas (start_date y end_date), esta búsqueda se basa en el rango de las dos fechas

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/students
Request samples 
Response samples 
application/json
[
  • {
    }
]
Agregar estudiante
Agregar estudiante


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
group_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del grupo en el que se dará de alta el usuario


Puedes encontrar más información sobre cómo obtenerlo en la documentación de Grupos


 
tuition_amount
required
number (number) ^\d+(\.\d{1,2})?$
Monto de la colegiatura


 
name
required
string  [ 1 .. 64 ] characters 
Nombre del estudiante


 
lastname1
required
string  [ 1 .. 64 ] characters 
Apellido paterno


 
lastname2
string
Apellido Materno


 
password
string (password)   [ 8 .. 64 ] characters ^(?=.*[A-Z])(?=.*\d)[A-Za-z\d\W_]{8,64}$
Asigna una contraseña al estudiante


Si el campo no se incluye, el sistema lo generará automáticamente.


 
username
string (username)   [ 4 .. 32 ] characters ^\w*$
Nombre del usuario


Si el campo no se incluye, el sistema lo generará automáticamente.


 
student_number
integer  >= 1 
Matrícula del estudiante


Si el campo no se incluye, el sistema lo generará automáticamente.


 
curp
string (curp) ^$|^[A-Z][AEIOUX][A-Z]{2}[0-9]{2}[0-1][0-9][0...
CURP del estudiante


 
email
string (email) ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2...
Correo electrónico del estudiante


 
object
Cuenta de google


 
sex
required
string (sex) 
Sexo del estudiante


 Enum: "MALE" "FEMALE"  
has_own_supervision
boolean
Si tiene supervisión propia el alumno


 
is_enroll_student_in_group_classes
boolean
Inscribir al estudiante en las clases del grupo


 
is_enable_tuition
boolean
Cobro automático de colegiatura por cada periodo


Para permitir el procesamiento de cobros recurrentes deberá enviarse en 'true'   


 
is_disable_automatic_suspensions
boolean
Inhabilitar suspensiones automáticas


 
is_disable_latefees
boolean
Inhabilitar recargos


 
is_disable_discounts
boolean
Inhabilitar descuentos


 
allow_social_networking
boolean
Permitir acceso a redes sociales


 
has_syt_own_supervision
boolean
Supervisión propia en salidas y transportes


 
address_line_1
string
Dirección 1


 
address_line_2
string
Dirección 2


 
city
string
Ciudad


 
state
string (state) 
Estado


 Enum: "AGUASCALIENTES" "BAJA CALIFORNIA" "BAJA CALIFORNIA SUR" "CAMPECHE" "CIUDAD DE MEXICO" "CHIAPAS" "CHIHUAHUA" "COAHUILA" "COLIMA" "DURANGO" "GUANAJUATO" "GUERRERO" "HIDALGO" "JALISCO" "MEXICO" "MICHOACAN" "MORELOS" "NAYARIT" "NUEVO LEON" "OAXACA" "PUEBLA" "QUERETARO" "QUINTANA ROO" "SAN LUIS POTOSI" "SINALOA" "SONORA" "TABASCO" "TAMAULIPAS" "TLAXCALA" "VERACRUZ" "YUCATAN" "ZACATECAS"  
zipcode
integer
Código postal


 
telephone
string
Número de teléfono


 
object
Telefono celular


 
emergency_telephone
string
Número de teléfono en caso de emergencia


 
birthday
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...
Fecha de nacimiento


 
blood_type
string (blood_type) 
Tipo de sangre del estudiante


 Enum: "O+" "O-" "A+" "A-" "B+" "B-" "AB+" "AB-"  
allergies
string
Alergias del estudiante


 
additional_information
string
Información adicional


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


post/students
Request samples 
application/json
{
  • "group_id": "YVOD2QEF",
  • "tuition_amount": 2500,
  • "name": "Nombre1 Nombre2",
  • "lastname1": "Apellido1",
  • "lastname2": "Apellido1",
  • "password": "P@ssword-23",
  • "username": "LApellido1",
  • "student_number": 123456,
  • "curp": "GOVM860812MJCNLR05",
  • "email": "algebraix@example.com",
  • "sex": "MALE",
  • "has_own_supervision": true,
  • "address_line_1": "Cerrada Norte Pelayo 897 Interior 060",
  • "city": "hermosillo",
  • "state": "SONORA",
  • "zipcode": 83280,
  • "telephone": "6622436745",
  • "mobile": {
    },
  • "birthday": "02/07/1994",
  • "blood_type": "O+"
}
Response samples 
application/json
{
  • "details": [ ],
  • "id": "AWDSFER4",
  • "message": "Student added under registration number"
}
Obtener estudiantes por ID
Obtener información personal del estudiante para uso del campus


Request 
path Parameters
student_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del estudiante


 
 Example:  WADFERF3
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/students/{student_id}
Request samples 
Response samples 
application/json
{
  • "id": "ADFEGT56",
  • "is_active": true,
  • "username": "JLUIS01",
  • "student_number": 100473,
  • "name": "JOSE LUIS",
  • "lastname": "RUIZ SOTO",
  • "lastname1": "RUIZ",
  • "lastname2": "SOTO",
  • "family_id": "RQ7WNT4L",
  • "group": {
    },
  • "level": {
    },
  • "curp": "RUSJA860313MSRCNL09",
  • "has_picture": true,
  • "has_profile_picture": false,
  • "is_graduated": false,
  • "email": "jluis@gmail.com",
  • "google_account": {
    },
  • "use_authenticator": false,
  • "birthday": "10/07/2000",
  • "age": "23",
  • "sex": "MALE",
  • "address_line_1": "camino a san pablo 34",
  • "address_line_2": "",
  • "city": "xochimilco",
  • "state": "ciudad de mexico",
  • "zipcode": "16200",
  • "telephone": "5565216431",
  • "mobile_telephone": "+52555525352",
  • "emergency_telephone": "5555233974",
  • "additional_information": "",
  • "has_own_supervision": true,
  • "has_disable_online_payments": false,
  • "has_enable_tuition": false,
  • "has_disable_automatic_suspensions": false,
  • "has_disable_latefees": false,
  • "has_disable_discounts": false,
  • "has_access_social_networking": false,
  • "has_syt_own_supervision": false,
  • "blood_type": "O+",
  • "allergies": "ninguna",
  • "language_preference": "ES",
  • "create_date_time": "2023-12-12 14:43:51",
  • "last_modification_time": "2023-12-12 14:43:51"
}
Actualizar estudiante
Actualizar datos personales del estudiante


Request 
path Parameters
student_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del estudiante


 
 Example:  WADFERF3
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
group_id
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del grupo en el que se dará de alta el usuario


 
name
string  [ 1 .. 64 ] characters 
Nombre del estudiante


 
lastname1
string  [ 1 .. 64 ] characters 
Apellido paterno


 
lastname2
string
Apellido Materno


 
password
string (password)   [ 8 .. 64 ] characters ^(?=.*[A-Z])(?=.*\d)[A-Za-z\d\W_]{8,64}$
Asigna una contraseña al estudiante


 
username
string (username)   [ 4 .. 32 ] characters ^\w*$
Nombre del usuario


 
student_number
integer  >= 1 
Matrícula del estudiante


 
curp
string (curp) ^$|^[A-Z][AEIOUX][A-Z]{2}[0-9]{2}[0-1][0-9][0...
CURP del estudiante


 
email
string (email) ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2...
Correo electrónico del estudiante


 
object
Cuenta de google


 
sex
string (sex) 
Sexo del estudiante


 Enum: "MALE" "FEMALE"  
has_own_supervision
boolean
Si tiene supervisión propia el alumno


 
is_disable_online_payments
boolean
Inhabilitar pagos en línea


 
is_enable_tuition
boolean
Cobro automático de colegiatura cada periodo


 
is_disable_automatic_suspensions
boolean
Inhabilitar suspensiones automáticas


 
is_disable_latefees
boolean
Inhabilitar recargos


 
is_disable_discounts
boolean
Inhabilitar descuentos


 
allow_social_networking
boolean
Permitir acceso a redes sociales


 
has_syt_own_supervision
boolean
Supervisión propia en salidas y transportes


 
address_line_1
string
Dirección 1


 
address_line_2
string
Dirección 2


 
city
string
Ciudad


 
state
string (state) 
Estado


 Enum: "AGUASCALIENTES" "BAJA CALIFORNIA" "BAJA CALIFORNIA SUR" "CAMPECHE" "CIUDAD DE MEXICO" "CHIAPAS" "CHIHUAHUA" "COAHUILA" "COLIMA" "DURANGO" "GUANAJUATO" "GUERRERO" "HIDALGO" "JALISCO" "MEXICO" "MICHOACAN" "MORELOS" "NAYARIT" "NUEVO LEON" "OAXACA" "PUEBLA" "QUERETARO" "QUINTANA ROO" "SAN LUIS POTOSI" "SINALOA" "SONORA" "TABASCO" "TAMAULIPAS" "TLAXCALA" "VERACRUZ" "YUCATAN" "ZACATECAS"  
zipcode
integer
Código postal


 
telephone
string
Número de teléfono


 
object
Telefono celular


 
emergency_telephone
string
Número de teléfono en caso de emergencia


 
birthday
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...
Fecha de nacimiento


 
blood_type
string (blood_type) 
Tipo de sangre del estudiante


 Enum: "O+" "O-" "A+" "A-" "B+" "B-" "AB+" "AB-"  
allergies
string
Alergias del estudiante


 
additional_information
string
Información adicional


 
is_update_bank_codes
boolean
Actualizar referencias bancarias, solo si actualizas la matrícula (student_number)


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


patch/students/{student_id}
Request samples 
application/json
{
  • "group_id": "YVOD2QEF",
  • "name": "Nombre1 Nombre2",
  • "lastname1": "Apellido1",
  • "lastname2": "Apellido1",
  • "password": "P@ssword-23",
  • "username": "LApellido1",
  • "student_number": 123456,
  • "curp": "GOVM860812MJCNLR05",
  • "email": "algebraix@example.com",
  • "sex": "MALE",
  • "has_own_supervision": true,
  • "address_line_1": "Cerrada Norte Pelayo 897 Interior 060",
  • "city": "hermosillo",
  • "state": "SONORA",
  • "zipcode": 83280,
  • "telephone": "6622436745",
  • "mobile": {
    },
  • "birthday": "02/07/1994",
  • "blood_type": "O+"
}
Response samples 
application/json
{
  • "details": [ ],
  • "message": "Updated student data."
}
Eliminar estudiante
¡Este proceso es irreversible!


Este proceso irreversible causará la eliminación de horarios, calificaciones, relaciones con padres de familia, asistencia, etc.


Debe tener en cuenta que:


    

  1. Se eliminarán TODOS los datos del estudiante. Calificaciones, facturas, pagos, recibos, etc.
    2. 

  2. Este proceso es irreversible
    3. 

  3. En caso de requerir la restauración de esta información, se requiere de la ayuda personalizada del equipo técnico de Algebraix lo cual tendrá un costo adicional.
    4. 



Request 
path Parameters
student_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del estudiante


 
 Example:  WADFERF3
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


delete/students/{student_id}
Request samples 
Response samples 
application/json
{
  • "details": [ ],
  • "message": "Student eliminated"
}
Obtener fotografía de control escolar
Obtener información de la fotografía de control escolar


Request 
path Parameters
student_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del estudiante


 
 Example:  DFER45EW
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/students/{student_id}/pictures
Request samples 
Response samples 
application/json
{}
Obtener fotografía de perfil
Obtener información de la fotografía de perfil


Request 
path Parameters
student_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del estudiante


 
 Example:  DFER45EW
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/students/{student_id}/pictures/profile
Request samples 
Response samples 
application/json
{}
➔ Next to Datos adicionales